AWS API Changes

2022/06/28 - Amazon Elastic Compute Cloud - 2 updated api methods

Changes This release adds a new spread placement group to EC2 Placement Groups: host level spread, which spread instances between physical hosts, available to Outpost customers only. CreatePlacementGroup and DescribePlacementGroups APIs were updated with a new parameter: SpreadLevel to support this feature.

CreatePlacementGroup (updated)

Link ¶
Changes (request, response)
Request

{'SpreadLevel': 'host | rack'}

Response

{'PlacementGroup': {'SpreadLevel': 'host | rack'}}

Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.

A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.

For more information, see Placement groups in the Amazon EC2 User Guide .

See also: AWS API Documentation

Request Syntax

client.create_placement_group(
    DryRun=True|False,
    GroupName='string',
    Strategy='cluster'|'spread'|'partition',
    PartitionCount=123,
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-service'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    SpreadLevel='host'|'rack'
)

type DryRun

boolean

param DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

type GroupName

string

param GroupName

A name for the placement group. Must be unique within the scope of your account for the Region.

Constraints: Up to 255 ASCII characters

type Strategy

string

param Strategy

The placement strategy.

type PartitionCount

integer

param PartitionCount

The number of partitions. Valid only when Strategy is set to partition .

type TagSpecifications

list

param TagSpecifications

The tags to apply to the new placement group.

(dict) --

The tags to apply to a resource when the resource is being created.
- ResourceType (string) --
  
  The type of resource to tag on creation.
- Tags (list) --
  
  The tags to apply to the resource.
  - (dict) --
    
    Describes a tag.
    - Key (string) --
      
      The key of the tag.
      
      Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
    - Value (string) --
      
      The value of the tag.
      
      Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

type SpreadLevel

string

param SpreadLevel

Determines how placement groups spread instances.

Host – You can use host only with Outpost placement groups.
Rack – No usage restrictions.

rtype

dict

returns

Response Syntax

{
    'PlacementGroup': {
        'GroupName': 'string',
        'State': 'pending'|'available'|'deleting'|'deleted',
        'Strategy': 'cluster'|'spread'|'partition',
        'PartitionCount': 123,
        'GroupId': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'GroupArn': 'string',
        'SpreadLevel': 'host'|'rack'
    }
}

Response Structure

(dict) --
- PlacementGroup (dict) --
  
  Describes a placement group.
  - GroupName (string) --
    
    The name of the placement group.
  - State (string) --
    
    The state of the placement group.
  - Strategy (string) --
    
    The placement strategy.
  - PartitionCount (integer) --
    
    The number of partitions. Valid only if strategy is set to partition .
  - GroupId (string) --
    
    The ID of the placement group.
  - Tags (list) --
    
    Any tags applied to the placement group.
    - (dict) --
      
      Describes a tag.
      - Key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
      - Value (string) --
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
  - GroupArn (string) --
    
    The Amazon Resource Name (ARN) of the placement group.
  - SpreadLevel (string) --
    
    The spread level for the placement group. Only Outpost placement groups can be spread across hosts.

DescribePlacementGroups (updated)

Link ¶
Changes (response)

{'PlacementGroups': {'SpreadLevel': 'host | rack'}}

Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide .

See also: AWS API Documentation

Request Syntax

client.describe_placement_groups(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False,
    GroupNames=[
        'string',
    ],
    GroupIds=[
        'string',
    ]
)

type Filters

list

param Filters

The filters.

group-name - The name of the placement group.
group-arn - The Amazon Resource Name (ARN) of the placement group.
spread-level - The spread level for the placement group (host | rack ).
state - The state of the placement group (pending | available | deleting | deleted ).
strategy - The strategy of the placement group (cluster | spread | partition ).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

If you specify multiple filters, the filters are joined with an AND , and the request returns only results that match all of the specified filters.
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR , and the request returns all results that match any of the specified values.
  - (string) --

type DryRun

boolean

param DryRun

type GroupNames

list

param GroupNames

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

(string) --

type GroupIds

list

param GroupIds

The IDs of the placement groups.

(string) --

rtype

dict

returns

Response Syntax

{
    'PlacementGroups': [
        {
            'GroupName': 'string',
            'State': 'pending'|'available'|'deleting'|'deleted',
            'Strategy': 'cluster'|'spread'|'partition',
            'PartitionCount': 123,
            'GroupId': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'GroupArn': 'string',
            'SpreadLevel': 'host'|'rack'
        },
    ]
}

Response Structure

(dict) --
- PlacementGroups (list) --
  
  Information about the placement groups.
  - (dict) --
    
    Describes a placement group.
    - GroupName (string) --
      
      The name of the placement group.
    - State (string) --
      
      The state of the placement group.
    - Strategy (string) --
      
      The placement strategy.
    - PartitionCount (integer) --
      
      The number of partitions. Valid only if strategy is set to partition .
    - GroupId (string) --
      
      The ID of the placement group.
    - Tags (list) --
      
      Any tags applied to the placement group.
      - (dict) --
        
        Describes a tag.
        
        Key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws: .
        
        Value (string) --
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
    - GroupArn (string) --
      
      The Amazon Resource Name (ARN) of the placement group.
    - SpreadLevel (string) --
      
      The spread level for the placement group. Only Outpost placement groups can be spread across hosts.