AWS API Changes

2017/11/29 - Amazon Elastic Compute Cloud - 21 new 13 updated api methods

Changes Adds the following updates: 1. You are now able to host a service powered by AWS PrivateLink to provide private connectivity to other VPCs. You are now also able to create endpoints to other services powered by PrivateLink including AWS services, Marketplace Seller services or custom services created by yourself or other AWS VPC customers. 2. You are now able to save launch parameters in a single template that can be used with Auto Scaling, Spot Fleet, Spot, and On Demand instances. 3. You are now able to launch Spot instances via the RunInstances API, using a single additional parameter. RunInstances will response synchronously with an instance ID should capacity be available for your Spot request. 4. A simplified Spot pricing model which delivers low, predictable prices that adjust gradually, based on long-term trends in supply and demand. 5. Amazon EC2 Spot can now hibernate Amazon EBS-backed instances in the event of an interruption, so your workloads pick up from where they left off. Spot can fulfill your request by resuming instances from a hibernated state when capacity is available.

CreateVpcEndpointServiceConfiguration (new)

Link ¶

Creates a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles) can connect. Service consumers can create an interface VPC endpoint to connect to your service.

To create an endpoint service configuration, you must first create a Network Load Balancer for your service. For more information, see VPC Endpoint Services in the Amazon Virtual Private Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.create_vpc_endpoint_service_configuration(
    DryRun=True|False,
    AcceptanceRequired=True|False,
    NetworkLoadBalancerArns=[
        'string',
    ],
    ClientToken='string'
)

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 AcceptanceRequired

boolean

param AcceptanceRequired

Indicate whether requests from service consumers to create an endpoint to your service must be accepted. To accept a request, use AcceptVpcEndpointConnections.

type NetworkLoadBalancerArns

list

param NetworkLoadBalancerArns

[REQUIRED]

The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.

(string) --

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

rtype

dict

returns

Response Syntax

{
    'ServiceConfiguration': {
        'ServiceType': [
            {
                'ServiceType': 'Interface'|'Gateway'
            },
        ],
        'ServiceId': 'string',
        'ServiceName': 'string',
        'ServiceState': 'Pending'|'Available'|'Deleting'|'Deleted'|'Failed',
        'AvailabilityZones': [
            'string',
        ],
        'AcceptanceRequired': True|False,
        'NetworkLoadBalancerArns': [
            'string',
        ],
        'BaseEndpointDnsNames': [
            'string',
        ],
        'PrivateDnsName': 'string'
    },
    'ClientToken': 'string'
}

Response Structure

(dict) --
- ServiceConfiguration (dict) --
  
  Information about the service configuration.
  - ServiceType (list) --
    
    The type of service.
    - (dict) --
      
      Describes the type of service for a VPC endpoint.
      - ServiceType (string) --
        
        The type of service.
  - ServiceId (string) --
    
    The ID of the service.
  - ServiceName (string) --
    
    The name of the service.
  - ServiceState (string) --
    
    The service state.
  - AvailabilityZones (list) --
    
    In the Availability Zones in which the service is available.
    - (string) --
  - AcceptanceRequired (boolean) --
    
    Indicates whether requests from other AWS accounts to create an endpoint to the service must first be accepted.
  - NetworkLoadBalancerArns (list) --
    
    The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.
    - (string) --
  - BaseEndpointDnsNames (list) --
    
    The DNS names for the service.
    - (string) --
  - PrivateDnsName (string) --
    
    The private DNS name for the service.
- ClientToken (string) --
  
  Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

GetLaunchTemplateData (new)

Link ¶

Retrieves the configuration data of the specified instance. You can use this data to create a launch template.

See also: AWS API Documentation

Request Syntax

client.get_launch_template_data(
    DryRun=True|False,
    InstanceId='string'
)

type DryRun

boolean

param DryRun

type InstanceId

string

param InstanceId

[REQUIRED]

The ID of the instance.

rtype

dict

returns

Response Syntax

{
    'LaunchTemplateData': {
        'KernelId': 'string',
        'EbsOptimized': True|False,
        'IamInstanceProfile': {
            'Arn': 'string',
            'Name': 'string'
        },
        'BlockDeviceMappings': [
            {
                'DeviceName': 'string',
                'VirtualName': 'string',
                'Ebs': {
                    'Encrypted': True|False,
                    'DeleteOnTermination': True|False,
                    'Iops': 123,
                    'KmsKeyId': 'string',
                    'SnapshotId': 'string',
                    'VolumeSize': 123,
                    'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
                },
                'NoDevice': 'string'
            },
        ],
        'NetworkInterfaces': [
            {
                'AssociatePublicIpAddress': True|False,
                'DeleteOnTermination': True|False,
                'Description': 'string',
                'DeviceIndex': 123,
                'Groups': [
                    'string',
                ],
                'Ipv6AddressCount': 123,
                'Ipv6Addresses': [
                    {
                        'Ipv6Address': 'string'
                    },
                ],
                'NetworkInterfaceId': 'string',
                'PrivateIpAddress': 'string',
                'PrivateIpAddresses': [
                    {
                        'Primary': True|False,
                        'PrivateIpAddress': 'string'
                    },
                ],
                'SecondaryPrivateIpAddressCount': 123,
                'SubnetId': 'string'
            },
        ],
        'ImageId': 'string',
        'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge',
        'KeyName': 'string',
        'Monitoring': {
            'Enabled': True|False
        },
        'Placement': {
            'AvailabilityZone': 'string',
            'Affinity': 'string',
            'GroupName': 'string',
            'HostId': 'string',
            'Tenancy': 'default'|'dedicated'|'host',
            'SpreadDomain': 'string'
        },
        'RamDiskId': 'string',
        'DisableApiTermination': True|False,
        'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
        'UserData': 'string',
        'TagSpecifications': [
            {
                'ResourceType': 'customer-gateway'|'dhcp-options'|'image'|'instance'|'internet-gateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'snapshot'|'spot-instances-request'|'subnet'|'security-group'|'volume'|'vpc'|'vpn-connection'|'vpn-gateway',
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            },
        ],
        'ElasticGpuSpecifications': [
            {
                'Type': 'string'
            },
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'SecurityGroups': [
            'string',
        ],
        'InstanceMarketOptions': {
            'MarketType': 'spot',
            'SpotOptions': {
                'MaxPrice': 'string',
                'SpotInstanceType': 'one-time'|'persistent',
                'BlockDurationMinutes': 123,
                'ValidUntil': datetime(2015, 1, 1),
                'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
            }
        },
        'CreditSpecification': {
            'CpuCredits': 'string'
        }
    }
}

Response Structure

(dict) --
- LaunchTemplateData (dict) --
  
  The instance data.
  - KernelId (string) --
    
    The ID of the kernel, if applicable.
  - EbsOptimized (boolean) --
    
    Indicates whether the instance is optimized for Amazon EBS I/O.
  - IamInstanceProfile (dict) --
    
    The IAM instance profile.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the instance profile.
    - Name (string) --
      
      The name of the instance profile.
  - BlockDeviceMappings (list) --
    
    The block device mappings.
    - (dict) --
      
      Describes a block device mapping.
      - DeviceName (string) --
        
        The device name.
      - VirtualName (string) --
        
        The virtual device name (ephemeralN).
      - Ebs (dict) --
        
        Information about the block device for an EBS volume.
        
        Encrypted (boolean) --
        
        Indicates whether the EBS volume is encrypted.
        
        DeleteOnTermination (boolean) --
        
        Indicates whether the EBS volume is deleted on instance termination.
        
        Iops (integer) --
        
        The number of I/O operations per second (IOPS) that the volume supports.
        
        KmsKeyId (string) --
        
        The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
        
        SnapshotId (string) --
        
        The ID of the snapshot.
        
        VolumeSize (integer) --
        
        The size of the volume, in GiB.
        
        VolumeType (string) --
        
        The volume type.
      - NoDevice (string) --
        
        Suppresses the specified device included in the block device mapping of the AMI.
  - NetworkInterfaces (list) --
    
    The network interfaces.
    - (dict) --
      
      Describes a network interface.
      - AssociatePublicIpAddress (boolean) --
        
        Indicates whether to associate a public IPv4 address with eth0 for a new network interface.
      - DeleteOnTermination (boolean) --
        
        Indicates whether the network interface is deleted when the instance is terminated.
      - Description (string) --
        
        A description for the network interface.
      - DeviceIndex (integer) --
        
        The device index for the network interface attachment.
      - Groups (list) --
        
        The IDs of one or more security groups.
        
        (string) --
      - Ipv6AddressCount (integer) --
        
        The number of IPv6 addresses for the network interface.
      - Ipv6Addresses (list) --
        
        The IPv6 addresses for the network interface.
        
        (dict) --
        
        Describes an IPv6 address.
        
        Ipv6Address (string) --
        
        The IPv6 address.
      - NetworkInterfaceId (string) --
        
        The ID of the network interface.
      - PrivateIpAddress (string) --
        
        The primary private IPv4 address of the network interface.
      - PrivateIpAddresses (list) --
        
        One or more private IPv4 addresses.
        
        (dict) --
        
        Describes a secondary private IPv4 address for a network interface.
        
        Primary (boolean) --
        
        Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
        
        PrivateIpAddress (string) --
        
        The private IPv4 addresses.
      - SecondaryPrivateIpAddressCount (integer) --
        
        The number of secondary private IPv4 addresses for the network interface.
      - SubnetId (string) --
        
        The ID of the subnet for the network interface.
  - ImageId (string) --
    
    The ID of the AMI that was used to launch the instance.
  - InstanceType (string) --
    
    The instance type.
  - KeyName (string) --
    
    The name of the key pair.
  - Monitoring (dict) --
    
    The monitoring for the instance.
    - Enabled (boolean) --
      
      Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
  - Placement (dict) --
    
    The placement of the instance.
    - AvailabilityZone (string) --
      
      The Availability Zone of the instance.
    - Affinity (string) --
      
      The affinity setting for the instance on the Dedicated Host.
    - GroupName (string) --
      
      The name of the placement group for the instance.
    - HostId (string) --
      
      The ID of the Dedicated Host for the instance.
    - Tenancy (string) --
      
      The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
    - SpreadDomain (string) --
      
      Reserved for future use.
  - RamDiskId (string) --
    
    The ID of the RAM disk, if applicable.
  - DisableApiTermination (boolean) --
    
    If set to true , indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.
  - InstanceInitiatedShutdownBehavior (string) --
    
    Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
  - UserData (string) --
    
    The user data for the instance.
  - TagSpecifications (list) --
    
    The tags.
    - (dict) --
      
      The tag specification for the launch template.
      - ResourceType (string) --
        
        The type of resource.
      - Tags (list) --
        
        The tags for 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 255 Unicode characters.
  - ElasticGpuSpecifications (list) --
    
    The elastic GPU specification.
    - (dict) --
      
      Describes an elastic GPU.
      - Type (string) --
        
        The elastic GPU type.
  - SecurityGroupIds (list) --
    
    The security group IDs.
    - (string) --
  - SecurityGroups (list) --
    
    The security group names.
    - (string) --
  - InstanceMarketOptions (dict) --
    
    The market (purchasing) option for the instances.
    - MarketType (string) --
      
      The market type.
    - SpotOptions (dict) --
      
      The options for Spot Instances.
      - MaxPrice (string) --
        
        The maximum hourly price you're willing to pay for the Spot Instances.
      - SpotInstanceType (string) --
        
        The Spot Instance request type.
      - BlockDurationMinutes (integer) --
        
        The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
      - ValidUntil (datetime) --
        
        The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
      - InstanceInterruptionBehavior (string) --
        
        The behavior when a Spot Instance is interrupted.
  - CreditSpecification (dict) --
    
    The credit option for CPU usage of the instance.
    - CpuCredits (string) --
      
      The credit option for CPU usage of a T2 instance.

ModifyVpcEndpointServiceConfiguration (new)

Link ¶

Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.

See also: AWS API Documentation

Request Syntax

client.modify_vpc_endpoint_service_configuration(
    DryRun=True|False,
    ServiceId='string',
    AcceptanceRequired=True|False,
    AddNetworkLoadBalancerArns=[
        'string',
    ],
    RemoveNetworkLoadBalancerArns=[
        'string',
    ]
)

type DryRun

boolean

param DryRun

type ServiceId

string

param ServiceId

[REQUIRED]

The ID of the service.

type AcceptanceRequired

boolean

param AcceptanceRequired

Indicate whether requests to create an endpoint to your service must be accepted.

type AddNetworkLoadBalancerArns

list

param AddNetworkLoadBalancerArns

The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.

(string) --

type RemoveNetworkLoadBalancerArns

list

param RemoveNetworkLoadBalancerArns

The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.

(string) --

rtype

dict

returns

Response Syntax

{
    'Return': True|False
}

Response Structure

(dict) --
- Return (boolean) --
  
  Returns true if the request succeeds; otherwise, it returns an error.

DescribeVpcEndpointServiceConfigurations (new)

Link ¶

Describes the VPC endpoint service configurations in your account (your services).

See also: AWS API Documentation

Request Syntax

client.describe_vpc_endpoint_service_configurations(
    DryRun=True|False,
    ServiceIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type DryRun

boolean

param DryRun

type ServiceIds

list

param ServiceIds

The IDs of one or more services.

(string) --

type Filters

list

param Filters

One or more filters.

service-name - The ARN of the service.
vpc-endpoint-service-id - The ID of the service.
vpc-endpoint-service-state - The state of the service ( Pending | Available | Deleting | Deleted | Failed ).

(dict) --

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.

type NextToken

string

param NextToken

The token to retrieve the next page of results.

rtype

dict

returns

Response Syntax

{
    'ServiceConfigurations': [
        {
            'ServiceType': [
                {
                    'ServiceType': 'Interface'|'Gateway'
                },
            ],
            'ServiceId': 'string',
            'ServiceName': 'string',
            'ServiceState': 'Pending'|'Available'|'Deleting'|'Deleted'|'Failed',
            'AvailabilityZones': [
                'string',
            ],
            'AcceptanceRequired': True|False,
            'NetworkLoadBalancerArns': [
                'string',
            ],
            'BaseEndpointDnsNames': [
                'string',
            ],
            'PrivateDnsName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ServiceConfigurations (list) --
  
  Information about one or more services.
  - (dict) --
    
    Describes a service configuration for a VPC endpoint service.
    - ServiceType (list) --
      
      The type of service.
      - (dict) --
        
        Describes the type of service for a VPC endpoint.
        
        ServiceType (string) --
        
        The type of service.
    - ServiceId (string) --
      
      The ID of the service.
    - ServiceName (string) --
      
      The name of the service.
    - ServiceState (string) --
      
      The service state.
    - AvailabilityZones (list) --
      
      In the Availability Zones in which the service is available.
      - (string) --
    - AcceptanceRequired (boolean) --
      
      Indicates whether requests from other AWS accounts to create an endpoint to the service must first be accepted.
    - NetworkLoadBalancerArns (list) --
      
      The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.
      - (string) --
    - BaseEndpointDnsNames (list) --
      
      The DNS names for the service.
      - (string) --
    - PrivateDnsName (string) --
      
      The private DNS name for the service.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeVpcEndpointConnectionNotifications (new)

Link ¶

Describes the connection notifications for VPC endpoints and VPC endpoint services.

See also: AWS API Documentation

Request Syntax

client.describe_vpc_endpoint_connection_notifications(
    DryRun=True|False,
    ConnectionNotificationId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type DryRun

boolean

param DryRun

type ConnectionNotificationId

string

param ConnectionNotificationId

The ID of the notification.

type Filters

list

param Filters

One or more filters.

connection-notification-arn - The ARN of SNS topic for the notification.
connection-notification-id - The ID of the notification.
connection-notification-state - The state of the notification ( Enabled | Disabled ).
connection-notification-type - The type of notification ( Topic ).
service-id - The ID of the endpoint service.
vpc-endpoint-id - The ID of the VPC endpoint.

(dict) --

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value.

type NextToken

string

param NextToken

The token to request the next page of results.

rtype

dict

returns

Response Syntax

{
    'ConnectionNotificationSet': [
        {
            'ConnectionNotificationId': 'string',
            'ServiceId': 'string',
            'VpcEndpointId': 'string',
            'ConnectionNotificationType': 'Topic',
            'ConnectionNotificationArn': 'string',
            'ConnectionEvents': [
                'string',
            ],
            'ConnectionNotificationState': 'Enabled'|'Disabled'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- ConnectionNotificationSet (list) --
  
  One or more notifications.
  - (dict) --
    
    Describes a connection notification for a VPC endpoint or VPC endpoint service.
    - ConnectionNotificationId (string) --
      
      The ID of the notification.
    - ServiceId (string) --
      
      The ID of the endpoint service.
    - VpcEndpointId (string) --
      
      The ID of the VPC endpoint.
    - ConnectionNotificationType (string) --
      
      The type of notification.
    - ConnectionNotificationArn (string) --
      
      The ARN of the SNS topic for the notification.
    - ConnectionEvents (list) --
      
      The events for the notification. Valid values are Accept , Connect , Delete , and Reject .
      - (string) --
    - ConnectionNotificationState (string) --
      
      The state of the notification.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

CreateLaunchTemplateVersion (new)

Link ¶

Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.

Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.

See also: AWS API Documentation

Request Syntax

client.create_launch_template_version(
    DryRun=True|False,
    ClientToken='string',
    LaunchTemplateId='string',
    LaunchTemplateName='string',
    SourceVersion='string',
    VersionDescription='string',
    LaunchTemplateData={
        'KernelId': 'string',
        'EbsOptimized': True|False,
        'IamInstanceProfile': {
            'Arn': 'string',
            'Name': 'string'
        },
        'BlockDeviceMappings': [
            {
                'DeviceName': 'string',
                'VirtualName': 'string',
                'Ebs': {
                    'Encrypted': True|False,
                    'DeleteOnTermination': True|False,
                    'Iops': 123,
                    'KmsKeyId': 'string',
                    'SnapshotId': 'string',
                    'VolumeSize': 123,
                    'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
                },
                'NoDevice': 'string'
            },
        ],
        'NetworkInterfaces': [
            {
                'AssociatePublicIpAddress': True|False,
                'DeleteOnTermination': True|False,
                'Description': 'string',
                'DeviceIndex': 123,
                'Groups': [
                    'string',
                ],
                'Ipv6AddressCount': 123,
                'Ipv6Addresses': [
                    {
                        'Ipv6Address': 'string'
                    },
                ],
                'NetworkInterfaceId': 'string',
                'PrivateIpAddress': 'string',
                'PrivateIpAddresses': [
                    {
                        'Primary': True|False,
                        'PrivateIpAddress': 'string'
                    },
                ],
                'SecondaryPrivateIpAddressCount': 123,
                'SubnetId': 'string'
            },
        ],
        'ImageId': 'string',
        'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge',
        'KeyName': 'string',
        'Monitoring': {
            'Enabled': True|False
        },
        'Placement': {
            'AvailabilityZone': 'string',
            'Affinity': 'string',
            'GroupName': 'string',
            'HostId': 'string',
            'Tenancy': 'default'|'dedicated'|'host',
            'SpreadDomain': 'string'
        },
        'RamDiskId': 'string',
        'DisableApiTermination': True|False,
        'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
        'UserData': 'string',
        'TagSpecifications': [
            {
                'ResourceType': 'customer-gateway'|'dhcp-options'|'image'|'instance'|'internet-gateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'snapshot'|'spot-instances-request'|'subnet'|'security-group'|'volume'|'vpc'|'vpn-connection'|'vpn-gateway',
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            },
        ],
        'ElasticGpuSpecifications': [
            {
                'Type': 'string'
            },
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'SecurityGroups': [
            'string',
        ],
        'InstanceMarketOptions': {
            'MarketType': 'spot',
            'SpotOptions': {
                'MaxPrice': 'string',
                'SpotInstanceType': 'one-time'|'persistent',
                'BlockDurationMinutes': 123,
                'ValidUntil': datetime(2015, 1, 1),
                'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
            }
        },
        'CreditSpecification': {
            'CpuCredits': 'string'
        }
    }
)

type DryRun

boolean

param DryRun

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

type LaunchTemplateId

string

param LaunchTemplateId

The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

type LaunchTemplateName

string

param LaunchTemplateName

The name of the launch template. You must specify either the launch template ID or launch template name in the request.

type SourceVersion

string

param SourceVersion

The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify in LaunchTemplateData.

type VersionDescription

string

param VersionDescription

A description for the version of the launch template.

type LaunchTemplateData

dict

param LaunchTemplateData

[REQUIRED]

The information for the launch template.

KernelId (string) --

The ID of the kernel.

Warning

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide .
EbsOptimized (boolean) --

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
IamInstanceProfile (dict) --

The IAM instance profile.
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the instance profile.
- Name (string) --
  
  The name of the instance profile.
BlockDeviceMappings (list) --

The block device mapping.

Warning

Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.
- (dict) --
  
  Describes a block device mapping.
  - DeviceName (string) --
    
    The device name (for example, /dev/sdh or xvdh).
  - VirtualName (string) --
    
    The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
  - Ebs (dict) --
    
    Parameters used to automatically set up EBS volumes when the instance is launched.
    - Encrypted (boolean) --
      
      Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.
    - DeleteOnTermination (boolean) --
      
      Indicates whether the EBS volume is deleted on instance termination.
    - Iops (integer) --
      
      The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
      
      Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.
    - KmsKeyId (string) --
      
      The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
    - SnapshotId (string) --
      
      The ID of the snapshot.
    - VolumeSize (integer) --
      
      The size of the volume, in GiB.
      
      Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
    - VolumeType (string) --
      
      The volume type.
  - NoDevice (string) --
    
    Suppresses the specified device included in the block device mapping of the AMI.
NetworkInterfaces (list) --

One or more network interfaces.
- (dict) --
  
  The parameters for a network interface.
  - AssociatePublicIpAddress (boolean) --
    
    Associates a public IPv4 address with eth0 for a new network interface.
  - DeleteOnTermination (boolean) --
    
    Indicates whether the network interface is deleted when the instance is terminated.
  - Description (string) --
    
    A description for the network interface.
  - DeviceIndex (integer) --
    
    The device index for the network interface attachment.
  - Groups (list) --
    
    The IDs of one or more security groups.
    - (string) --
  - Ipv6AddressCount (integer) --
    
    The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
  - Ipv6Addresses (list) --
    
    One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
    - (dict) --
      
      Describes an IPv6 address.
      - Ipv6Address (string) --
        
        The IPv6 address.
  - NetworkInterfaceId (string) --
    
    The ID of the network interface.
  - PrivateIpAddress (string) --
    
    The primary private IPv4 address of the network interface.
  - PrivateIpAddresses (list) --
    
    One or more private IPv4 addresses.
    - (dict) --
      
      Describes a secondary private IPv4 address for a network interface.
      - Primary (boolean) --
        
        Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
      - PrivateIpAddress (string) -- [REQUIRED]
        
        The private IPv4 addresses.
  - SecondaryPrivateIpAddressCount (integer) --
    
    The number of secondary private IPv4 addresses to assign to a network interface.
  - SubnetId (string) --
    
    The ID of the subnet for the network interface.
ImageId (string) --

The ID of the AMI, which you can get by using DescribeImages.
InstanceType (string) --

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .
KeyName (string) --

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

Warning

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
Monitoring (dict) --

The monitoring for the instance.
- Enabled (boolean) --
  
  Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.
Placement (dict) --

The placement for the instance.
- AvailabilityZone (string) --
  
  The Availability Zone for the instance.
- Affinity (string) --
  
  The affinity setting for an instance on a Dedicated Host.
- GroupName (string) --
  
  The name of the placement group for the instance.
- HostId (string) --
  
  The ID of the Dedicated Host for the instance.
- Tenancy (string) --
  
  The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
- SpreadDomain (string) --
  
  Reserved for future use.
RamDiskId (string) --

The ID of the RAM disk.

Warning

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide .
DisableApiTermination (boolean) --

If set to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API. To change this attribute to false after launch, use ModifyInstanceAttribute.
InstanceInitiatedShutdownBehavior (string) --

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop
UserData (string) --

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you and you can load the text from a file. Otherwise, you must provide base64-encoded text.
TagSpecifications (list) --

The tags to apply to the resources during launch. You can tag instances and volumes. The specified tags are applied to all instances or volumes that are created during launch.
- (dict) --
  
  The tags specification for the launch template.
  - ResourceType (string) --
    
    The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume .
  - 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 255 Unicode characters.
ElasticGpuSpecifications (list) --

An elastic GPU to associate with the instance.
- (dict) --
  
  A specification for an Elastic GPU.
  - Type (string) -- [REQUIRED]
    
    The type of Elastic GPU.
SecurityGroupIds (list) --

One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.
- (string) --
SecurityGroups (list) --

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.
- (string) --
InstanceMarketOptions (dict) --

The market (purchasing) option for the instances.
- MarketType (string) --
  
  The market type.
- SpotOptions (dict) --
  
  The options for Spot Instances.
  - MaxPrice (string) --
    
    The maximum hourly price you're willing to pay for the Spot Instances.
  - SpotInstanceType (string) --
    
    The Spot Instance request type.
  - BlockDurationMinutes (integer) --
    
    The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
  - ValidUntil (datetime) --
    
    The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date.
  - InstanceInterruptionBehavior (string) --
    
    The behavior when a Spot Instance is interrupted. The default is terminate .
CreditSpecification (dict) --

The credit option for CPU usage of the instance. Valid for T2 instances only.
- CpuCredits (string) --
  
  The credit option for CPU usage of a T2 instance. Valid values are standard and unlimited .

rtype

dict

returns

Response Syntax

{
    'LaunchTemplateVersion': {
        'LaunchTemplateId': 'string',
        'LaunchTemplateName': 'string',
        'VersionNumber': 123,
        'VersionDescription': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'CreatedBy': 'string',
        'DefaultVersion': True|False,
        'LaunchTemplateData': {
            'KernelId': 'string',
            'EbsOptimized': True|False,
            'IamInstanceProfile': {
                'Arn': 'string',
                'Name': 'string'
            },
            'BlockDeviceMappings': [
                {
                    'DeviceName': 'string',
                    'VirtualName': 'string',
                    'Ebs': {
                        'Encrypted': True|False,
                        'DeleteOnTermination': True|False,
                        'Iops': 123,
                        'KmsKeyId': 'string',
                        'SnapshotId': 'string',
                        'VolumeSize': 123,
                        'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
                    },
                    'NoDevice': 'string'
                },
            ],
            'NetworkInterfaces': [
                {
                    'AssociatePublicIpAddress': True|False,
                    'DeleteOnTermination': True|False,
                    'Description': 'string',
                    'DeviceIndex': 123,
                    'Groups': [
                        'string',
                    ],
                    'Ipv6AddressCount': 123,
                    'Ipv6Addresses': [
                        {
                            'Ipv6Address': 'string'
                        },
                    ],
                    'NetworkInterfaceId': 'string',
                    'PrivateIpAddress': 'string',
                    'PrivateIpAddresses': [
                        {
                            'Primary': True|False,
                            'PrivateIpAddress': 'string'
                        },
                    ],
                    'SecondaryPrivateIpAddressCount': 123,
                    'SubnetId': 'string'
                },
            ],
            'ImageId': 'string',
            'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge',
            'KeyName': 'string',
            'Monitoring': {
                'Enabled': True|False
            },
            'Placement': {
                'AvailabilityZone': 'string',
                'Affinity': 'string',
                'GroupName': 'string',
                'HostId': 'string',
                'Tenancy': 'default'|'dedicated'|'host',
                'SpreadDomain': 'string'
            },
            'RamDiskId': 'string',
            'DisableApiTermination': True|False,
            'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
            'UserData': 'string',
            'TagSpecifications': [
                {
                    'ResourceType': 'customer-gateway'|'dhcp-options'|'image'|'instance'|'internet-gateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'snapshot'|'spot-instances-request'|'subnet'|'security-group'|'volume'|'vpc'|'vpn-connection'|'vpn-gateway',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
            ],
            'ElasticGpuSpecifications': [
                {
                    'Type': 'string'
                },
            ],
            'SecurityGroupIds': [
                'string',
            ],
            'SecurityGroups': [
                'string',
            ],
            'InstanceMarketOptions': {
                'MarketType': 'spot',
                'SpotOptions': {
                    'MaxPrice': 'string',
                    'SpotInstanceType': 'one-time'|'persistent',
                    'BlockDurationMinutes': 123,
                    'ValidUntil': datetime(2015, 1, 1),
                    'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
                }
            },
            'CreditSpecification': {
                'CpuCredits': 'string'
            }
        }
    }
}

Response Structure

(dict) --
- LaunchTemplateVersion (dict) --
  
  Information about the launch template version.
  - LaunchTemplateId (string) --
    
    The ID of the launch template.
  - LaunchTemplateName (string) --
    
    The name of the launch template.
  - VersionNumber (integer) --
    
    The version number.
  - VersionDescription (string) --
    
    The description for the version.
  - CreateTime (datetime) --
    
    The time the version was created.
  - CreatedBy (string) --
    
    The principal that created the version.
  - DefaultVersion (boolean) --
    
    Indicates whether the version is the default version.
  - LaunchTemplateData (dict) --
    
    Information about the launch template.
    - KernelId (string) --
      
      The ID of the kernel, if applicable.
    - EbsOptimized (boolean) --
      
      Indicates whether the instance is optimized for Amazon EBS I/O.
    - IamInstanceProfile (dict) --
      
      The IAM instance profile.
      - Arn (string) --
        
        The Amazon Resource Name (ARN) of the instance profile.
      - Name (string) --
        
        The name of the instance profile.
    - BlockDeviceMappings (list) --
      
      The block device mappings.
      - (dict) --
        
        Describes a block device mapping.
        
        DeviceName (string) --
        
        The device name.
        
        VirtualName (string) --
        
        The virtual device name (ephemeralN).
        
        Ebs (dict) --
        
        Information about the block device for an EBS volume.
        
        Encrypted (boolean) --
        
        Indicates whether the EBS volume is encrypted.
        
        DeleteOnTermination (boolean) --
        
        Indicates whether the EBS volume is deleted on instance termination.
        
        Iops (integer) --
        
        The number of I/O operations per second (IOPS) that the volume supports.
        
        KmsKeyId (string) --
        
        The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
        
        SnapshotId (string) --
        
        The ID of the snapshot.
        
        VolumeSize (integer) --
        
        The size of the volume, in GiB.
        
        VolumeType (string) --
        
        The volume type.
        
        NoDevice (string) --
        
        Suppresses the specified device included in the block device mapping of the AMI.
    - NetworkInterfaces (list) --
      
      The network interfaces.
      - (dict) --
        
        Describes a network interface.
        
        AssociatePublicIpAddress (boolean) --
        
        Indicates whether to associate a public IPv4 address with eth0 for a new network interface.
        
        DeleteOnTermination (boolean) --
        
        Indicates whether the network interface is deleted when the instance is terminated.
        
        Description (string) --
        
        A description for the network interface.
        
        DeviceIndex (integer) --
        
        The device index for the network interface attachment.
        
        Groups (list) --
        
        The IDs of one or more security groups.
        
        (string) --
        
        Ipv6AddressCount (integer) --
        
        The number of IPv6 addresses for the network interface.
        
        Ipv6Addresses (list) --
        
        The IPv6 addresses for the network interface.
        
        (dict) --
        
        Describes an IPv6 address.
        
        Ipv6Address (string) --
        
        The IPv6 address.
        
        NetworkInterfaceId (string) --
        
        The ID of the network interface.
        
        PrivateIpAddress (string) --
        
        The primary private IPv4 address of the network interface.
        
        PrivateIpAddresses (list) --
        
        One or more private IPv4 addresses.
        
        (dict) --
        
        Describes a secondary private IPv4 address for a network interface.
        
        Primary (boolean) --
        
        Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
        
        PrivateIpAddress (string) --
        
        The private IPv4 addresses.
        
        SecondaryPrivateIpAddressCount (integer) --
        
        The number of secondary private IPv4 addresses for the network interface.
        
        SubnetId (string) --
        
        The ID of the subnet for the network interface.
    - ImageId (string) --
      
      The ID of the AMI that was used to launch the instance.
    - InstanceType (string) --
      
      The instance type.
    - KeyName (string) --
      
      The name of the key pair.
    - Monitoring (dict) --
      
      The monitoring for the instance.
      - Enabled (boolean) --
        
        Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
    - Placement (dict) --
      
      The placement of the instance.
      - AvailabilityZone (string) --
        
        The Availability Zone of the instance.
      - Affinity (string) --
        
        The affinity setting for the instance on the Dedicated Host.
      - GroupName (string) --
        
        The name of the placement group for the instance.
      - HostId (string) --
        
        The ID of the Dedicated Host for the instance.
      - Tenancy (string) --
        
        The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
      - SpreadDomain (string) --
        
        Reserved for future use.
    - RamDiskId (string) --
      
      The ID of the RAM disk, if applicable.
    - DisableApiTermination (boolean) --
      
      If set to true , indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.
    - InstanceInitiatedShutdownBehavior (string) --
      
      Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
    - UserData (string) --
      
      The user data for the instance.
    - TagSpecifications (list) --
      
      The tags.
      - (dict) --
        
        The tag specification for the launch template.
        
        ResourceType (string) --
        
        The type of resource.
        
        Tags (list) --
        
        The tags for 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 255 Unicode characters.
    - ElasticGpuSpecifications (list) --
      
      The elastic GPU specification.
      - (dict) --
        
        Describes an elastic GPU.
        
        Type (string) --
        
        The elastic GPU type.
    - SecurityGroupIds (list) --
      
      The security group IDs.
      - (string) --
    - SecurityGroups (list) --
      
      The security group names.
      - (string) --
    - InstanceMarketOptions (dict) --
      
      The market (purchasing) option for the instances.
      - MarketType (string) --
        
        The market type.
      - SpotOptions (dict) --
        
        The options for Spot Instances.
        
        MaxPrice (string) --
        
        The maximum hourly price you're willing to pay for the Spot Instances.
        
        SpotInstanceType (string) --
        
        The Spot Instance request type.
        
        BlockDurationMinutes (integer) --
        
        The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
        
        ValidUntil (datetime) --
        
        The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
        
        InstanceInterruptionBehavior (string) --
        
        The behavior when a Spot Instance is interrupted.
    - CreditSpecification (dict) --
      
      The credit option for CPU usage of the instance.
      - CpuCredits (string) --
        
        The credit option for CPU usage of a T2 instance.

CreateLaunchTemplate (new)

Link ¶

Creates a launch template. A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request.

See also: AWS API Documentation

Request Syntax

client.create_launch_template(
    DryRun=True|False,
    ClientToken='string',
    LaunchTemplateName='string',
    VersionDescription='string',
    LaunchTemplateData={
        'KernelId': 'string',
        'EbsOptimized': True|False,
        'IamInstanceProfile': {
            'Arn': 'string',
            'Name': 'string'
        },
        'BlockDeviceMappings': [
            {
                'DeviceName': 'string',
                'VirtualName': 'string',
                'Ebs': {
                    'Encrypted': True|False,
                    'DeleteOnTermination': True|False,
                    'Iops': 123,
                    'KmsKeyId': 'string',
                    'SnapshotId': 'string',
                    'VolumeSize': 123,
                    'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
                },
                'NoDevice': 'string'
            },
        ],
        'NetworkInterfaces': [
            {
                'AssociatePublicIpAddress': True|False,
                'DeleteOnTermination': True|False,
                'Description': 'string',
                'DeviceIndex': 123,
                'Groups': [
                    'string',
                ],
                'Ipv6AddressCount': 123,
                'Ipv6Addresses': [
                    {
                        'Ipv6Address': 'string'
                    },
                ],
                'NetworkInterfaceId': 'string',
                'PrivateIpAddress': 'string',
                'PrivateIpAddresses': [
                    {
                        'Primary': True|False,
                        'PrivateIpAddress': 'string'
                    },
                ],
                'SecondaryPrivateIpAddressCount': 123,
                'SubnetId': 'string'
            },
        ],
        'ImageId': 'string',
        'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge',
        'KeyName': 'string',
        'Monitoring': {
            'Enabled': True|False
        },
        'Placement': {
            'AvailabilityZone': 'string',
            'Affinity': 'string',
            'GroupName': 'string',
            'HostId': 'string',
            'Tenancy': 'default'|'dedicated'|'host',
            'SpreadDomain': 'string'
        },
        'RamDiskId': 'string',
        'DisableApiTermination': True|False,
        'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
        'UserData': 'string',
        'TagSpecifications': [
            {
                'ResourceType': 'customer-gateway'|'dhcp-options'|'image'|'instance'|'internet-gateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'snapshot'|'spot-instances-request'|'subnet'|'security-group'|'volume'|'vpc'|'vpn-connection'|'vpn-gateway',
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            },
        ],
        'ElasticGpuSpecifications': [
            {
                'Type': 'string'
            },
        ],
        'SecurityGroupIds': [
            'string',
        ],
        'SecurityGroups': [
            'string',
        ],
        'InstanceMarketOptions': {
            'MarketType': 'spot',
            'SpotOptions': {
                'MaxPrice': 'string',
                'SpotInstanceType': 'one-time'|'persistent',
                'BlockDurationMinutes': 123,
                'ValidUntil': datetime(2015, 1, 1),
                'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
            }
        },
        'CreditSpecification': {
            'CpuCredits': 'string'
        }
    }
)

type DryRun

boolean

param DryRun

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

type LaunchTemplateName

string

param LaunchTemplateName

[REQUIRED]

A name for the launch template.

type VersionDescription

string

param VersionDescription

A description for the first version of the launch template.

type LaunchTemplateData

dict

param LaunchTemplateData

[REQUIRED]

The information for the launch template.

KernelId (string) --

The ID of the kernel.

Warning

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide .
EbsOptimized (boolean) --

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
IamInstanceProfile (dict) --

The IAM instance profile.
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the instance profile.
- Name (string) --
  
  The name of the instance profile.
BlockDeviceMappings (list) --

The block device mapping.

Warning

Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.
- (dict) --
  
  Describes a block device mapping.
  - DeviceName (string) --
    
    The device name (for example, /dev/sdh or xvdh).
  - VirtualName (string) --
    
    The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
  - Ebs (dict) --
    
    Parameters used to automatically set up EBS volumes when the instance is launched.
    - Encrypted (boolean) --
      
      Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.
    - DeleteOnTermination (boolean) --
      
      Indicates whether the EBS volume is deleted on instance termination.
    - Iops (integer) --
      
      The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
      
      Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.
    - KmsKeyId (string) --
      
      The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
    - SnapshotId (string) --
      
      The ID of the snapshot.
    - VolumeSize (integer) --
      
      The size of the volume, in GiB.
      
      Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
    - VolumeType (string) --
      
      The volume type.
  - NoDevice (string) --
    
    Suppresses the specified device included in the block device mapping of the AMI.
NetworkInterfaces (list) --

One or more network interfaces.
- (dict) --
  
  The parameters for a network interface.
  - AssociatePublicIpAddress (boolean) --
    
    Associates a public IPv4 address with eth0 for a new network interface.
  - DeleteOnTermination (boolean) --
    
    Indicates whether the network interface is deleted when the instance is terminated.
  - Description (string) --
    
    A description for the network interface.
  - DeviceIndex (integer) --
    
    The device index for the network interface attachment.
  - Groups (list) --
    
    The IDs of one or more security groups.
    - (string) --
  - Ipv6AddressCount (integer) --
    
    The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.
  - Ipv6Addresses (list) --
    
    One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
    - (dict) --
      
      Describes an IPv6 address.
      - Ipv6Address (string) --
        
        The IPv6 address.
  - NetworkInterfaceId (string) --
    
    The ID of the network interface.
  - PrivateIpAddress (string) --
    
    The primary private IPv4 address of the network interface.
  - PrivateIpAddresses (list) --
    
    One or more private IPv4 addresses.
    - (dict) --
      
      Describes a secondary private IPv4 address for a network interface.
      - Primary (boolean) --
        
        Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
      - PrivateIpAddress (string) -- [REQUIRED]
        
        The private IPv4 addresses.
  - SecondaryPrivateIpAddressCount (integer) --
    
    The number of secondary private IPv4 addresses to assign to a network interface.
  - SubnetId (string) --
    
    The ID of the subnet for the network interface.
ImageId (string) --

The ID of the AMI, which you can get by using DescribeImages.
InstanceType (string) --

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .
KeyName (string) --

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

Warning

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
Monitoring (dict) --

The monitoring for the instance.
- Enabled (boolean) --
  
  Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.
Placement (dict) --

The placement for the instance.
- AvailabilityZone (string) --
  
  The Availability Zone for the instance.
- Affinity (string) --
  
  The affinity setting for an instance on a Dedicated Host.
- GroupName (string) --
  
  The name of the placement group for the instance.
- HostId (string) --
  
  The ID of the Dedicated Host for the instance.
- Tenancy (string) --
  
  The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
- SpreadDomain (string) --
  
  Reserved for future use.
RamDiskId (string) --

The ID of the RAM disk.

Warning

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide .
DisableApiTermination (boolean) --

If set to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API. To change this attribute to false after launch, use ModifyInstanceAttribute.
InstanceInitiatedShutdownBehavior (string) --

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop
UserData (string) --

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you and you can load the text from a file. Otherwise, you must provide base64-encoded text.
TagSpecifications (list) --

The tags to apply to the resources during launch. You can tag instances and volumes. The specified tags are applied to all instances or volumes that are created during launch.
- (dict) --
  
  The tags specification for the launch template.
  - ResourceType (string) --
    
    The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume .
  - 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 255 Unicode characters.
ElasticGpuSpecifications (list) --

An elastic GPU to associate with the instance.
- (dict) --
  
  A specification for an Elastic GPU.
  - Type (string) -- [REQUIRED]
    
    The type of Elastic GPU.
SecurityGroupIds (list) --

One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.
- (string) --
SecurityGroups (list) --

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.
- (string) --
InstanceMarketOptions (dict) --

The market (purchasing) option for the instances.
- MarketType (string) --
  
  The market type.
- SpotOptions (dict) --
  
  The options for Spot Instances.
  - MaxPrice (string) --
    
    The maximum hourly price you're willing to pay for the Spot Instances.
  - SpotInstanceType (string) --
    
    The Spot Instance request type.
  - BlockDurationMinutes (integer) --
    
    The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
  - ValidUntil (datetime) --
    
    The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date.
  - InstanceInterruptionBehavior (string) --
    
    The behavior when a Spot Instance is interrupted. The default is terminate .
CreditSpecification (dict) --

The credit option for CPU usage of the instance. Valid for T2 instances only.
- CpuCredits (string) --
  
  The credit option for CPU usage of a T2 instance. Valid values are standard and unlimited .

rtype

dict

returns

Response Syntax

{
    'LaunchTemplate': {
        'LaunchTemplateId': 'string',
        'LaunchTemplateName': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'CreatedBy': 'string',
        'DefaultVersionNumber': 123,
        'LatestVersionNumber': 123,
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- LaunchTemplate (dict) --
  
  Information about the launch template.
  - LaunchTemplateId (string) --
    
    The ID of the launch template.
  - LaunchTemplateName (string) --
    
    The name of the launch template.
  - CreateTime (datetime) --
    
    The time launch template was created.
  - CreatedBy (string) --
    
    The principal that created the launch template.
  - DefaultVersionNumber (integer) --
    
    The version number of the default version of the launch template.
  - LatestVersionNumber (integer) --
    
    The version number of the latest version of the launch template.
  - Tags (list) --
    
    The tags for the launch template.
    - (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 255 Unicode characters.

DescribeVpcEndpointConnections (new)

Link ¶

Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.

See also: AWS API Documentation

Request Syntax

client.describe_vpc_endpoint_connections(
    DryRun=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type DryRun

boolean

param DryRun

type Filters

list

param Filters

One or more filters.

customer-account-id - The AWS account number of the owner of the endpoint.
endpoint-connection-state - The state of the endpoint ( PendingAcceptance | Pending | Available | Deleting | Deleted | Rejected | Failed ).
vpc-endpoint-id - The ID of the endpoint.
vpc-endpoint-service-id - The ID of the service.

(dict) --

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

type NextToken

string

param NextToken

The token to retrieve the next page of results.

rtype

dict

returns

Response Syntax

{
    'VpcEndpointConnections': [
        {
            'ServiceId': 'string',
            'VpcEndpointId': 'string',
            'VpcEndpointOwner': 'string',
            'VpcEndpointState': 'PendingAcceptance'|'Pending'|'Available'|'Deleting'|'Deleted'|'Rejected'|'Failed'|'Expired',
            'CreationTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- VpcEndpointConnections (list) --
  
  Information about one or more VPC endpoint connections.
  - (dict) --
    
    Describes a VPC endpoint connection to a service.
    - ServiceId (string) --
      
      The ID of the service to which the endpoint is connected.
    - VpcEndpointId (string) --
      
      The ID of the VPC endpoint.
    - VpcEndpointOwner (string) --
      
      The AWS account ID of the owner of the VPC endpoint.
    - VpcEndpointState (string) --
      
      The state of the VPC endpoint.
    - CreationTimestamp (datetime) --
      
      The date and time the VPC endpoint was created.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

ModifyLaunchTemplate (new)

Link ¶

Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified.

See also: AWS API Documentation

Request Syntax

client.modify_launch_template(
    DryRun=True|False,
    ClientToken='string',
    LaunchTemplateId='string',
    LaunchTemplateName='string',
    DefaultVersion='string'
)

type DryRun

boolean

param DryRun

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

type LaunchTemplateId

string

param LaunchTemplateId

The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

type LaunchTemplateName

string

param LaunchTemplateName

The name of the launch template. You must specify either the launch template ID or launch template name in the request.

type DefaultVersion

string

param DefaultVersion

The version number of the launch template to set as the default version.

rtype

dict

returns

Response Syntax

{
    'LaunchTemplate': {
        'LaunchTemplateId': 'string',
        'LaunchTemplateName': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'CreatedBy': 'string',
        'DefaultVersionNumber': 123,
        'LatestVersionNumber': 123,
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- LaunchTemplate (dict) --
  
  Information about the launch template.
  - LaunchTemplateId (string) --
    
    The ID of the launch template.
  - LaunchTemplateName (string) --
    
    The name of the launch template.
  - CreateTime (datetime) --
    
    The time launch template was created.
  - CreatedBy (string) --
    
    The principal that created the launch template.
  - DefaultVersionNumber (integer) --
    
    The version number of the default version of the launch template.
  - LatestVersionNumber (integer) --
    
    The version number of the latest version of the launch template.
  - Tags (list) --
    
    The tags for the launch template.
    - (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 255 Unicode characters.

DescribeLaunchTemplateVersions (new)

Link ¶

Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions.

See also: AWS API Documentation

Request Syntax

client.describe_launch_template_versions(
    DryRun=True|False,
    LaunchTemplateId='string',
    LaunchTemplateName='string',
    Versions=[
        'string',
    ],
    MinVersion='string',
    MaxVersion='string',
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

type DryRun

boolean

param DryRun

type LaunchTemplateId

string

param LaunchTemplateId

The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

type LaunchTemplateName

string

param LaunchTemplateName

The name of the launch template. You must specify either the launch template ID or launch template name in the request.

type Versions

list

param Versions

One or more versions of the launch template.

(string) --

type MinVersion

string

param MinVersion

The version number after which to describe launch template versions.

type MaxVersion

string

param MaxVersion

The version number up to which to describe launch template versions.

type NextToken

string

param NextToken

The token to request the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000.

type Filters

list

param Filters

One or more filters.

create-time - The time the launch template version was created.
ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.
iam-instance-profile - The ARN of the IAM instance profile.
image-id - The ID of the AMI.
instance-type - The instance type.
is-default-version - A boolean that indicates whether the launch template version is the default version.
kernel-id - The kernel ID.
ram-disk-id - The RAM disk ID.

(dict) --

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

rtype

dict

returns

Response Syntax

{
    'LaunchTemplateVersions': [
        {
            'LaunchTemplateId': 'string',
            'LaunchTemplateName': 'string',
            'VersionNumber': 123,
            'VersionDescription': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'CreatedBy': 'string',
            'DefaultVersion': True|False,
            'LaunchTemplateData': {
                'KernelId': 'string',
                'EbsOptimized': True|False,
                'IamInstanceProfile': {
                    'Arn': 'string',
                    'Name': 'string'
                },
                'BlockDeviceMappings': [
                    {
                        'DeviceName': 'string',
                        'VirtualName': 'string',
                        'Ebs': {
                            'Encrypted': True|False,
                            'DeleteOnTermination': True|False,
                            'Iops': 123,
                            'KmsKeyId': 'string',
                            'SnapshotId': 'string',
                            'VolumeSize': 123,
                            'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
                        },
                        'NoDevice': 'string'
                    },
                ],
                'NetworkInterfaces': [
                    {
                        'AssociatePublicIpAddress': True|False,
                        'DeleteOnTermination': True|False,
                        'Description': 'string',
                        'DeviceIndex': 123,
                        'Groups': [
                            'string',
                        ],
                        'Ipv6AddressCount': 123,
                        'Ipv6Addresses': [
                            {
                                'Ipv6Address': 'string'
                            },
                        ],
                        'NetworkInterfaceId': 'string',
                        'PrivateIpAddress': 'string',
                        'PrivateIpAddresses': [
                            {
                                'Primary': True|False,
                                'PrivateIpAddress': 'string'
                            },
                        ],
                        'SecondaryPrivateIpAddressCount': 123,
                        'SubnetId': 'string'
                    },
                ],
                'ImageId': 'string',
                'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge',
                'KeyName': 'string',
                'Monitoring': {
                    'Enabled': True|False
                },
                'Placement': {
                    'AvailabilityZone': 'string',
                    'Affinity': 'string',
                    'GroupName': 'string',
                    'HostId': 'string',
                    'Tenancy': 'default'|'dedicated'|'host',
                    'SpreadDomain': 'string'
                },
                'RamDiskId': 'string',
                'DisableApiTermination': True|False,
                'InstanceInitiatedShutdownBehavior': 'stop'|'terminate',
                'UserData': 'string',
                'TagSpecifications': [
                    {
                        'ResourceType': 'customer-gateway'|'dhcp-options'|'image'|'instance'|'internet-gateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'snapshot'|'spot-instances-request'|'subnet'|'security-group'|'volume'|'vpc'|'vpn-connection'|'vpn-gateway',
                        'Tags': [
                            {
                                'Key': 'string',
                                'Value': 'string'
                            },
                        ]
                    },
                ],
                'ElasticGpuSpecifications': [
                    {
                        'Type': 'string'
                    },
                ],
                'SecurityGroupIds': [
                    'string',
                ],
                'SecurityGroups': [
                    'string',
                ],
                'InstanceMarketOptions': {
                    'MarketType': 'spot',
                    'SpotOptions': {
                        'MaxPrice': 'string',
                        'SpotInstanceType': 'one-time'|'persistent',
                        'BlockDurationMinutes': 123,
                        'ValidUntil': datetime(2015, 1, 1),
                        'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
                    }
                },
                'CreditSpecification': {
                    'CpuCredits': 'string'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- LaunchTemplateVersions (list) --
  
  Information about the launch template versions.
  - (dict) --
    
    Describes a launch template version.
    - LaunchTemplateId (string) --
      
      The ID of the launch template.
    - LaunchTemplateName (string) --
      
      The name of the launch template.
    - VersionNumber (integer) --
      
      The version number.
    - VersionDescription (string) --
      
      The description for the version.
    - CreateTime (datetime) --
      
      The time the version was created.
    - CreatedBy (string) --
      
      The principal that created the version.
    - DefaultVersion (boolean) --
      
      Indicates whether the version is the default version.
    - LaunchTemplateData (dict) --
      
      Information about the launch template.
      - KernelId (string) --
        
        The ID of the kernel, if applicable.
      - EbsOptimized (boolean) --
        
        Indicates whether the instance is optimized for Amazon EBS I/O.
      - IamInstanceProfile (dict) --
        
        The IAM instance profile.
        
        Arn (string) --
        
        The Amazon Resource Name (ARN) of the instance profile.
        
        Name (string) --
        
        The name of the instance profile.
      - BlockDeviceMappings (list) --
        
        The block device mappings.
        
        (dict) --
        
        Describes a block device mapping.
        
        DeviceName (string) --
        
        The device name.
        
        VirtualName (string) --
        
        The virtual device name (ephemeralN).
        
        Ebs (dict) --
        
        Information about the block device for an EBS volume.
        
        Encrypted (boolean) --
        
        Indicates whether the EBS volume is encrypted.
        
        DeleteOnTermination (boolean) --
        
        Indicates whether the EBS volume is deleted on instance termination.
        
        Iops (integer) --
        
        The number of I/O operations per second (IOPS) that the volume supports.
        
        KmsKeyId (string) --
        
        The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.
        
        SnapshotId (string) --
        
        The ID of the snapshot.
        
        VolumeSize (integer) --
        
        The size of the volume, in GiB.
        
        VolumeType (string) --
        
        The volume type.
        
        NoDevice (string) --
        
        Suppresses the specified device included in the block device mapping of the AMI.
      - NetworkInterfaces (list) --
        
        The network interfaces.
        
        (dict) --
        
        Describes a network interface.
        
        AssociatePublicIpAddress (boolean) --
        
        Indicates whether to associate a public IPv4 address with eth0 for a new network interface.
        
        DeleteOnTermination (boolean) --
        
        Indicates whether the network interface is deleted when the instance is terminated.
        
        Description (string) --
        
        A description for the network interface.
        
        DeviceIndex (integer) --
        
        The device index for the network interface attachment.
        
        Groups (list) --
        
        The IDs of one or more security groups.
        
        (string) --
        
        Ipv6AddressCount (integer) --
        
        The number of IPv6 addresses for the network interface.
        
        Ipv6Addresses (list) --
        
        The IPv6 addresses for the network interface.
        
        (dict) --
        
        Describes an IPv6 address.
        
        Ipv6Address (string) --
        
        The IPv6 address.
        
        NetworkInterfaceId (string) --
        
        The ID of the network interface.
        
        PrivateIpAddress (string) --
        
        The primary private IPv4 address of the network interface.
        
        PrivateIpAddresses (list) --
        
        One or more private IPv4 addresses.
        
        (dict) --
        
        Describes a secondary private IPv4 address for a network interface.
        
        Primary (boolean) --
        
        Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
        
        PrivateIpAddress (string) --
        
        The private IPv4 addresses.
        
        SecondaryPrivateIpAddressCount (integer) --
        
        The number of secondary private IPv4 addresses for the network interface.
        
        SubnetId (string) --
        
        The ID of the subnet for the network interface.
      - ImageId (string) --
        
        The ID of the AMI that was used to launch the instance.
      - InstanceType (string) --
        
        The instance type.
      - KeyName (string) --
        
        The name of the key pair.
      - Monitoring (dict) --
        
        The monitoring for the instance.
        
        Enabled (boolean) --
        
        Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
      - Placement (dict) --
        
        The placement of the instance.
        
        AvailabilityZone (string) --
        
        The Availability Zone of the instance.
        
        Affinity (string) --
        
        The affinity setting for the instance on the Dedicated Host.
        
        GroupName (string) --
        
        The name of the placement group for the instance.
        
        HostId (string) --
        
        The ID of the Dedicated Host for the instance.
        
        Tenancy (string) --
        
        The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
        
        SpreadDomain (string) --
        
        Reserved for future use.
      - RamDiskId (string) --
        
        The ID of the RAM disk, if applicable.
      - DisableApiTermination (boolean) --
        
        If set to true , indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.
      - InstanceInitiatedShutdownBehavior (string) --
        
        Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
      - UserData (string) --
        
        The user data for the instance.
      - TagSpecifications (list) --
        
        The tags.
        
        (dict) --
        
        The tag specification for the launch template.
        
        ResourceType (string) --
        
        The type of resource.
        
        Tags (list) --
        
        The tags for 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 255 Unicode characters.
      - ElasticGpuSpecifications (list) --
        
        The elastic GPU specification.
        
        (dict) --
        
        Describes an elastic GPU.
        
        Type (string) --
        
        The elastic GPU type.
      - SecurityGroupIds (list) --
        
        The security group IDs.
        
        (string) --
      - SecurityGroups (list) --
        
        The security group names.
        
        (string) --
      - InstanceMarketOptions (dict) --
        
        The market (purchasing) option for the instances.
        
        MarketType (string) --
        
        The market type.
        
        SpotOptions (dict) --
        
        The options for Spot Instances.
        
        MaxPrice (string) --
        
        The maximum hourly price you're willing to pay for the Spot Instances.
        
        SpotInstanceType (string) --
        
        The Spot Instance request type.
        
        BlockDurationMinutes (integer) --
        
        The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
        
        ValidUntil (datetime) --
        
        The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
        
        InstanceInterruptionBehavior (string) --
        
        The behavior when a Spot Instance is interrupted.
      - CreditSpecification (dict) --
        
        The credit option for CPU usage of the instance.
        
        CpuCredits (string) --
        
        The credit option for CPU usage of a T2 instance.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

AcceptVpcEndpointConnections (new)

Link ¶

Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.

See also: AWS API Documentation

Request Syntax

client.accept_vpc_endpoint_connections(
    DryRun=True|False,
    ServiceId='string',
    VpcEndpointIds=[
        'string',
    ]
)

type DryRun

boolean

param DryRun

type ServiceId

string

param ServiceId

[REQUIRED]

The ID of the endpoint service.

type VpcEndpointIds

list

param VpcEndpointIds

[REQUIRED]

The IDs of one or more interface VPC endpoints.

(string) --

rtype

dict

returns

Response Syntax

{
    'Unsuccessful': [
        {
            'Error': {
                'Code': 'string',
                'Message': 'string'
            },
            'ResourceId': 'string'
        },
    ]
}

Response Structure

(dict) --
- Unsuccessful (list) --
  
  Information about the interface endpoints that were not accepted, if applicable.
  - (dict) --
    
    Information about items that were not successfully processed in a batch call.
    - Error (dict) --
      
      Information about the error.
      - Code (string) --
        
        The error code.
      - Message (string) --
        
        The error message accompanying the error code.
    - ResourceId (string) --
      
      The ID of the resource.

DeleteVpcEndpointConnectionNotifications (new)

Link ¶

Deletes one or more VPC endpoint connection notifications.

See also: AWS API Documentation

Request Syntax

client.delete_vpc_endpoint_connection_notifications(
    DryRun=True|False,
    ConnectionNotificationIds=[
        'string',
    ]
)

type DryRun

boolean

param DryRun

type ConnectionNotificationIds

list

param ConnectionNotificationIds

[REQUIRED]

One or more notification IDs.

(string) --

rtype

dict

returns

Response Syntax

{
    'Unsuccessful': [
        {
            'Error': {
                'Code': 'string',
                'Message': 'string'
            },
            'ResourceId': 'string'
        },
    ]
}

Response Structure

(dict) --
- Unsuccessful (list) --
  
  Information about the notifications that could not be deleted successfully.
  - (dict) --
    
    Information about items that were not successfully processed in a batch call.
    - Error (dict) --
      
      Information about the error.
      - Code (string) --
        
        The error code.
      - Message (string) --
        
        The error message accompanying the error code.
    - ResourceId (string) --
      
      The ID of the resource.

DeleteLaunchTemplate (new)

Link ¶

Deletes a launch template. Deleting a launch template deletes all of its versions.

See also: AWS API Documentation

Request Syntax

client.delete_launch_template(
    DryRun=True|False,
    LaunchTemplateId='string',
    LaunchTemplateName='string'
)

type DryRun

boolean

param DryRun

type LaunchTemplateId

string

param LaunchTemplateId

The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

type LaunchTemplateName

string

param LaunchTemplateName

The name of the launch template. You must specify either the launch template ID or launch template name in the request.

rtype

dict

returns

Response Syntax

{
    'LaunchTemplate': {
        'LaunchTemplateId': 'string',
        'LaunchTemplateName': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'CreatedBy': 'string',
        'DefaultVersionNumber': 123,
        'LatestVersionNumber': 123,
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- LaunchTemplate (dict) --
  
  Information about the launch template.
  - LaunchTemplateId (string) --
    
    The ID of the launch template.
  - LaunchTemplateName (string) --
    
    The name of the launch template.
  - CreateTime (datetime) --
    
    The time launch template was created.
  - CreatedBy (string) --
    
    The principal that created the launch template.
  - DefaultVersionNumber (integer) --
    
    The version number of the default version of the launch template.
  - LatestVersionNumber (integer) --
    
    The version number of the latest version of the launch template.
  - Tags (list) --
    
    The tags for the launch template.
    - (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 255 Unicode characters.

DeleteVpcEndpointServiceConfigurations (new)

Link ¶

Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.

See also: AWS API Documentation

Request Syntax

client.delete_vpc_endpoint_service_configurations(
    DryRun=True|False,
    ServiceIds=[
        'string',
    ]
)

type DryRun

boolean

param DryRun

type ServiceIds

list

param ServiceIds

[REQUIRED]

The IDs of one or more services.

(string) --

rtype

dict

returns

Response Syntax

{
    'Unsuccessful': [
        {
            'Error': {
                'Code': 'string',
                'Message': 'string'
            },
            'ResourceId': 'string'
        },
    ]
}

Response Structure

(dict) --
- Unsuccessful (list) --
  
  Information about the service configurations that were not deleted, if applicable.
  - (dict) --
    
    Information about items that were not successfully processed in a batch call.
    - Error (dict) --
      
      Information about the error.
      - Code (string) --
        
        The error code.
      - Message (string) --
        
        The error message accompanying the error code.
    - ResourceId (string) --
      
      The ID of the resource.

RejectVpcEndpointConnections (new)

Link ¶

Rejects one or more VPC endpoint connection requests to your VPC endpoint service.

See also: AWS API Documentation

Request Syntax

client.reject_vpc_endpoint_connections(
    DryRun=True|False,
    ServiceId='string',
    VpcEndpointIds=[
        'string',
    ]
)

type DryRun

boolean

param DryRun

type ServiceId

string

param ServiceId

[REQUIRED]

The ID of the service.

type VpcEndpointIds

list

param VpcEndpointIds

[REQUIRED]

The IDs of one or more VPC endpoints.

(string) --

rtype

dict

returns

Response Syntax

{
    'Unsuccessful': [
        {
            'Error': {
                'Code': 'string',
                'Message': 'string'
            },
            'ResourceId': 'string'
        },
    ]
}

Response Structure

(dict) --
- Unsuccessful (list) --
  
  Information about the endpoints that were not rejected, if applicable.
  - (dict) --
    
    Information about items that were not successfully processed in a batch call.
    - Error (dict) --
      
      Information about the error.
      - Code (string) --
        
        The error code.
      - Message (string) --
        
        The error message accompanying the error code.
    - ResourceId (string) --
      
      The ID of the resource.

DeleteLaunchTemplateVersions (new)

Link ¶

Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.

See also: AWS API Documentation

Request Syntax

client.delete_launch_template_versions(
    DryRun=True|False,
    LaunchTemplateId='string',
    LaunchTemplateName='string',
    Versions=[
        'string',
    ]
)

type DryRun

boolean

param DryRun

type LaunchTemplateId

string

param LaunchTemplateId

The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

type LaunchTemplateName

string

param LaunchTemplateName

The name of the launch template. You must specify either the launch template ID or launch template name in the request.

type Versions

list

param Versions

[REQUIRED]

The version numbers of one or more launch template versions to delete.

(string) --

rtype

dict

returns

Response Syntax

{
    'SuccessfullyDeletedLaunchTemplateVersions': [
        {
            'LaunchTemplateId': 'string',
            'LaunchTemplateName': 'string',
            'VersionNumber': 123
        },
    ],
    'UnsuccessfullyDeletedLaunchTemplateVersions': [
        {
            'LaunchTemplateId': 'string',
            'LaunchTemplateName': 'string',
            'VersionNumber': 123,
            'ResponseError': {
                'Code': 'launchTemplateIdDoesNotExist'|'launchTemplateIdMalformed'|'launchTemplateNameDoesNotExist'|'launchTemplateNameMalformed'|'launchTemplateVersionDoesNotExist'|'unexpectedError',
                'Message': 'string'
            }
        },
    ]
}

Response Structure

(dict) --
- SuccessfullyDeletedLaunchTemplateVersions (list) --
  
  Information about the launch template versions that were successfully deleted.
  - (dict) --
    
    Describes a launch template version that was successfully deleted.
    - LaunchTemplateId (string) --
      
      The ID of the launch template.
    - LaunchTemplateName (string) --
      
      The name of the launch template.
    - VersionNumber (integer) --
      
      The version number of the launch template.
- UnsuccessfullyDeletedLaunchTemplateVersions (list) --
  
  Information about the launch template versions that could not be deleted.
  - (dict) --
    
    Describes a launch template version that could not be deleted.
    - LaunchTemplateId (string) --
      
      The ID of the launch template.
    - LaunchTemplateName (string) --
      
      The name of the launch template.
    - VersionNumber (integer) --
      
      The version number of the launch template.
    - ResponseError (dict) --
      
      Information about the error.
      - Code (string) --
        
        The error code.
      - Message (string) --
        
        The error message, if applicable.

ModifyVpcEndpointConnectionNotification (new)

Link ¶

Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified.

See also: AWS API Documentation

Request Syntax

client.modify_vpc_endpoint_connection_notification(
    DryRun=True|False,
    ConnectionNotificationId='string',
    ConnectionNotificationArn='string',
    ConnectionEvents=[
        'string',
    ]
)

type DryRun

boolean

param DryRun

type ConnectionNotificationId

string

param ConnectionNotificationId

[REQUIRED]

The ID of the notification.

type ConnectionNotificationArn

string

param ConnectionNotificationArn

The ARN for the SNS topic for the notification.

type ConnectionEvents

list

param ConnectionEvents

One or more events for the endpoint. Valid values are Accept , Connect , Delete , and Reject .

(string) --

rtype

dict

returns

Response Syntax

{
    'ReturnValue': True|False
}

Response Structure

(dict) --
- ReturnValue (boolean) --
  
  Returns true if the request succeeds; otherwise, it returns an error.

CreateVpcEndpointConnectionNotification (new)

Link ¶

Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide .

You can create a connection notification for interface endpoints only.

See also: AWS API Documentation

Request Syntax

client.create_vpc_endpoint_connection_notification(
    DryRun=True|False,
    ServiceId='string',
    VpcEndpointId='string',
    ConnectionNotificationArn='string',
    ConnectionEvents=[
        'string',
    ],
    ClientToken='string'
)

type DryRun

boolean

param DryRun

type ServiceId

string

param ServiceId

The ID of the endpoint service.

type VpcEndpointId

string

param VpcEndpointId

The ID of the endpoint.

type ConnectionNotificationArn

string

param ConnectionNotificationArn

[REQUIRED]

The ARN of the SNS topic for the notifications.

type ConnectionEvents

list

param ConnectionEvents

[REQUIRED]

One or more endpoint events for which to receive notifications. Valid values are Accept , Connect , Delete , and Reject .

(string) --

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

rtype

dict

returns

Response Syntax

{
    'ConnectionNotification': {
        'ConnectionNotificationId': 'string',
        'ServiceId': 'string',
        'VpcEndpointId': 'string',
        'ConnectionNotificationType': 'Topic',
        'ConnectionNotificationArn': 'string',
        'ConnectionEvents': [
            'string',
        ],
        'ConnectionNotificationState': 'Enabled'|'Disabled'
    },
    'ClientToken': 'string'
}

Response Structure

(dict) --
- ConnectionNotification (dict) --
  
  Information about the notification.
  - ConnectionNotificationId (string) --
    
    The ID of the notification.
  - ServiceId (string) --
    
    The ID of the endpoint service.
  - VpcEndpointId (string) --
    
    The ID of the VPC endpoint.
  - ConnectionNotificationType (string) --
    
    The type of notification.
  - ConnectionNotificationArn (string) --
    
    The ARN of the SNS topic for the notification.
  - ConnectionEvents (list) --
    
    The events for the notification. Valid values are Accept , Connect , Delete , and Reject .
    - (string) --
  - ConnectionNotificationState (string) --
    
    The state of the notification.
- ClientToken (string) --
  
  Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

DescribeVpcEndpointServicePermissions (new)

Link ¶

Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.

See also: AWS API Documentation

Request Syntax

client.describe_vpc_endpoint_service_permissions(
    DryRun=True|False,
    ServiceId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

type DryRun

boolean

param DryRun

type ServiceId

string

param ServiceId

[REQUIRED]

The ID of the service.

type Filters

list

param Filters

One or more filters.

principal - The ARN of the principal.
principal-type - The principal type ( All | Service | OrganizationUnit | Account | User | Role ).

(dict) --

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

type MaxResults

integer

param MaxResults

type NextToken

string

param NextToken

The token to retrieve the next page of results.

rtype

dict

returns

Response Syntax

{
    'AllowedPrincipals': [
        {
            'PrincipalType': 'All'|'Service'|'OrganizationUnit'|'Account'|'User'|'Role',
            'Principal': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- AllowedPrincipals (list) --
  
  Information about one or more allowed principals.
  - (dict) --
    
    Describes a principal.
    - PrincipalType (string) --
      
      The type of principal.
    - Principal (string) --
      
      The Amazon Resource Name (ARN) of the principal.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DescribeLaunchTemplates (new)

Link ¶

Describes one or more launch templates.

See also: AWS API Documentation

Request Syntax

client.describe_launch_templates(
    DryRun=True|False,
    LaunchTemplateIds=[
        'string',
    ],
    LaunchTemplateNames=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    NextToken='string',
    MaxResults=123
)

type DryRun

boolean

param DryRun

type LaunchTemplateIds

list

param LaunchTemplateIds

One or more launch template IDs.

(string) --

type LaunchTemplateNames

list

param LaunchTemplateNames

One or more launch template names.

(string) --

type Filters

list

param Filters

One or more filters.

create-time - The time the launch template was created.
launch-template-name - The name of the launch template.

(dict) --

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

type NextToken

string

param NextToken

The token to request the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000.

rtype

dict

returns

Response Syntax

{
    'LaunchTemplates': [
        {
            'LaunchTemplateId': 'string',
            'LaunchTemplateName': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'CreatedBy': 'string',
            'DefaultVersionNumber': 123,
            'LatestVersionNumber': 123,
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- LaunchTemplates (list) --
  
  Information about the launch templates.
  - (dict) --
    
    Describes a launch template.
    - LaunchTemplateId (string) --
      
      The ID of the launch template.
    - LaunchTemplateName (string) --
      
      The name of the launch template.
    - CreateTime (datetime) --
      
      The time launch template was created.
    - CreatedBy (string) --
      
      The principal that created the launch template.
    - DefaultVersionNumber (integer) --
      
      The version number of the default version of the launch template.
    - LatestVersionNumber (integer) --
      
      The version number of the latest version of the launch template.
    - Tags (list) --
      
      The tags for the launch template.
      - (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 255 Unicode characters.
- NextToken (string) --
  
  The token to use to retrieve the next page of results. This value is null when there are no more results to return.

ModifyVpcEndpointServicePermissions (new)

Link ¶

Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and AWS accounts) to discover your endpoint service.

See also: AWS API Documentation

Request Syntax

client.modify_vpc_endpoint_service_permissions(
    DryRun=True|False,
    ServiceId='string',
    AddAllowedPrincipals=[
        'string',
    ],
    RemoveAllowedPrincipals=[
        'string',
    ]
)

type DryRun

boolean

param DryRun

type ServiceId

string

param ServiceId

[REQUIRED]

The ID of the service.

type AddAllowedPrincipals

list

param AddAllowedPrincipals

One or more Amazon Resource Names (ARNs) of principals for which to allow permission. Specify * to allow all principals.

(string) --

type RemoveAllowedPrincipals

list

param RemoveAllowedPrincipals

One or more Amazon Resource Names (ARNs) of principals for which to remove permission.

(string) --

rtype

dict

returns

Response Syntax

{
    'ReturnValue': True|False
}

Response Structure

(dict) --
- ReturnValue (boolean) --
  
  Returns true if the request succeeds; otherwise, it returns an error.

AttachVolume (updated)

Link ¶
Changes (response)

{'State': {'busy'}}

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide .

For a list of supported device names, see Attaching an EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide .

If a volume has an AWS Marketplace product code:

The volume can be attached only to a stopped instance.
AWS Marketplace product codes are copied from the volume to the instance.
You must be subscribed to the product.
The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For an overview of the AWS Marketplace, see Introducing AWS Marketplace.

For more information about EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.attach_volume(
    Device='string',
    InstanceId='string',
    VolumeId='string',
    DryRun=True|False
)

type Device

string

param Device

[REQUIRED]

The device name (for example, /dev/sdh or xvdh ).

type InstanceId

string

param InstanceId

[REQUIRED]

The ID of the instance.

type VolumeId

string

param VolumeId

[REQUIRED]

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'AttachTime': datetime(2015, 1, 1),
    'Device': 'string',
    'InstanceId': 'string',
    'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
    'VolumeId': 'string',
    'DeleteOnTermination': True|False
}

Response Structure

(dict) --

Describes volume attachment details.
- AttachTime (datetime) --
  
  The time stamp when the attachment initiated.
- Device (string) --
  
  The device name.
- InstanceId (string) --
  
  The ID of the instance.
- State (string) --
  
  The attachment state of the volume.
- VolumeId (string) --
  
  The ID of the volume.
- DeleteOnTermination (boolean) --
  
  Indicates whether the EBS volume is deleted on instance termination.

CreateImage (updated)

Link ¶
Changes (request)

{'BlockDeviceMappings': {'Ebs': {'KmsKeyId': 'string'}}}

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.create_image(
    BlockDeviceMappings=[
        {
            'DeviceName': 'string',
            'VirtualName': 'string',
            'Ebs': {
                'Encrypted': True|False,
                'DeleteOnTermination': True|False,
                'Iops': 123,
                'KmsKeyId': 'string',
                'SnapshotId': 'string',
                'VolumeSize': 123,
                'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
            },
            'NoDevice': 'string'
        },
    ],
    Description='string',
    DryRun=True|False,
    InstanceId='string',
    Name='string',
    NoReboot=True|False
)

type BlockDeviceMappings

list

param BlockDeviceMappings

Information about one or more block device mappings.

(dict) --

Describes a block device mapping.
- DeviceName (string) --
  
  The device name (for example, /dev/sdh or xvdh ).
- VirtualName (string) --
  
  The virtual device name ( ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 .The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
  
  Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
- Ebs (dict) --
  
  Parameters used to automatically set up EBS volumes when the instance is launched.
  - Encrypted (boolean) --
    
    Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. This is because only blank volumes can be encrypted on creation.
  - DeleteOnTermination (boolean) --
    
    Indicates whether the EBS volume is deleted on instance termination.
  - Iops (integer) --
    
    The number of I/O operations per second (IOPS) that the volume supports. For io1 , this represents the number of IOPS that are provisioned for the volume. For gp2 , this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide .
    
    Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
    
    Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2 , st1 , sc1 , or standard volumes.
  - KmsKeyId (string) --
    
    ID for a user-managed CMK under which the EBS volume is encrypted.
    
    Note: This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
  - SnapshotId (string) --
    
    The ID of the snapshot.
  - VolumeSize (integer) --
    
    The size of the volume, in GiB.
    
    Constraints: 1-16384 for General Purpose SSD ( gp2 ), 4-16384 for Provisioned IOPS SSD ( io1 ), 500-16384 for Throughput Optimized HDD ( st1 ), 500-16384 for Cold HDD ( sc1 ), and 1-1024 for Magnetic ( standard ) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
    
    Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
  - VolumeType (string) --
    
    The volume type: gp2 , io1 , st1 , sc1 , or standard .
    
    Default: standard
- NoDevice (string) --
  
  Suppresses the specified device included in the block device mapping of the AMI.

type Description

string

param Description

A description for the new image.

type DryRun

boolean

param DryRun

type InstanceId

string

param InstanceId

[REQUIRED]

The ID of the instance.

type Name

string

param Name

[REQUIRED]

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

type NoReboot

boolean

param NoReboot

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

rtype

dict

returns

Response Syntax

{
    'ImageId': 'string'
}

Response Structure

(dict) --

Contains the output of CreateImage.
- ImageId (string) --
  
  The ID of the new AMI.

CreateVolume (updated)

Link ¶
Changes (response)

{'Attachments': {'State': {'busy'}}}

Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide .

You can tag your volumes during creation. For more information, see Tagging Your Amazon EC2 Resources.

For more information, see Creating an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.create_volume(
    AvailabilityZone='string',
    Encrypted=True|False,
    Iops=123,
    KmsKeyId='string',
    Size=123,
    SnapshotId='string',
    VolumeType='standard'|'io1'|'gp2'|'sc1'|'st1',
    DryRun=True|False,
    TagSpecifications=[
        {
            'ResourceType': 'customer-gateway'|'dhcp-options'|'image'|'instance'|'internet-gateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'snapshot'|'spot-instances-request'|'subnet'|'security-group'|'volume'|'vpc'|'vpn-connection'|'vpn-gateway',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)

type AvailabilityZone

string

param AvailabilityZone

[REQUIRED]

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

type Encrypted

boolean

param Encrypted

Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide .

type Iops

integer

param Iops

Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes

type KmsKeyId

string

param KmsKeyId

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1 :012345678910 :key/abcd1234-a123-456a-a12b-a123b4cd56ef . If a KmsKeyId is specified, the Encrypted flag must also be set.

type Size

integer

param Size

The size of the volume, in GiBs.

Constraints: 1-16384 for gp2 , 4-16384 for io1 , 500-16384 for st1 , 500-16384 for sc1 , and 1-1024 for standard . If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

type SnapshotId

string

param SnapshotId

The snapshot from which to create the volume.

type VolumeType

string

param VolumeType

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: standard

type DryRun

boolean

param DryRun

type TagSpecifications

list

param TagSpecifications

The tags to apply to the volume during creation.

(dict) --

The tags to apply to a resource when the resource is being created.
- ResourceType (string) --
  
  The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume .
- 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 255 Unicode characters.

rtype

dict

returns

Response Syntax

{
    'Attachments': [
        {
            'AttachTime': datetime(2015, 1, 1),
            'Device': 'string',
            'InstanceId': 'string',
            'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
            'VolumeId': 'string',
            'DeleteOnTermination': True|False
        },
    ],
    'AvailabilityZone': 'string',
    'CreateTime': datetime(2015, 1, 1),
    'Encrypted': True|False,
    'KmsKeyId': 'string',
    'Size': 123,
    'SnapshotId': 'string',
    'State': 'creating'|'available'|'in-use'|'deleting'|'deleted'|'error',
    'VolumeId': 'string',
    'Iops': 123,
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
}

Response Structure

(dict) --

Describes a volume.
- Attachments (list) --
  
  Information about the volume attachments.
  - (dict) --
    
    Describes volume attachment details.
    - AttachTime (datetime) --
      
      The time stamp when the attachment initiated.
    - Device (string) --
      
      The device name.
    - InstanceId (string) --
      
      The ID of the instance.
    - State (string) --
      
      The attachment state of the volume.
    - VolumeId (string) --
      
      The ID of the volume.
    - DeleteOnTermination (boolean) --
      
      Indicates whether the EBS volume is deleted on instance termination.
- AvailabilityZone (string) --
  
  The Availability Zone for the volume.
- CreateTime (datetime) --
  
  The time stamp when volume creation was initiated.
- Encrypted (boolean) --
  
  Indicates whether the volume will be encrypted.
- KmsKeyId (string) --
  
  The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
- Size (integer) --
  
  The size of the volume, in GiBs.
- SnapshotId (string) --
  
  The snapshot from which the volume was created, if applicable.
- State (string) --
  
  The volume state.
- VolumeId (string) --
  
  The ID of the volume.
- Iops (integer) --
  
  The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide .
  
  Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
  
  Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2 , st1 , sc1 , or standard volumes.
- Tags (list) --
  
  Any tags assigned to the volume.
  - (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 255 Unicode characters.
- VolumeType (string) --
  
  The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

DescribeImageAttribute (updated)

Link ¶
Changes (response)

{'BlockDeviceMappings': {'Ebs': {'KmsKeyId': 'string'}}}

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

See also: AWS API Documentation

Request Syntax

client.describe_image_attribute(
    Attribute='description'|'kernel'|'ramdisk'|'launchPermission'|'productCodes'|'blockDeviceMapping'|'sriovNetSupport',
    ImageId='string',
    DryRun=True|False
)

type Attribute

string

param Attribute

[REQUIRED]

The AMI attribute.

Note : Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

type ImageId

string

param ImageId

[REQUIRED]

The ID of the AMI.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'BlockDeviceMappings': [
        {
            'DeviceName': 'string',
            'VirtualName': 'string',
            'Ebs': {
                'Encrypted': True|False,
                'DeleteOnTermination': True|False,
                'Iops': 123,
                'KmsKeyId': 'string',
                'SnapshotId': 'string',
                'VolumeSize': 123,
                'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
            },
            'NoDevice': 'string'
        },
    ],
    'ImageId': 'string',
    'LaunchPermissions': [
        {
            'Group': 'all',
            'UserId': 'string'
        },
    ],
    'ProductCodes': [
        {
            'ProductCodeId': 'string',
            'ProductCodeType': 'devpay'|'marketplace'
        },
    ],
    'Description': {
        'Value': 'string'
    },
    'KernelId': {
        'Value': 'string'
    },
    'RamdiskId': {
        'Value': 'string'
    },
    'SriovNetSupport': {
        'Value': 'string'
    }
}

Response Structure

(dict) --

Describes an image attribute.
- BlockDeviceMappings (list) --
  
  One or more block device mapping entries.
  - (dict) --
    
    Describes a block device mapping.
    - DeviceName (string) --
      
      The device name (for example, /dev/sdh or xvdh ).
    - VirtualName (string) --
      
      The virtual device name ( ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 .The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
      
      Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
    - Ebs (dict) --
      
      Parameters used to automatically set up EBS volumes when the instance is launched.
      - Encrypted (boolean) --
        
        Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. This is because only blank volumes can be encrypted on creation.
      - DeleteOnTermination (boolean) --
        
        Indicates whether the EBS volume is deleted on instance termination.
      - Iops (integer) --
        
        The number of I/O operations per second (IOPS) that the volume supports. For io1 , this represents the number of IOPS that are provisioned for the volume. For gp2 , this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide .
        
        Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
        
        Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2 , st1 , sc1 , or standard volumes.
      - KmsKeyId (string) --
        
        ID for a user-managed CMK under which the EBS volume is encrypted.
        
        Note: This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
      - SnapshotId (string) --
        
        The ID of the snapshot.
      - VolumeSize (integer) --
        
        The size of the volume, in GiB.
        
        Constraints: 1-16384 for General Purpose SSD ( gp2 ), 4-16384 for Provisioned IOPS SSD ( io1 ), 500-16384 for Throughput Optimized HDD ( st1 ), 500-16384 for Cold HDD ( sc1 ), and 1-1024 for Magnetic ( standard ) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
        
        Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
      - VolumeType (string) --
        
        The volume type: gp2 , io1 , st1 , sc1 , or standard .
        
        Default: standard
    - NoDevice (string) --
      
      Suppresses the specified device included in the block device mapping of the AMI.
- ImageId (string) --
  
  The ID of the AMI.
- LaunchPermissions (list) --
  
  One or more launch permissions.
  - (dict) --
    
    Describes a launch permission.
    - Group (string) --
      
      The name of the group.
    - UserId (string) --
      
      The AWS account ID.
- ProductCodes (list) --
  
  One or more product codes.
  - (dict) --
    
    Describes a product code.
    - ProductCodeId (string) --
      
      The product code.
    - ProductCodeType (string) --
      
      The type of product code.
- Description (dict) --
  
  A description for the AMI.
  - Value (string) --
    
    The attribute value. Note that the value is case-sensitive.
- KernelId (dict) --
  
  The kernel ID.
  - Value (string) --
    
    The attribute value. Note that the value is case-sensitive.
- RamdiskId (dict) --
  
  The RAM disk ID.
  - Value (string) --
    
    The attribute value. Note that the value is case-sensitive.
- SriovNetSupport (dict) --
  
  Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
  - Value (string) --
    
    The attribute value. Note that the value is case-sensitive.

DescribeImages (updated)

Link ¶
Changes (response)

{'Images': {'BlockDeviceMappings': {'Ebs': {'KmsKeyId': 'string'}}}}

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

Note

Deregistered images are included in the returned results for an unspecified interval after deregistration.

See also: AWS API Documentation

Request Syntax

client.describe_images(
    ExecutableUsers=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    ImageIds=[
        'string',
    ],
    Owners=[
        'string',
    ],
    DryRun=True|False
)

type ExecutableUsers

list

param ExecutableUsers

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

(string) --

type Filters

list

param Filters

One or more filters.

architecture - The image architecture ( i386 | x86_64 ).
block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh ).
block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.
block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of the EBS volume ( gp2 | io1 | st1 | sc1 | standard ).
description - The description of the image (provided during image creation).
ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.
hypervisor - The hypervisor type ( ovm | xen ).
image-id - The ID of the image.
image-type - The image type ( machine | kernel | ramdisk ).
is-public - A Boolean that indicates whether the image is public.
kernel-id - The kernel ID.
manifest-location - The location of the image manifest.
name - The name of the AMI (provided during image creation).
owner-alias - String value from an Amazon-maintained list ( amazon | aws-marketplace | microsoft ) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.
owner-id - The AWS account ID of the image owner.
platform - The platform. To only list Windows-based AMIs, use windows .
product-code - The product code.
product-code.type - The type of the product code ( devpay | marketplace ).
ramdisk-id - The RAM disk ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1 ).
root-device-type - The type of the root device volume ( ebs | instance-store ).
state - The state of the image ( available | pending | failed ).
state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change.
sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.
tag :key =*value* - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag :key =*value* filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
virtualization-type - The virtualization type ( paravirtual | hvm ).

(dict) --

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

type ImageIds

list

param ImageIds

One or more image IDs.

Default: Describes all images available to you.

(string) --

type Owners

list

param Owners

Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace | microsoft ). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

(string) --

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'Images': [
        {
            'Architecture': 'i386'|'x86_64',
            'CreationDate': 'string',
            'ImageId': 'string',
            'ImageLocation': 'string',
            'ImageType': 'machine'|'kernel'|'ramdisk',
            'Public': True|False,
            'KernelId': 'string',
            'OwnerId': 'string',
            'Platform': 'Windows',
            'ProductCodes': [
                {
                    'ProductCodeId': 'string',
                    'ProductCodeType': 'devpay'|'marketplace'
                },
            ],
            'RamdiskId': 'string',
            'State': 'pending'|'available'|'invalid'|'deregistered'|'transient'|'failed'|'error',
            'BlockDeviceMappings': [
                {
                    'DeviceName': 'string',
                    'VirtualName': 'string',
                    'Ebs': {
                        'Encrypted': True|False,
                        'DeleteOnTermination': True|False,
                        'Iops': 123,
                        'KmsKeyId': 'string',
                        'SnapshotId': 'string',
                        'VolumeSize': 123,
                        'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
                    },
                    'NoDevice': 'string'
                },
            ],
            'Description': 'string',
            'EnaSupport': True|False,
            'Hypervisor': 'ovm'|'xen',
            'ImageOwnerAlias': 'string',
            'Name': 'string',
            'RootDeviceName': 'string',
            'RootDeviceType': 'ebs'|'instance-store',
            'SriovNetSupport': 'string',
            'StateReason': {
                'Code': 'string',
                'Message': 'string'
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'VirtualizationType': 'hvm'|'paravirtual'
        },
    ]
}

Response Structure

(dict) --

Contains the output of DescribeImages.
- Images (list) --
  
  Information about one or more images.
  - (dict) --
    
    Describes an image.
    - Architecture (string) --
      
      The architecture of the image.
    - CreationDate (string) --
      
      The date and time the image was created.
    - ImageId (string) --
      
      The ID of the AMI.
    - ImageLocation (string) --
      
      The location of the AMI.
    - ImageType (string) --
      
      The type of image.
    - Public (boolean) --
      
      Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.
    - KernelId (string) --
      
      The kernel associated with the image, if any. Only applicable for machine images.
    - OwnerId (string) --
      
      The AWS account ID of the image owner.
    - Platform (string) --
      
      The value is Windows for Windows AMIs; otherwise blank.
    - ProductCodes (list) --
      
      Any product codes associated with the AMI.
      - (dict) --
        
        Describes a product code.
        
        ProductCodeId (string) --
        
        The product code.
        
        ProductCodeType (string) --
        
        The type of product code.
    - RamdiskId (string) --
      
      The RAM disk associated with the image, if any. Only applicable for machine images.
    - State (string) --
      
      The current state of the AMI. If the state is available , the image is successfully registered and can be used to launch an instance.
    - BlockDeviceMappings (list) --
      
      Any block device mapping entries.
      - (dict) --
        
        Describes a block device mapping.
        
        DeviceName (string) --
        
        The device name (for example, /dev/sdh or xvdh ).
        
        VirtualName (string) --
        
        The virtual device name ( ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 .The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
        
        Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
        
        Ebs (dict) --
        
        Parameters used to automatically set up EBS volumes when the instance is launched.
        
        Encrypted (boolean) --
        
        Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. This is because only blank volumes can be encrypted on creation.
        
        DeleteOnTermination (boolean) --
        
        Indicates whether the EBS volume is deleted on instance termination.
        
        Iops (integer) --
        
        The number of I/O operations per second (IOPS) that the volume supports. For io1 , this represents the number of IOPS that are provisioned for the volume. For gp2 , this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide .
        
        Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
        
        Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2 , st1 , sc1 , or standard volumes.
        
        KmsKeyId (string) --
        
        ID for a user-managed CMK under which the EBS volume is encrypted.
        
        Note: This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
        
        SnapshotId (string) --
        
        The ID of the snapshot.
        
        VolumeSize (integer) --
        
        The size of the volume, in GiB.
        
        Constraints: 1-16384 for General Purpose SSD ( gp2 ), 4-16384 for Provisioned IOPS SSD ( io1 ), 500-16384 for Throughput Optimized HDD ( st1 ), 500-16384 for Cold HDD ( sc1 ), and 1-1024 for Magnetic ( standard ) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
        
        Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
        
        VolumeType (string) --
        
        The volume type: gp2 , io1 , st1 , sc1 , or standard .
        
        Default: standard
        
        NoDevice (string) --
        
        Suppresses the specified device included in the block device mapping of the AMI.
    - Description (string) --
      
      The description of the AMI that was provided during image creation.
    - EnaSupport (boolean) --
      
      Specifies whether enhanced networking with ENA is enabled.
    - Hypervisor (string) --
      
      The hypervisor type of the image.
    - ImageOwnerAlias (string) --
      
      The AWS account alias (for example, amazon , self ) or the AWS account ID of the AMI owner.
    - Name (string) --
      
      The name of the AMI that was provided during image creation.
    - RootDeviceName (string) --
      
      The device name of the root device volume (for example, /dev/sda1 ).
    - RootDeviceType (string) --
      
      The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
    - SriovNetSupport (string) --
      
      Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
    - StateReason (dict) --
      
      The reason for the state change.
      - Code (string) --
        
        The reason code for the state change.
      - Message (string) --
        
        The message for the state change.
        
        Server.InsufficientInstanceCapacity : There was insufficient instance capacity to satisfy the launch request.
        
        Server.InternalError : An internal error occurred during instance launch, resulting in termination.
        
        Server.ScheduledStop : The instance was stopped due to a scheduled retirement.
        
        Server.SpotInstanceTermination : A Spot Instance was terminated due to an increase in the Spot price.
        
        Client.InternalError : A client error caused the instance to terminate on launch.
        
        Client.InstanceInitiatedShutdown : The instance was shut down using the shutdown -h command from the instance.
        
        Client.InstanceTerminated : The instance was terminated or rebooted during AMI creation.
        
        Client.UserInitiatedShutdown : The instance was shut down using the Amazon EC2 API.
        
        Client.VolumeLimitExceeded : The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your limits.
        
        Client.InvalidSnapshot.NotFound : The specified snapshot was not found.
    - Tags (list) --
      
      Any tags assigned to the image.
      - (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 255 Unicode characters.
    - VirtualizationType (string) --
      
      The type of virtualization of the AMI.

DescribeSpotFleetRequests (updated)

Link ¶
Changes (response)

{'SpotFleetRequestConfigs': {'SpotFleetRequestConfig': {'InstanceInterruptionBehavior': {'hibernate'},
                                                        'LaunchSpecifications': {'BlockDeviceMappings': {'Ebs': {'KmsKeyId': 'string'}}},
                                                        'LaunchTemplateConfigs': [{'LaunchTemplateSpecification': {'LaunchTemplateId': 'string',
                                                                                                                   'LaunchTemplateName': 'string',
                                                                                                                   'Version': 'string'},
                                                                                   'Overrides': [{'AvailabilityZone': 'string',
                                                                                                  'InstanceType': 't1.micro '
                                                                                                                  '| '
                                                                                                                  't2.nano '
                                                                                                                  '| '
                                                                                                                  't2.micro '
                                                                                                                  '| '
                                                                                                                  't2.small '
                                                                                                                  '| '
                                                                                                                  't2.medium '
                                                                                                                  '| '
                                                                                                                  't2.large '
                                                                                                                  '| '
                                                                                                                  't2.xlarge '
                                                                                                                  '| '
                                                                                                                  't2.2xlarge '
                                                                                                                  '| '
                                                                                                                  'm1.small '
                                                                                                                  '| '
                                                                                                                  'm1.medium '
                                                                                                                  '| '
                                                                                                                  'm1.large '
                                                                                                                  '| '
                                                                                                                  'm1.xlarge '
                                                                                                                  '| '
                                                                                                                  'm3.medium '
                                                                                                                  '| '
                                                                                                                  'm3.large '
                                                                                                                  '| '
                                                                                                                  'm3.xlarge '
                                                                                                                  '| '
                                                                                                                  'm3.2xlarge '
                                                                                                                  '| '
                                                                                                                  'm4.large '
                                                                                                                  '| '
                                                                                                                  'm4.xlarge '
                                                                                                                  '| '
                                                                                                                  'm4.2xlarge '
                                                                                                                  '| '
                                                                                                                  'm4.4xlarge '
                                                                                                                  '| '
                                                                                                                  'm4.10xlarge '
                                                                                                                  '| '
                                                                                                                  'm4.16xlarge '
                                                                                                                  '| '
                                                                                                                  'm2.xlarge '
                                                                                                                  '| '
                                                                                                                  'm2.2xlarge '
                                                                                                                  '| '
                                                                                                                  'm2.4xlarge '
                                                                                                                  '| '
                                                                                                                  'cr1.8xlarge '
                                                                                                                  '| '
                                                                                                                  'r3.large '
                                                                                                                  '| '
                                                                                                                  'r3.xlarge '
                                                                                                                  '| '
                                                                                                                  'r3.2xlarge '
                                                                                                                  '| '
                                                                                                                  'r3.4xlarge '
                                                                                                                  '| '
                                                                                                                  'r3.8xlarge '
                                                                                                                  '| '
                                                                                                                  'r4.large '
                                                                                                                  '| '
                                                                                                                  'r4.xlarge '
                                                                                                                  '| '
                                                                                                                  'r4.2xlarge '
                                                                                                                  '| '
                                                                                                                  'r4.4xlarge '
                                                                                                                  '| '
                                                                                                                  'r4.8xlarge '
                                                                                                                  '| '
                                                                                                                  'r4.16xlarge '
                                                                                                                  '| '
                                                                                                                  'x1.16xlarge '
                                                                                                                  '| '
                                                                                                                  'x1.32xlarge '
                                                                                                                  '| '
                                                                                                                  'x1e.xlarge '
                                                                                                                  '| '
                                                                                                                  'x1e.2xlarge '
                                                                                                                  '| '
                                                                                                                  'x1e.4xlarge '
                                                                                                                  '| '
                                                                                                                  'x1e.8xlarge '
                                                                                                                  '| '
                                                                                                                  'x1e.16xlarge '
                                                                                                                  '| '
                                                                                                                  'x1e.32xlarge '
                                                                                                                  '| '
                                                                                                                  'i2.xlarge '
                                                                                                                  '| '
                                                                                                                  'i2.2xlarge '
                                                                                                                  '| '
                                                                                                                  'i2.4xlarge '
                                                                                                                  '| '
                                                                                                                  'i2.8xlarge '
                                                                                                                  '| '
                                                                                                                  'i3.large '
                                                                                                                  '| '
                                                                                                                  'i3.xlarge '
                                                                                                                  '| '
                                                                                                                  'i3.2xlarge '
                                                                                                                  '| '
                                                                                                                  'i3.4xlarge '
                                                                                                                  '| '
                                                                                                                  'i3.8xlarge '
                                                                                                                  '| '
                                                                                                                  'i3.16xlarge '
                                                                                                                  '| '
                                                                                                                  'hi1.4xlarge '
                                                                                                                  '| '
                                                                                                                  'hs1.8xlarge '
                                                                                                                  '| '
                                                                                                                  'c1.medium '
                                                                                                                  '| '
                                                                                                                  'c1.xlarge '
                                                                                                                  '| '
                                                                                                                  'c3.large '
                                                                                                                  '| '
                                                                                                                  'c3.xlarge '
                                                                                                                  '| '
                                                                                                                  'c3.2xlarge '
                                                                                                                  '| '
                                                                                                                  'c3.4xlarge '
                                                                                                                  '| '
                                                                                                                  'c3.8xlarge '
                                                                                                                  '| '
                                                                                                                  'c4.large '
                                                                                                                  '| '
                                                                                                                  'c4.xlarge '
                                                                                                                  '| '
                                                                                                                  'c4.2xlarge '
                                                                                                                  '| '
                                                                                                                  'c4.4xlarge '
                                                                                                                  '| '
                                                                                                                  'c4.8xlarge '
                                                                                                                  '| '
                                                                                                                  'c5.large '
                                                                                                                  '| '
                                                                                                                  'c5.xlarge '
                                                                                                                  '| '
                                                                                                                  'c5.2xlarge '
                                                                                                                  '| '
                                                                                                                  'c5.4xlarge '
                                                                                                                  '| '
                                                                                                                  'c5.9xlarge '
                                                                                                                  '| '
                                                                                                                  'c5.18xlarge '
                                                                                                                  '| '
                                                                                                                  'cc1.4xlarge '
                                                                                                                  '| '
                                                                                                                  'cc2.8xlarge '
                                                                                                                  '| '
                                                                                                                  'g2.2xlarge '
                                                                                                                  '| '
                                                                                                                  'g2.8xlarge '
                                                                                                                  '| '
                                                                                                                  'g3.4xlarge '
                                                                                                                  '| '
                                                                                                                  'g3.8xlarge '
                                                                                                                  '| '
                                                                                                                  'g3.16xlarge '
                                                                                                                  '| '
                                                                                                                  'cg1.4xlarge '
                                                                                                                  '| '
                                                                                                                  'p2.xlarge '
                                                                                                                  '| '
                                                                                                                  'p2.8xlarge '
                                                                                                                  '| '
                                                                                                                  'p2.16xlarge '
                                                                                                                  '| '
                                                                                                                  'p3.2xlarge '
                                                                                                                  '| '
                                                                                                                  'p3.8xlarge '
                                                                                                                  '| '
                                                                                                                  'p3.16xlarge '
                                                                                                                  '| '
                                                                                                                  'd2.xlarge '
                                                                                                                  '| '
                                                                                                                  'd2.2xlarge '
                                                                                                                  '| '
                                                                                                                  'd2.4xlarge '
                                                                                                                  '| '
                                                                                                                  'd2.8xlarge '
                                                                                                                  '| '
                                                                                                                  'f1.2xlarge '
                                                                                                                  '| '
                                                                                                                  'f1.16xlarge',
                                                                                                  'SpotPrice': 'string',
                                                                                                  'SubnetId': 'string',
                                                                                                  'WeightedCapacity': 'double'}]}]}}}

Describes your Spot Fleet requests.

Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

See also: AWS API Documentation

Request Syntax

client.describe_spot_fleet_requests(
    DryRun=True|False,
    MaxResults=123,
    NextToken='string',
    SpotFleetRequestIds=[
        'string',
    ]
)

type DryRun

boolean

param DryRun

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

type NextToken

string

param NextToken

The token for the next set of results.

type SpotFleetRequestIds

list

param SpotFleetRequestIds

The IDs of the Spot Fleet requests.

(string) --

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'SpotFleetRequestConfigs': [
        {
            'ActivityStatus': 'error'|'pending_fulfillment'|'pending_termination'|'fulfilled',
            'CreateTime': datetime(2015, 1, 1),
            'SpotFleetRequestConfig': {
                'AllocationStrategy': 'lowestPrice'|'diversified',
                'ClientToken': 'string',
                'ExcessCapacityTerminationPolicy': 'noTermination'|'default',
                'FulfilledCapacity': 123.0,
                'IamFleetRole': 'string',
                'LaunchSpecifications': [
                    {
                        'SecurityGroups': [
                            {
                                'GroupName': 'string',
                                'GroupId': 'string'
                            },
                        ],
                        'AddressingType': 'string',
                        'BlockDeviceMappings': [
                            {
                                'DeviceName': 'string',
                                'VirtualName': 'string',
                                'Ebs': {
                                    'Encrypted': True|False,
                                    'DeleteOnTermination': True|False,
                                    'Iops': 123,
                                    'KmsKeyId': 'string',
                                    'SnapshotId': 'string',
                                    'VolumeSize': 123,
                                    'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
                                },
                                'NoDevice': 'string'
                            },
                        ],
                        'EbsOptimized': True|False,
                        'IamInstanceProfile': {
                            'Arn': 'string',
                            'Name': 'string'
                        },
                        'ImageId': 'string',
                        'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge',
                        'KernelId': 'string',
                        'KeyName': 'string',
                        'Monitoring': {
                            'Enabled': True|False
                        },
                        'NetworkInterfaces': [
                            {
                                'AssociatePublicIpAddress': True|False,
                                'DeleteOnTermination': True|False,
                                'Description': 'string',
                                'DeviceIndex': 123,
                                'Groups': [
                                    'string',
                                ],
                                'Ipv6AddressCount': 123,
                                'Ipv6Addresses': [
                                    {
                                        'Ipv6Address': 'string'
                                    },
                                ],
                                'NetworkInterfaceId': 'string',
                                'PrivateIpAddress': 'string',
                                'PrivateIpAddresses': [
                                    {
                                        'Primary': True|False,
                                        'PrivateIpAddress': 'string'
                                    },
                                ],
                                'SecondaryPrivateIpAddressCount': 123,
                                'SubnetId': 'string'
                            },
                        ],
                        'Placement': {
                            'AvailabilityZone': 'string',
                            'GroupName': 'string',
                            'Tenancy': 'default'|'dedicated'|'host'
                        },
                        'RamdiskId': 'string',
                        'SpotPrice': 'string',
                        'SubnetId': 'string',
                        'UserData': 'string',
                        'WeightedCapacity': 123.0,
                        'TagSpecifications': [
                            {
                                'ResourceType': 'customer-gateway'|'dhcp-options'|'image'|'instance'|'internet-gateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'snapshot'|'spot-instances-request'|'subnet'|'security-group'|'volume'|'vpc'|'vpn-connection'|'vpn-gateway',
                                'Tags': [
                                    {
                                        'Key': 'string',
                                        'Value': 'string'
                                    },
                                ]
                            },
                        ]
                    },
                ],
                'LaunchTemplateConfigs': [
                    {
                        'LaunchTemplateSpecification': {
                            'LaunchTemplateId': 'string',
                            'LaunchTemplateName': 'string',
                            'Version': 'string'
                        },
                        'Overrides': [
                            {
                                'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge',
                                'SpotPrice': 'string',
                                'SubnetId': 'string',
                                'AvailabilityZone': 'string',
                                'WeightedCapacity': 123.0
                            },
                        ]
                    },
                ],
                'SpotPrice': 'string',
                'TargetCapacity': 123,
                'TerminateInstancesWithExpiration': True|False,
                'Type': 'request'|'maintain',
                'ValidFrom': datetime(2015, 1, 1),
                'ValidUntil': datetime(2015, 1, 1),
                'ReplaceUnhealthyInstances': True|False,
                'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate',
                'LoadBalancersConfig': {
                    'ClassicLoadBalancersConfig': {
                        'ClassicLoadBalancers': [
                            {
                                'Name': 'string'
                            },
                        ]
                    },
                    'TargetGroupsConfig': {
                        'TargetGroups': [
                            {
                                'Arn': 'string'
                            },
                        ]
                    }
                }
            },
            'SpotFleetRequestId': 'string',
            'SpotFleetRequestState': 'submitted'|'active'|'cancelled'|'failed'|'cancelled_running'|'cancelled_terminating'|'modifying'
        },
    ]
}

Response Structure

(dict) --

Contains the output of DescribeSpotFleetRequests.
- NextToken (string) --
  
  The token required to retrieve the next set of results. This value is null when there are no more results to return.
- SpotFleetRequestConfigs (list) --
  
  Information about the configuration of your Spot Fleet.
  - (dict) --
    
    Describes a Spot Fleet request.
    - ActivityStatus (string) --
      
      The progress of the Spot Fleet request. If there is an error, the status is error . After all requests are placed, the status is pending_fulfillment . If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled . If the size of the fleet is decreased, the status is pending_termination while Spot Instances are terminating.
    - CreateTime (datetime) --
      
      The creation date and time of the request.
    - SpotFleetRequestConfig (dict) --
      
      The configuration of the Spot Fleet request.
      - AllocationStrategy (string) --
        
        Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice .
      - ClientToken (string) --
        
        A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.
      - ExcessCapacityTerminationPolicy (string) --
        
        Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.
      - FulfilledCapacity (float) --
        
        The number of units fulfilled by this request compared to the set target capacity.
      - IamFleetRole (string) --
        
        Grants the Spot Fleet permission to terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set terminateInstancesWithExpiration .
      - LaunchSpecifications (list) --
        
        The launch specifications for the Spot Fleet request.
        
        (dict) --
        
        Describes the launch specification for one or more Spot Instances.
        
        SecurityGroups (list) --
        
        One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
        
        (dict) --
        
        Describes a security group.
        
        GroupName (string) --
        
        The name of the security group.
        
        GroupId (string) --
        
        The ID of the security group.
        
        AddressingType (string) --
        
        Deprecated.
        
        BlockDeviceMappings (list) --
        
        One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
        
        (dict) --
        
        Describes a block device mapping.
        
        DeviceName (string) --
        
        The device name (for example, /dev/sdh or xvdh ).
        
        VirtualName (string) --
        
        The virtual device name ( ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 .The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
        
        Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
        
        Ebs (dict) --
        
        Parameters used to automatically set up EBS volumes when the instance is launched.
        
        Encrypted (boolean) --
        
        Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. This is because only blank volumes can be encrypted on creation.
        
        DeleteOnTermination (boolean) --
        
        Indicates whether the EBS volume is deleted on instance termination.
        
        Iops (integer) --
        
        The number of I/O operations per second (IOPS) that the volume supports. For io1 , this represents the number of IOPS that are provisioned for the volume. For gp2 , this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide .
        
        Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
        
        Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2 , st1 , sc1 , or standard volumes.
        
        KmsKeyId (string) --
        
        ID for a user-managed CMK under which the EBS volume is encrypted.
        
        Note: This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
        
        SnapshotId (string) --
        
        The ID of the snapshot.
        
        VolumeSize (integer) --
        
        The size of the volume, in GiB.
        
        Constraints: 1-16384 for General Purpose SSD ( gp2 ), 4-16384 for Provisioned IOPS SSD ( io1 ), 500-16384 for Throughput Optimized HDD ( st1 ), 500-16384 for Cold HDD ( sc1 ), and 1-1024 for Magnetic ( standard ) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
        
        Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
        
        VolumeType (string) --
        
        The volume type: gp2 , io1 , st1 , sc1 , or standard .
        
        Default: standard
        
        NoDevice (string) --
        
        Suppresses the specified device included in the block device mapping of the AMI.
        
        EbsOptimized (boolean) --
        
        Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
        
        Default: false
        
        IamInstanceProfile (dict) --
        
        The IAM instance profile.
        
        Arn (string) --
        
        The Amazon Resource Name (ARN) of the instance profile.
        
        Name (string) --
        
        The name of the instance profile.
        
        ImageId (string) --
        
        The ID of the AMI.
        
        InstanceType (string) --
        
        The instance type.
        
        KernelId (string) --
        
        The ID of the kernel.
        
        KeyName (string) --
        
        The name of the key pair.
        
        Monitoring (dict) --
        
        Enable or disable monitoring for the instances.
        
        Enabled (boolean) --
        
        Enables monitoring for the instance.
        
        Default: false
        
        NetworkInterfaces (list) --
        
        One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
        
        (dict) --
        
        Describes a network interface.
        
        AssociatePublicIpAddress (boolean) --
        
        Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
        
        DeleteOnTermination (boolean) --
        
        If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
        
        Description (string) --
        
        The description of the network interface. Applies only if creating a network interface when launching an instance.
        
        DeviceIndex (integer) --
        
        The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.
        
        Groups (list) --
        
        The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
        
        (string) --
        
        Ipv6AddressCount (integer) --
        
        A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
        
        Ipv6Addresses (list) --
        
        One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
        
        (dict) --
        
        Describes an IPv6 address.
        
        Ipv6Address (string) --
        
        The IPv6 address.
        
        NetworkInterfaceId (string) --
        
        The ID of the network interface.
        
        PrivateIpAddress (string) --
        
        The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
        
        PrivateIpAddresses (list) --
        
        One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
        
        (dict) --
        
        Describes a secondary private IPv4 address for a network interface.
        
        Primary (boolean) --
        
        Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
        
        PrivateIpAddress (string) --
        
        The private IPv4 addresses.
        
        SecondaryPrivateIpAddressCount (integer) --
        
        The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
        
        SubnetId (string) --
        
        The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.
        
        Placement (dict) --
        
        The placement information.
        
        AvailabilityZone (string) --
        
        The Availability Zone.
        
        [Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
        
        GroupName (string) --
        
        The name of the placement group (for cluster instances).
        
        Tenancy (string) --
        
        The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
        
        RamdiskId (string) --
        
        The ID of the RAM disk.
        
        SpotPrice (string) --
        
        The maximum price per unit hour that you are willing to pay for a Spot Instance. If this value is not specified, the default is the Spot price specified for the fleet. To determine the Spot price per unit hour, divide the Spot price by the value of WeightedCapacity .
        
        SubnetId (string) --
        
        The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-a61dafcf, subnet-65ea5f08".
        
        UserData (string) --
        
        The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.
        
        WeightedCapacity (float) --
        
        The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).
        
        If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.
        
        TagSpecifications (list) --
        
        The tags to apply during creation.
        
        (dict) --
        
        The tags for a Spot Fleet resource.
        
        ResourceType (string) --
        
        The type of resource. Currently, the only resource type that is supported is instance .
        
        Tags (list) --
        
        The tags.
        
        (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 255 Unicode characters.
      - LaunchTemplateConfigs (list) --
        
        The launch template and overrides.
        
        (dict) --
        
        Describes a launch template and overrides.
        
        LaunchTemplateSpecification (dict) --
        
        The launch template.
        
        LaunchTemplateId (string) --
        
        The ID of the launch template. You must specify either a template ID or a template name.
        
        LaunchTemplateName (string) --
        
        The name of the launch template. You must specify either a template name or a template ID.
        
        Version (string) --
        
        The version number. By default, the default version of the launch template is used.
        
        Overrides (list) --
        
        Any parameters that you specify override the same parameters in the launch template.
        
        (dict) --
        
        Describes overrides for a launch template.
        
        InstanceType (string) --
        
        The instance type.
        
        SpotPrice (string) --
        
        The maximum price per unit hour that you are willing to pay for a Spot Instance.
        
        SubnetId (string) --
        
        The ID of the subnet in which to launch the instances.
        
        AvailabilityZone (string) --
        
        The Availability Zone in which to launch the instances.
        
        WeightedCapacity (float) --
        
        The number of units provided by the specified instance type.
      - SpotPrice (string) --
        
        The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
      - TargetCapacity (integer) --
        
        The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.
      - TerminateInstancesWithExpiration (boolean) --
        
        Indicates whether running Spot Instances should be terminated when the Spot Fleet request expires.
      - Type (string) --
        
        The type of request. Indicates whether the fleet will only request the target capacity or also attempt to maintain it. When you request a certain target capacity, the fleet will only place the required requests. It will not attempt to replenish Spot Instances if capacity is diminished, nor will it submit requests in alternative Spot pools if capacity is not available. When you want to maintain a certain target capacity, fleet will place the required requests to meet this target capacity. It will also automatically replenish any interrupted instances. Default: maintain .
      - ValidFrom (datetime) --
        
        The start date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). The default is to start fulfilling the request immediately.
      - ValidUntil (datetime) --
        
        The end date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). At this point, no new Spot Instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.
      - ReplaceUnhealthyInstances (boolean) --
        
        Indicates whether Spot Fleet should replace unhealthy instances.
      - InstanceInterruptionBehavior (string) --
        
        The behavior when a Spot Instance is interrupted. The default is terminate .
      - LoadBalancersConfig (dict) --
        
        One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
        
        With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
        
        ClassicLoadBalancersConfig (dict) --
        
        The Classic Load Balancers.
        
        ClassicLoadBalancers (list) --
        
        One or more Classic Load Balancers.
        
        (dict) --
        
        Describes a Classic Load Balancer.
        
        Name (string) --
        
        The name of the load balancer.
        
        TargetGroupsConfig (dict) --
        
        The target groups.
        
        TargetGroups (list) --
        
        One or more target groups.
        
        (dict) --
        
        Describes a load balancer target group.
        
        Arn (string) --
        
        The Amazon Resource Name (ARN) of the target group.
    - SpotFleetRequestId (string) --
      
      The ID of the Spot Fleet request.
    - SpotFleetRequestState (string) --
      
      The state of the Spot Fleet request.

DescribeSpotInstanceRequests (updated)

Link ¶
Changes (response)

{'SpotInstanceRequests': {'InstanceInterruptionBehavior': {'hibernate'},
                          'LaunchSpecification': {'BlockDeviceMappings': {'Ebs': {'KmsKeyId': 'string'}}}}}

Describes the Spot Instance requests that belong to your account. Spot Instances are instances that Amazon EC2 launches when the Spot price that you specify exceeds the current Spot price. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide .

You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled , the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot .

Spot Instance requests are deleted 4 hours after they are canceled and their instances are terminated.

See also: AWS API Documentation

Request Syntax

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

type Filters

list

param Filters

One or more filters.

availability-zone-group - The Availability Zone group.
create-time - The time stamp when the Spot Instance request was created.
fault-code - The fault code related to the request.
fault-message - The fault message related to the request.
instance-id - The ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.
launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh ).
launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.
launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic.
launch.group-id - The security group for the instance.
launch.image-id - The ID of the AMI.
launch.instance-type - The type of instance (for example, m3.medium ).
launch.kernel-id - The kernel ID.
launch.key-name - The name of the key pair the instance launched with.
launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.
launch.ramdisk-id - The RAM disk ID.
launched-availability-zone - The Availability Zone in which the request is launched.
network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
network-interface.description - A description of the network interface.
network-interface.device-index - The index of the device for the network interface attachment on the instance.
network-interface.group-id - The ID of the security group associated with the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.private-ip-address - The primary private IP address of the network interface.
network-interface.subnet-id - The ID of the subnet for the instance.
product-description - The product description associated with the instance ( Linux/UNIX | Windows ).
spot-instance-request-id - The Spot Instance request ID.
spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.
state - The state of the Spot Instance request ( open | active | closed | cancelled | failed ). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot Request Status in the Amazon Elastic Compute Cloud User Guide.
status-code - The short code describing the most recent evaluation of your Spot Instance request.
status-message - The message explaining the status of the Spot Instance request.
tag :key =*value* - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag :key =*value* filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
type - The type of Spot Instance request ( one-time | persistent ).
valid-from - The start date of the request.
valid-until - The end date of the request.

(dict) --

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

type DryRun

boolean

param DryRun

type SpotInstanceRequestIds

list

param SpotInstanceRequestIds

One or more Spot Instance request IDs.

(string) --

rtype

dict

returns

Response Syntax

{
    'SpotInstanceRequests': [
        {
            'ActualBlockHourlyPrice': 'string',
            'AvailabilityZoneGroup': 'string',
            'BlockDurationMinutes': 123,
            'CreateTime': datetime(2015, 1, 1),
            'Fault': {
                'Code': 'string',
                'Message': 'string'
            },
            'InstanceId': 'string',
            'LaunchGroup': 'string',
            'LaunchSpecification': {
                'UserData': 'string',
                'SecurityGroups': [
                    {
                        'GroupName': 'string',
                        'GroupId': 'string'
                    },
                ],
                'AddressingType': 'string',
                'BlockDeviceMappings': [
                    {
                        'DeviceName': 'string',
                        'VirtualName': 'string',
                        'Ebs': {
                            'Encrypted': True|False,
                            'DeleteOnTermination': True|False,
                            'Iops': 123,
                            'KmsKeyId': 'string',
                            'SnapshotId': 'string',
                            'VolumeSize': 123,
                            'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
                        },
                        'NoDevice': 'string'
                    },
                ],
                'EbsOptimized': True|False,
                'IamInstanceProfile': {
                    'Arn': 'string',
                    'Name': 'string'
                },
                'ImageId': 'string',
                'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge',
                'KernelId': 'string',
                'KeyName': 'string',
                'NetworkInterfaces': [
                    {
                        'AssociatePublicIpAddress': True|False,
                        'DeleteOnTermination': True|False,
                        'Description': 'string',
                        'DeviceIndex': 123,
                        'Groups': [
                            'string',
                        ],
                        'Ipv6AddressCount': 123,
                        'Ipv6Addresses': [
                            {
                                'Ipv6Address': 'string'
                            },
                        ],
                        'NetworkInterfaceId': 'string',
                        'PrivateIpAddress': 'string',
                        'PrivateIpAddresses': [
                            {
                                'Primary': True|False,
                                'PrivateIpAddress': 'string'
                            },
                        ],
                        'SecondaryPrivateIpAddressCount': 123,
                        'SubnetId': 'string'
                    },
                ],
                'Placement': {
                    'AvailabilityZone': 'string',
                    'GroupName': 'string',
                    'Tenancy': 'default'|'dedicated'|'host'
                },
                'RamdiskId': 'string',
                'SubnetId': 'string',
                'Monitoring': {
                    'Enabled': True|False
                }
            },
            'LaunchedAvailabilityZone': 'string',
            'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
            'SpotInstanceRequestId': 'string',
            'SpotPrice': 'string',
            'State': 'open'|'active'|'closed'|'cancelled'|'failed',
            'Status': {
                'Code': 'string',
                'Message': 'string',
                'UpdateTime': datetime(2015, 1, 1)
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Type': 'one-time'|'persistent',
            'ValidFrom': datetime(2015, 1, 1),
            'ValidUntil': datetime(2015, 1, 1),
            'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
        },
    ]
}

Response Structure

(dict) --

Contains the output of DescribeSpotInstanceRequests.
- SpotInstanceRequests (list) --
  
  One or more Spot Instance requests.
  - (dict) --
    
    Describes a Spot Instance request.
    - ActualBlockHourlyPrice (string) --
      
      If you specified a duration and your Spot Instance request was fulfilled, this is the fixed hourly price in effect for the Spot Instance while it runs.
    - AvailabilityZoneGroup (string) --
      
      The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.
    - BlockDurationMinutes (integer) --
      
      The duration for the Spot Instance, in minutes.
    - CreateTime (datetime) --
      
      The date and time when the Spot Instance request was created, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
    - Fault (dict) --
      
      The fault codes for the Spot Instance request, if any.
      - Code (string) --
        
        The reason code for the Spot Instance state change.
      - Message (string) --
        
        The message for the Spot Instance state change.
    - InstanceId (string) --
      
      The instance ID, if an instance has been launched to fulfill the Spot Instance request.
    - LaunchGroup (string) --
      
      The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
    - LaunchSpecification (dict) --
      
      Additional information for launching instances.
      - UserData (string) --
        
        The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.
      - SecurityGroups (list) --
        
        One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
        
        (dict) --
        
        Describes a security group.
        
        GroupName (string) --
        
        The name of the security group.
        
        GroupId (string) --
        
        The ID of the security group.
      - AddressingType (string) --
        
        Deprecated.
      - BlockDeviceMappings (list) --
        
        One or more block device mapping entries.
        
        (dict) --
        
        Describes a block device mapping.
        
        DeviceName (string) --
        
        The device name (for example, /dev/sdh or xvdh ).
        
        VirtualName (string) --
        
        The virtual device name ( ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 .The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
        
        Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
        
        Ebs (dict) --
        
        Parameters used to automatically set up EBS volumes when the instance is launched.
        
        Encrypted (boolean) --
        
        Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. This is because only blank volumes can be encrypted on creation.
        
        DeleteOnTermination (boolean) --
        
        Indicates whether the EBS volume is deleted on instance termination.
        
        Iops (integer) --
        
        The number of I/O operations per second (IOPS) that the volume supports. For io1 , this represents the number of IOPS that are provisioned for the volume. For gp2 , this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide .
        
        Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
        
        Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2 , st1 , sc1 , or standard volumes.
        
        KmsKeyId (string) --
        
        ID for a user-managed CMK under which the EBS volume is encrypted.
        
        Note: This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
        
        SnapshotId (string) --
        
        The ID of the snapshot.
        
        VolumeSize (integer) --
        
        The size of the volume, in GiB.
        
        Constraints: 1-16384 for General Purpose SSD ( gp2 ), 4-16384 for Provisioned IOPS SSD ( io1 ), 500-16384 for Throughput Optimized HDD ( st1 ), 500-16384 for Cold HDD ( sc1 ), and 1-1024 for Magnetic ( standard ) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
        
        Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
        
        VolumeType (string) --
        
        The volume type: gp2 , io1 , st1 , sc1 , or standard .
        
        Default: standard
        
        NoDevice (string) --
        
        Suppresses the specified device included in the block device mapping of the AMI.
      - EbsOptimized (boolean) --
        
        Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
        
        Default: false
      - IamInstanceProfile (dict) --
        
        The IAM instance profile.
        
        Arn (string) --
        
        The Amazon Resource Name (ARN) of the instance profile.
        
        Name (string) --
        
        The name of the instance profile.
      - ImageId (string) --
        
        The ID of the AMI.
      - InstanceType (string) --
        
        The instance type.
      - KernelId (string) --
        
        The ID of the kernel.
      - KeyName (string) --
        
        The name of the key pair.
      - NetworkInterfaces (list) --
        
        One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
        
        (dict) --
        
        Describes a network interface.
        
        AssociatePublicIpAddress (boolean) --
        
        Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
        
        DeleteOnTermination (boolean) --
        
        If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
        
        Description (string) --
        
        The description of the network interface. Applies only if creating a network interface when launching an instance.
        
        DeviceIndex (integer) --
        
        The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.
        
        Groups (list) --
        
        The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
        
        (string) --
        
        Ipv6AddressCount (integer) --
        
        A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
        
        Ipv6Addresses (list) --
        
        One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
        
        (dict) --
        
        Describes an IPv6 address.
        
        Ipv6Address (string) --
        
        The IPv6 address.
        
        NetworkInterfaceId (string) --
        
        The ID of the network interface.
        
        PrivateIpAddress (string) --
        
        The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
        
        PrivateIpAddresses (list) --
        
        One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
        
        (dict) --
        
        Describes a secondary private IPv4 address for a network interface.
        
        Primary (boolean) --
        
        Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
        
        PrivateIpAddress (string) --
        
        The private IPv4 addresses.
        
        SecondaryPrivateIpAddressCount (integer) --
        
        The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
        
        SubnetId (string) --
        
        The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.
      - Placement (dict) --
        
        The placement information for the instance.
        
        AvailabilityZone (string) --
        
        The Availability Zone.
        
        [Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
        
        GroupName (string) --
        
        The name of the placement group (for cluster instances).
        
        Tenancy (string) --
        
        The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
      - RamdiskId (string) --
        
        The ID of the RAM disk.
      - SubnetId (string) --
        
        The ID of the subnet in which to launch the instance.
      - Monitoring (dict) --
        
        Describes the monitoring of an instance.
        
        Enabled (boolean) --
        
        Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
    - LaunchedAvailabilityZone (string) --
      
      The Availability Zone in which the request is launched.
    - ProductDescription (string) --
      
      The product description associated with the Spot Instance.
    - SpotInstanceRequestId (string) --
      
      The ID of the Spot Instance request.
    - SpotPrice (string) --
      
      The maximum price per hour that you are willing to pay for a Spot Instance.
    - State (string) --
      
      The state of the Spot Instance request. Spot status information can help you track your Spot Instance requests. For more information, see Spot Status in the Amazon Elastic Compute Cloud User Guide .
    - Status (dict) --
      
      The status code and status message describing the Spot Instance request.
      - Code (string) --
        
        The status code. For a list of status codes, see Spot Status Codes in the Amazon Elastic Compute Cloud User Guide .
      - Message (string) --
        
        The description for the status code.
      - UpdateTime (datetime) --
        
        The date and time of the most recent status update, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
    - Tags (list) --
      
      Any tags assigned 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 255 Unicode characters.
    - Type (string) --
      
      The Spot Instance request type.
    - ValidFrom (datetime) --
      
      The start date of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). The request becomes active at this date and time.
    - ValidUntil (datetime) --
      
      The end date of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached. The default end date is 7 days from the current date.
    - InstanceInterruptionBehavior (string) --
      
      The behavior when a Spot Instance is interrupted.

DescribeVolumes (updated)

Link ¶
Changes (response)

{'Volumes': {'Attachments': {'State': {'busy'}}}}

Describes the specified EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.describe_volumes(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    VolumeIds=[
        'string',
    ],
    DryRun=True|False,
    MaxResults=123,
    NextToken='string'
)

type Filters

list

param Filters

One or more filters.

attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name specified in the block device mapping (for example, /dev/sda1 ).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state ( attaching | attached | detaching | detached ).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - The encryption status of the volume.
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The status of the volume ( creating | available | in-use | deleting | deleted | error ).
tag :key =*value* - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag :key =*value* filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

(dict) --

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.
- Name (string) --
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) --
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

type VolumeIds

list

param VolumeIds

One or more volume IDs.

(string) --

type DryRun

boolean

param DryRun

type MaxResults

integer

param MaxResults

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

type NextToken

string

param NextToken

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

rtype

dict

returns

Response Syntax

{
    'Volumes': [
        {
            'Attachments': [
                {
                    'AttachTime': datetime(2015, 1, 1),
                    'Device': 'string',
                    'InstanceId': 'string',
                    'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
                    'VolumeId': 'string',
                    'DeleteOnTermination': True|False
                },
            ],
            'AvailabilityZone': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'Encrypted': True|False,
            'KmsKeyId': 'string',
            'Size': 123,
            'SnapshotId': 'string',
            'State': 'creating'|'available'|'in-use'|'deleting'|'deleted'|'error',
            'VolumeId': 'string',
            'Iops': 123,
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --

Contains the output of DescribeVolumes.
- Volumes (list) --
  
  Information about the volumes.
  - (dict) --
    
    Describes a volume.
    - Attachments (list) --
      
      Information about the volume attachments.
      - (dict) --
        
        Describes volume attachment details.
        
        AttachTime (datetime) --
        
        The time stamp when the attachment initiated.
        
        Device (string) --
        
        The device name.
        
        InstanceId (string) --
        
        The ID of the instance.
        
        State (string) --
        
        The attachment state of the volume.
        
        VolumeId (string) --
        
        The ID of the volume.
        
        DeleteOnTermination (boolean) --
        
        Indicates whether the EBS volume is deleted on instance termination.
    - AvailabilityZone (string) --
      
      The Availability Zone for the volume.
    - CreateTime (datetime) --
      
      The time stamp when volume creation was initiated.
    - Encrypted (boolean) --
      
      Indicates whether the volume will be encrypted.
    - KmsKeyId (string) --
      
      The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
    - Size (integer) --
      
      The size of the volume, in GiBs.
    - SnapshotId (string) --
      
      The snapshot from which the volume was created, if applicable.
    - State (string) --
      
      The volume state.
    - VolumeId (string) --
      
      The ID of the volume.
    - Iops (integer) --
      
      The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide .
      
      Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
      
      Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2 , st1 , sc1 , or standard volumes.
    - Tags (list) --
      
      Any tags assigned to the volume.
      - (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 255 Unicode characters.
    - VolumeType (string) --
      
      The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
- NextToken (string) --
  
  The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults , this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

DetachVolume (updated)

Link ¶
Changes (response)

{'State': {'busy'}}

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.detach_volume(
    Device='string',
    Force=True|False,
    InstanceId='string',
    VolumeId='string',
    DryRun=True|False
)

type Device

string

param Device

The device name.

type Force

boolean

param Force

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

type InstanceId

string

param InstanceId

The ID of the instance.

type VolumeId

string

param VolumeId

[REQUIRED]

The ID of the volume.

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'AttachTime': datetime(2015, 1, 1),
    'Device': 'string',
    'InstanceId': 'string',
    'State': 'attaching'|'attached'|'detaching'|'detached'|'busy',
    'VolumeId': 'string',
    'DeleteOnTermination': True|False
}

Response Structure

(dict) --

Describes volume attachment details.
- AttachTime (datetime) --
  
  The time stamp when the attachment initiated.
- Device (string) --
  
  The device name.
- InstanceId (string) --
  
  The ID of the instance.
- State (string) --
  
  The attachment state of the volume.
- VolumeId (string) --
  
  The ID of the volume.
- DeleteOnTermination (boolean) --
  
  Indicates whether the EBS volume is deleted on instance termination.

RegisterImage (updated)

Link ¶
Changes (request)

{'BlockDeviceMappings': {'Ebs': {'KmsKeyId': 'string'}}}

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide .

Note

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using the block device mapping. For more information, see Launching a Linux Instance from a Backup in the Amazon Elastic Compute Cloud User Guide .

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billing product code associated with an AMI to verify the subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure. To create an AMI that must retain billing codes, see CreateImage.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

See also: AWS API Documentation

Request Syntax

client.register_image(
    ImageLocation='string',
    Architecture='i386'|'x86_64',
    BlockDeviceMappings=[
        {
            'DeviceName': 'string',
            'VirtualName': 'string',
            'Ebs': {
                'Encrypted': True|False,
                'DeleteOnTermination': True|False,
                'Iops': 123,
                'KmsKeyId': 'string',
                'SnapshotId': 'string',
                'VolumeSize': 123,
                'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
            },
            'NoDevice': 'string'
        },
    ],
    Description='string',
    DryRun=True|False,
    EnaSupport=True|False,
    KernelId='string',
    Name='string',
    BillingProducts=[
        'string',
    ],
    RamdiskId='string',
    RootDeviceName='string',
    SriovNetSupport='string',
    VirtualizationType='string'
)

type ImageLocation

string

param ImageLocation

The full path to your AMI manifest in Amazon S3 storage.

type Architecture

string

param Architecture

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386 . For instance store-backed AMIs, the architecture specified in the manifest file.

type BlockDeviceMappings

list

param BlockDeviceMappings

One or more block device mapping entries.

(dict) --

Describes a block device mapping.
- DeviceName (string) --
  
  The device name (for example, /dev/sdh or xvdh ).
- VirtualName (string) --
  
  The virtual device name ( ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 .The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
  
  Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
- Ebs (dict) --
  
  Parameters used to automatically set up EBS volumes when the instance is launched.
  - Encrypted (boolean) --
    
    Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. This is because only blank volumes can be encrypted on creation.
  - DeleteOnTermination (boolean) --
    
    Indicates whether the EBS volume is deleted on instance termination.
  - Iops (integer) --
    
    The number of I/O operations per second (IOPS) that the volume supports. For io1 , this represents the number of IOPS that are provisioned for the volume. For gp2 , this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide .
    
    Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
    
    Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2 , st1 , sc1 , or standard volumes.
  - KmsKeyId (string) --
    
    ID for a user-managed CMK under which the EBS volume is encrypted.
    
    Note: This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
  - SnapshotId (string) --
    
    The ID of the snapshot.
  - VolumeSize (integer) --
    
    The size of the volume, in GiB.
    
    Constraints: 1-16384 for General Purpose SSD ( gp2 ), 4-16384 for Provisioned IOPS SSD ( io1 ), 500-16384 for Throughput Optimized HDD ( st1 ), 500-16384 for Cold HDD ( sc1 ), and 1-1024 for Magnetic ( standard ) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
    
    Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
  - VolumeType (string) --
    
    The volume type: gp2 , io1 , st1 , sc1 , or standard .
    
    Default: standard
- NoDevice (string) --
  
  Suppresses the specified device included in the block device mapping of the AMI.

type Description

string

param Description

A description for your AMI.

type DryRun

boolean

param DryRun

type EnaSupport

boolean

param EnaSupport

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

type KernelId

string

param KernelId

The ID of the kernel.

type Name

string

param Name

[REQUIRED]

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

type BillingProducts

list

param BillingProducts

The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI.

(string) --

type RamdiskId

string

param RamdiskId

The ID of the RAM disk.

type RootDeviceName

string

param RootDeviceName

The device name of the root device volume (for example, /dev/sda1 ).

type SriovNetSupport

string

param SriovNetSupport

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

type VirtualizationType

string

param VirtualizationType

The type of virtualization ( hvm | paravirtual ).

Default: paravirtual

rtype

dict

returns

Response Syntax

{
    'ImageId': 'string'
}

Response Structure

(dict) --

Contains the output of RegisterImage.
- ImageId (string) --
  
  The ID of the newly registered AMI.

RequestSpotFleet (updated)

Link ¶
Changes (request)

{'SpotFleetRequestConfig': {'InstanceInterruptionBehavior': {'hibernate'},
                            'LaunchSpecifications': {'BlockDeviceMappings': {'Ebs': {'KmsKeyId': 'string'}}},
                            'LaunchTemplateConfigs': [{'LaunchTemplateSpecification': {'LaunchTemplateId': 'string',
                                                                                       'LaunchTemplateName': 'string',
                                                                                       'Version': 'string'},
                                                       'Overrides': [{'AvailabilityZone': 'string',
                                                                      'InstanceType': 't1.micro '
                                                                                      '| '
                                                                                      't2.nano '
                                                                                      '| '
                                                                                      't2.micro '
                                                                                      '| '
                                                                                      't2.small '
                                                                                      '| '
                                                                                      't2.medium '
                                                                                      '| '
                                                                                      't2.large '
                                                                                      '| '
                                                                                      't2.xlarge '
                                                                                      '| '
                                                                                      't2.2xlarge '
                                                                                      '| '
                                                                                      'm1.small '
                                                                                      '| '
                                                                                      'm1.medium '
                                                                                      '| '
                                                                                      'm1.large '
                                                                                      '| '
                                                                                      'm1.xlarge '
                                                                                      '| '
                                                                                      'm3.medium '
                                                                                      '| '
                                                                                      'm3.large '
                                                                                      '| '
                                                                                      'm3.xlarge '
                                                                                      '| '
                                                                                      'm3.2xlarge '
                                                                                      '| '
                                                                                      'm4.large '
                                                                                      '| '
                                                                                      'm4.xlarge '
                                                                                      '| '
                                                                                      'm4.2xlarge '
                                                                                      '| '
                                                                                      'm4.4xlarge '
                                                                                      '| '
                                                                                      'm4.10xlarge '
                                                                                      '| '
                                                                                      'm4.16xlarge '
                                                                                      '| '
                                                                                      'm2.xlarge '
                                                                                      '| '
                                                                                      'm2.2xlarge '
                                                                                      '| '
                                                                                      'm2.4xlarge '
                                                                                      '| '
                                                                                      'cr1.8xlarge '
                                                                                      '| '
                                                                                      'r3.large '
                                                                                      '| '
                                                                                      'r3.xlarge '
                                                                                      '| '
                                                                                      'r3.2xlarge '
                                                                                      '| '
                                                                                      'r3.4xlarge '
                                                                                      '| '
                                                                                      'r3.8xlarge '
                                                                                      '| '
                                                                                      'r4.large '
                                                                                      '| '
                                                                                      'r4.xlarge '
                                                                                      '| '
                                                                                      'r4.2xlarge '
                                                                                      '| '
                                                                                      'r4.4xlarge '
                                                                                      '| '
                                                                                      'r4.8xlarge '
                                                                                      '| '
                                                                                      'r4.16xlarge '
                                                                                      '| '
                                                                                      'x1.16xlarge '
                                                                                      '| '
                                                                                      'x1.32xlarge '
                                                                                      '| '
                                                                                      'x1e.xlarge '
                                                                                      '| '
                                                                                      'x1e.2xlarge '
                                                                                      '| '
                                                                                      'x1e.4xlarge '
                                                                                      '| '
                                                                                      'x1e.8xlarge '
                                                                                      '| '
                                                                                      'x1e.16xlarge '
                                                                                      '| '
                                                                                      'x1e.32xlarge '
                                                                                      '| '
                                                                                      'i2.xlarge '
                                                                                      '| '
                                                                                      'i2.2xlarge '
                                                                                      '| '
                                                                                      'i2.4xlarge '
                                                                                      '| '
                                                                                      'i2.8xlarge '
                                                                                      '| '
                                                                                      'i3.large '
                                                                                      '| '
                                                                                      'i3.xlarge '
                                                                                      '| '
                                                                                      'i3.2xlarge '
                                                                                      '| '
                                                                                      'i3.4xlarge '
                                                                                      '| '
                                                                                      'i3.8xlarge '
                                                                                      '| '
                                                                                      'i3.16xlarge '
                                                                                      '| '
                                                                                      'hi1.4xlarge '
                                                                                      '| '
                                                                                      'hs1.8xlarge '
                                                                                      '| '
                                                                                      'c1.medium '
                                                                                      '| '
                                                                                      'c1.xlarge '
                                                                                      '| '
                                                                                      'c3.large '
                                                                                      '| '
                                                                                      'c3.xlarge '
                                                                                      '| '
                                                                                      'c3.2xlarge '
                                                                                      '| '
                                                                                      'c3.4xlarge '
                                                                                      '| '
                                                                                      'c3.8xlarge '
                                                                                      '| '
                                                                                      'c4.large '
                                                                                      '| '
                                                                                      'c4.xlarge '
                                                                                      '| '
                                                                                      'c4.2xlarge '
                                                                                      '| '
                                                                                      'c4.4xlarge '
                                                                                      '| '
                                                                                      'c4.8xlarge '
                                                                                      '| '
                                                                                      'c5.large '
                                                                                      '| '
                                                                                      'c5.xlarge '
                                                                                      '| '
                                                                                      'c5.2xlarge '
                                                                                      '| '
                                                                                      'c5.4xlarge '
                                                                                      '| '
                                                                                      'c5.9xlarge '
                                                                                      '| '
                                                                                      'c5.18xlarge '
                                                                                      '| '
                                                                                      'cc1.4xlarge '
                                                                                      '| '
                                                                                      'cc2.8xlarge '
                                                                                      '| '
                                                                                      'g2.2xlarge '
                                                                                      '| '
                                                                                      'g2.8xlarge '
                                                                                      '| '
                                                                                      'g3.4xlarge '
                                                                                      '| '
                                                                                      'g3.8xlarge '
                                                                                      '| '
                                                                                      'g3.16xlarge '
                                                                                      '| '
                                                                                      'cg1.4xlarge '
                                                                                      '| '
                                                                                      'p2.xlarge '
                                                                                      '| '
                                                                                      'p2.8xlarge '
                                                                                      '| '
                                                                                      'p2.16xlarge '
                                                                                      '| '
                                                                                      'p3.2xlarge '
                                                                                      '| '
                                                                                      'p3.8xlarge '
                                                                                      '| '
                                                                                      'p3.16xlarge '
                                                                                      '| '
                                                                                      'd2.xlarge '
                                                                                      '| '
                                                                                      'd2.2xlarge '
                                                                                      '| '
                                                                                      'd2.4xlarge '
                                                                                      '| '
                                                                                      'd2.8xlarge '
                                                                                      '| '
                                                                                      'f1.2xlarge '
                                                                                      '| '
                                                                                      'f1.16xlarge',
                                                                      'SpotPrice': 'string',
                                                                      'SubnetId': 'string',
                                                                      'WeightedCapacity': 'double'}]}]}}

Creates a Spot Fleet request.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot Fleet requests Spot Instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.

You can specify tags for the Spot Instances. You cannot tag other resource types in a Spot Fleet request; only the instance resource type is supported.

For more information, see Spot Fleet Requests in the Amazon Elastic Compute Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.request_spot_fleet(
    DryRun=True|False,
    SpotFleetRequestConfig={
        'AllocationStrategy': 'lowestPrice'|'diversified',
        'ClientToken': 'string',
        'ExcessCapacityTerminationPolicy': 'noTermination'|'default',
        'FulfilledCapacity': 123.0,
        'IamFleetRole': 'string',
        'LaunchSpecifications': [
            {
                'SecurityGroups': [
                    {
                        'GroupName': 'string',
                        'GroupId': 'string'
                    },
                ],
                'AddressingType': 'string',
                'BlockDeviceMappings': [
                    {
                        'DeviceName': 'string',
                        'VirtualName': 'string',
                        'Ebs': {
                            'Encrypted': True|False,
                            'DeleteOnTermination': True|False,
                            'Iops': 123,
                            'KmsKeyId': 'string',
                            'SnapshotId': 'string',
                            'VolumeSize': 123,
                            'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
                        },
                        'NoDevice': 'string'
                    },
                ],
                'EbsOptimized': True|False,
                'IamInstanceProfile': {
                    'Arn': 'string',
                    'Name': 'string'
                },
                'ImageId': 'string',
                'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge',
                'KernelId': 'string',
                'KeyName': 'string',
                'Monitoring': {
                    'Enabled': True|False
                },
                'NetworkInterfaces': [
                    {
                        'AssociatePublicIpAddress': True|False,
                        'DeleteOnTermination': True|False,
                        'Description': 'string',
                        'DeviceIndex': 123,
                        'Groups': [
                            'string',
                        ],
                        'Ipv6AddressCount': 123,
                        'Ipv6Addresses': [
                            {
                                'Ipv6Address': 'string'
                            },
                        ],
                        'NetworkInterfaceId': 'string',
                        'PrivateIpAddress': 'string',
                        'PrivateIpAddresses': [
                            {
                                'Primary': True|False,
                                'PrivateIpAddress': 'string'
                            },
                        ],
                        'SecondaryPrivateIpAddressCount': 123,
                        'SubnetId': 'string'
                    },
                ],
                'Placement': {
                    'AvailabilityZone': 'string',
                    'GroupName': 'string',
                    'Tenancy': 'default'|'dedicated'|'host'
                },
                'RamdiskId': 'string',
                'SpotPrice': 'string',
                'SubnetId': 'string',
                'UserData': 'string',
                'WeightedCapacity': 123.0,
                'TagSpecifications': [
                    {
                        'ResourceType': 'customer-gateway'|'dhcp-options'|'image'|'instance'|'internet-gateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'snapshot'|'spot-instances-request'|'subnet'|'security-group'|'volume'|'vpc'|'vpn-connection'|'vpn-gateway',
                        'Tags': [
                            {
                                'Key': 'string',
                                'Value': 'string'
                            },
                        ]
                    },
                ]
            },
        ],
        'LaunchTemplateConfigs': [
            {
                'LaunchTemplateSpecification': {
                    'LaunchTemplateId': 'string',
                    'LaunchTemplateName': 'string',
                    'Version': 'string'
                },
                'Overrides': [
                    {
                        'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge',
                        'SpotPrice': 'string',
                        'SubnetId': 'string',
                        'AvailabilityZone': 'string',
                        'WeightedCapacity': 123.0
                    },
                ]
            },
        ],
        'SpotPrice': 'string',
        'TargetCapacity': 123,
        'TerminateInstancesWithExpiration': True|False,
        'Type': 'request'|'maintain',
        'ValidFrom': datetime(2015, 1, 1),
        'ValidUntil': datetime(2015, 1, 1),
        'ReplaceUnhealthyInstances': True|False,
        'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate',
        'LoadBalancersConfig': {
            'ClassicLoadBalancersConfig': {
                'ClassicLoadBalancers': [
                    {
                        'Name': 'string'
                    },
                ]
            },
            'TargetGroupsConfig': {
                'TargetGroups': [
                    {
                        'Arn': 'string'
                    },
                ]
            }
        }
    }
)

type DryRun

boolean

param DryRun

type SpotFleetRequestConfig

dict

param SpotFleetRequestConfig

[REQUIRED]

The configuration for the Spot Fleet request.

AllocationStrategy (string) --

Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice .
ClientToken (string) --

A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.
ExcessCapacityTerminationPolicy (string) --

Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.
FulfilledCapacity (float) --

The number of units fulfilled by this request compared to the set target capacity.
IamFleetRole (string) -- [REQUIRED]

Grants the Spot Fleet permission to terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set terminateInstancesWithExpiration .
LaunchSpecifications (list) --

The launch specifications for the Spot Fleet request.
- (dict) --
  
  Describes the launch specification for one or more Spot Instances.
  - SecurityGroups (list) --
    
    One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
    - (dict) --
      
      Describes a security group.
      - GroupName (string) --
        
        The name of the security group.
      - GroupId (string) --
        
        The ID of the security group.
  - AddressingType (string) --
    
    Deprecated.
  - BlockDeviceMappings (list) --
    
    One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
    - (dict) --
      
      Describes a block device mapping.
      - DeviceName (string) --
        
        The device name (for example, /dev/sdh or xvdh ).
      - VirtualName (string) --
        
        The virtual device name ( ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 .The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
        
        Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
      - Ebs (dict) --
        
        Parameters used to automatically set up EBS volumes when the instance is launched.
        
        Encrypted (boolean) --
        
        Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. This is because only blank volumes can be encrypted on creation.
        
        DeleteOnTermination (boolean) --
        
        Indicates whether the EBS volume is deleted on instance termination.
        
        Iops (integer) --
        
        The number of I/O operations per second (IOPS) that the volume supports. For io1 , this represents the number of IOPS that are provisioned for the volume. For gp2 , this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide .
        
        Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
        
        Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2 , st1 , sc1 , or standard volumes.
        
        KmsKeyId (string) --
        
        ID for a user-managed CMK under which the EBS volume is encrypted.
        
        Note: This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
        
        SnapshotId (string) --
        
        The ID of the snapshot.
        
        VolumeSize (integer) --
        
        The size of the volume, in GiB.
        
        Constraints: 1-16384 for General Purpose SSD ( gp2 ), 4-16384 for Provisioned IOPS SSD ( io1 ), 500-16384 for Throughput Optimized HDD ( st1 ), 500-16384 for Cold HDD ( sc1 ), and 1-1024 for Magnetic ( standard ) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
        
        Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
        
        VolumeType (string) --
        
        The volume type: gp2 , io1 , st1 , sc1 , or standard .
        
        Default: standard
      - NoDevice (string) --
        
        Suppresses the specified device included in the block device mapping of the AMI.
  - EbsOptimized (boolean) --
    
    Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
    
    Default: false
  - IamInstanceProfile (dict) --
    
    The IAM instance profile.
    - Arn (string) --
      
      The Amazon Resource Name (ARN) of the instance profile.
    - Name (string) --
      
      The name of the instance profile.
  - ImageId (string) --
    
    The ID of the AMI.
  - InstanceType (string) --
    
    The instance type.
  - KernelId (string) --
    
    The ID of the kernel.
  - KeyName (string) --
    
    The name of the key pair.
  - Monitoring (dict) --
    
    Enable or disable monitoring for the instances.
    - Enabled (boolean) --
      
      Enables monitoring for the instance.
      
      Default: false
  - NetworkInterfaces (list) --
    
    One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
    - (dict) --
      
      Describes a network interface.
      - AssociatePublicIpAddress (boolean) --
        
        Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
      - DeleteOnTermination (boolean) --
        
        If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
      - Description (string) --
        
        The description of the network interface. Applies only if creating a network interface when launching an instance.
      - DeviceIndex (integer) --
        
        The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.
      - Groups (list) --
        
        The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
        
        (string) --
      - Ipv6AddressCount (integer) --
        
        A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
      - Ipv6Addresses (list) --
        
        One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
        
        (dict) --
        
        Describes an IPv6 address.
        
        Ipv6Address (string) --
        
        The IPv6 address.
      - NetworkInterfaceId (string) --
        
        The ID of the network interface.
      - PrivateIpAddress (string) --
        
        The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
      - PrivateIpAddresses (list) --
        
        One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
        
        (dict) --
        
        Describes a secondary private IPv4 address for a network interface.
        
        Primary (boolean) --
        
        Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
        
        PrivateIpAddress (string) -- [REQUIRED]
        
        The private IPv4 addresses.
      - SecondaryPrivateIpAddressCount (integer) --
        
        The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
      - SubnetId (string) --
        
        The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.
  - Placement (dict) --
    
    The placement information.
    - AvailabilityZone (string) --
      
      The Availability Zone.
      
      [Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
    - GroupName (string) --
      
      The name of the placement group (for cluster instances).
    - Tenancy (string) --
      
      The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
  - RamdiskId (string) --
    
    The ID of the RAM disk.
  - SpotPrice (string) --
    
    The maximum price per unit hour that you are willing to pay for a Spot Instance. If this value is not specified, the default is the Spot price specified for the fleet. To determine the Spot price per unit hour, divide the Spot price by the value of WeightedCapacity .
  - SubnetId (string) --
    
    The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-a61dafcf, subnet-65ea5f08".
  - UserData (string) --
    
    The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.
  - WeightedCapacity (float) --
    
    The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).
    
    If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.
  - TagSpecifications (list) --
    
    The tags to apply during creation.
    - (dict) --
      
      The tags for a Spot Fleet resource.
      - ResourceType (string) --
        
        The type of resource. Currently, the only resource type that is supported is instance .
      - Tags (list) --
        
        The tags.
        
        (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 255 Unicode characters.
LaunchTemplateConfigs (list) --

The launch template and overrides.
- (dict) --
  
  Describes a launch template and overrides.
  - LaunchTemplateSpecification (dict) --
    
    The launch template.
    - LaunchTemplateId (string) --
      
      The ID of the launch template. You must specify either a template ID or a template name.
    - LaunchTemplateName (string) --
      
      The name of the launch template. You must specify either a template name or a template ID.
    - Version (string) --
      
      The version number. By default, the default version of the launch template is used.
  - Overrides (list) --
    
    Any parameters that you specify override the same parameters in the launch template.
    - (dict) --
      
      Describes overrides for a launch template.
      - InstanceType (string) --
        
        The instance type.
      - SpotPrice (string) --
        
        The maximum price per unit hour that you are willing to pay for a Spot Instance.
      - SubnetId (string) --
        
        The ID of the subnet in which to launch the instances.
      - AvailabilityZone (string) --
        
        The Availability Zone in which to launch the instances.
      - WeightedCapacity (float) --
        
        The number of units provided by the specified instance type.
SpotPrice (string) --

The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
TargetCapacity (integer) -- [REQUIRED]

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain , you can specify a target capacity of 0 and add capacity later.
TerminateInstancesWithExpiration (boolean) --

Indicates whether running Spot Instances should be terminated when the Spot Fleet request expires.
Type (string) --

The type of request. Indicates whether the fleet will only request the target capacity or also attempt to maintain it. When you request a certain target capacity, the fleet will only place the required requests. It will not attempt to replenish Spot Instances if capacity is diminished, nor will it submit requests in alternative Spot pools if capacity is not available. When you want to maintain a certain target capacity, fleet will place the required requests to meet this target capacity. It will also automatically replenish any interrupted instances. Default: maintain .
ValidFrom (datetime) --

The start date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). The default is to start fulfilling the request immediately.
ValidUntil (datetime) --

The end date and time of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). At this point, no new Spot Instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.
ReplaceUnhealthyInstances (boolean) --

Indicates whether Spot Fleet should replace unhealthy instances.
InstanceInterruptionBehavior (string) --

The behavior when a Spot Instance is interrupted. The default is terminate .
LoadBalancersConfig (dict) --

One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.

With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
- ClassicLoadBalancersConfig (dict) --
  
  The Classic Load Balancers.
  - ClassicLoadBalancers (list) -- [REQUIRED]
    
    One or more Classic Load Balancers.
    - (dict) --
      
      Describes a Classic Load Balancer.
      - Name (string) -- [REQUIRED]
        
        The name of the load balancer.
- TargetGroupsConfig (dict) --
  
  The target groups.
  - TargetGroups (list) -- [REQUIRED]
    
    One or more target groups.
    - (dict) --
      
      Describes a load balancer target group.
      - Arn (string) -- [REQUIRED]
        
        The Amazon Resource Name (ARN) of the target group.

rtype

dict

returns

Response Syntax

{
    'SpotFleetRequestId': 'string'
}

Response Structure

(dict) --

Contains the output of RequestSpotFleet.
- SpotFleetRequestId (string) --
  
  The ID of the Spot Fleet request.

RequestSpotInstances (updated)

Link ¶
Changes (request, response)
Request

{'InstanceInterruptionBehavior': {'hibernate'},
 'LaunchSpecification': {'BlockDeviceMappings': {'Ebs': {'KmsKeyId': 'string'}}}}

Response

{'SpotInstanceRequests': {'InstanceInterruptionBehavior': {'hibernate'},
                          'LaunchSpecification': {'BlockDeviceMappings': {'Ebs': {'KmsKeyId': 'string'}}}}}

Creates a Spot Instance request. Spot Instances are instances that Amazon EC2 launches when the maximum price that you specify exceeds the current Spot price. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.request_spot_instances(
    AvailabilityZoneGroup='string',
    BlockDurationMinutes=123,
    ClientToken='string',
    DryRun=True|False,
    InstanceCount=123,
    LaunchGroup='string',
    LaunchSpecification={
        'SecurityGroupIds': [
            'string',
        ],
        'SecurityGroups': [
            'string',
        ],
        'AddressingType': 'string',
        'BlockDeviceMappings': [
            {
                'DeviceName': 'string',
                'VirtualName': 'string',
                'Ebs': {
                    'Encrypted': True|False,
                    'DeleteOnTermination': True|False,
                    'Iops': 123,
                    'KmsKeyId': 'string',
                    'SnapshotId': 'string',
                    'VolumeSize': 123,
                    'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
                },
                'NoDevice': 'string'
            },
        ],
        'EbsOptimized': True|False,
        'IamInstanceProfile': {
            'Arn': 'string',
            'Name': 'string'
        },
        'ImageId': 'string',
        'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge',
        'KernelId': 'string',
        'KeyName': 'string',
        'Monitoring': {
            'Enabled': True|False
        },
        'NetworkInterfaces': [
            {
                'AssociatePublicIpAddress': True|False,
                'DeleteOnTermination': True|False,
                'Description': 'string',
                'DeviceIndex': 123,
                'Groups': [
                    'string',
                ],
                'Ipv6AddressCount': 123,
                'Ipv6Addresses': [
                    {
                        'Ipv6Address': 'string'
                    },
                ],
                'NetworkInterfaceId': 'string',
                'PrivateIpAddress': 'string',
                'PrivateIpAddresses': [
                    {
                        'Primary': True|False,
                        'PrivateIpAddress': 'string'
                    },
                ],
                'SecondaryPrivateIpAddressCount': 123,
                'SubnetId': 'string'
            },
        ],
        'Placement': {
            'AvailabilityZone': 'string',
            'GroupName': 'string',
            'Tenancy': 'default'|'dedicated'|'host'
        },
        'RamdiskId': 'string',
        'SubnetId': 'string',
        'UserData': 'string'
    },
    SpotPrice='string',
    Type='one-time'|'persistent',
    ValidFrom=datetime(2015, 1, 1),
    ValidUntil=datetime(2015, 1, 1),
    InstanceInterruptionBehavior='hibernate'|'stop'|'terminate'
)

type AvailabilityZoneGroup

string

param AvailabilityZoneGroup

The user-specified name for a logical grouping of requests.

When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

type BlockDurationMinutes

integer

param BlockDurationMinutes

The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

The duration period starts as soon as your Spot Instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.

Note that you can't specify an Availability Zone group or a launch group if you specify a duration.

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide .

type DryRun

boolean

param DryRun

type InstanceCount

integer

param InstanceCount

The maximum number of Spot Instances to launch.

Default: 1

type LaunchGroup

string

param LaunchGroup

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

type LaunchSpecification

dict

param LaunchSpecification

The launch specification.

SecurityGroupIds (list) --

One or more security group IDs.
- (string) --
SecurityGroups (list) --

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
- (string) --
AddressingType (string) --

Deprecated.
BlockDeviceMappings (list) --

One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
- (dict) --
  
  Describes a block device mapping.
  - DeviceName (string) --
    
    The device name (for example, /dev/sdh or xvdh ).
  - VirtualName (string) --
    
    The virtual device name ( ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 .The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
    
    Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
  - Ebs (dict) --
    
    Parameters used to automatically set up EBS volumes when the instance is launched.
    - Encrypted (boolean) --
      
      Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. This is because only blank volumes can be encrypted on creation.
    - DeleteOnTermination (boolean) --
      
      Indicates whether the EBS volume is deleted on instance termination.
    - Iops (integer) --
      
      The number of I/O operations per second (IOPS) that the volume supports. For io1 , this represents the number of IOPS that are provisioned for the volume. For gp2 , this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide .
      
      Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
      
      Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2 , st1 , sc1 , or standard volumes.
    - KmsKeyId (string) --
      
      ID for a user-managed CMK under which the EBS volume is encrypted.
      
      Note: This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
    - SnapshotId (string) --
      
      The ID of the snapshot.
    - VolumeSize (integer) --
      
      The size of the volume, in GiB.
      
      Constraints: 1-16384 for General Purpose SSD ( gp2 ), 4-16384 for Provisioned IOPS SSD ( io1 ), 500-16384 for Throughput Optimized HDD ( st1 ), 500-16384 for Cold HDD ( sc1 ), and 1-1024 for Magnetic ( standard ) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
      
      Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
    - VolumeType (string) --
      
      The volume type: gp2 , io1 , st1 , sc1 , or standard .
      
      Default: standard
  - NoDevice (string) --
    
    Suppresses the specified device included in the block device mapping of the AMI.
EbsOptimized (boolean) --

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false
IamInstanceProfile (dict) --

The IAM instance profile.
- Arn (string) --
  
  The Amazon Resource Name (ARN) of the instance profile.
- Name (string) --
  
  The name of the instance profile.
ImageId (string) --

The ID of the AMI.
InstanceType (string) --

The instance type.
KernelId (string) --

The ID of the kernel.
KeyName (string) --

The name of the key pair.
Monitoring (dict) --

Indicates whether basic or detailed monitoring is enabled for the instance.

Default: Disabled
- Enabled (boolean) -- [REQUIRED]
  
  Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
NetworkInterfaces (list) --

One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
- (dict) --
  
  Describes a network interface.
  - AssociatePublicIpAddress (boolean) --
    
    Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
  - DeleteOnTermination (boolean) --
    
    If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
  - Description (string) --
    
    The description of the network interface. Applies only if creating a network interface when launching an instance.
  - DeviceIndex (integer) --
    
    The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.
  - Groups (list) --
    
    The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
    - (string) --
  - Ipv6AddressCount (integer) --
    
    A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
  - Ipv6Addresses (list) --
    
    One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
    - (dict) --
      
      Describes an IPv6 address.
      - Ipv6Address (string) --
        
        The IPv6 address.
  - NetworkInterfaceId (string) --
    
    The ID of the network interface.
  - PrivateIpAddress (string) --
    
    The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
  - PrivateIpAddresses (list) --
    
    One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
    - (dict) --
      
      Describes a secondary private IPv4 address for a network interface.
      - Primary (boolean) --
        
        Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
      - PrivateIpAddress (string) -- [REQUIRED]
        
        The private IPv4 addresses.
  - SecondaryPrivateIpAddressCount (integer) --
    
    The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
  - SubnetId (string) --
    
    The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.
Placement (dict) --

The placement information for the instance.
- AvailabilityZone (string) --
  
  The Availability Zone.
  
  [Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
- GroupName (string) --
  
  The name of the placement group (for cluster instances).
- Tenancy (string) --
  
  The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
RamdiskId (string) --

The ID of the RAM disk.
SubnetId (string) --

The ID of the subnet in which to launch the instance.
UserData (string) --

The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

type SpotPrice

string

param SpotPrice

The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

type Type

string

param Type

The Spot Instance request type.

Default: one-time

type ValidFrom

datetime

param ValidFrom

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

type ValidUntil

datetime

param ValidUntil

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached. The default end date is 7 days from the current date.

type InstanceInterruptionBehavior

string

param InstanceInterruptionBehavior

The behavior when a Spot Instance is interrupted. The default is terminate .

rtype

dict

returns

Response Syntax

{
    'SpotInstanceRequests': [
        {
            'ActualBlockHourlyPrice': 'string',
            'AvailabilityZoneGroup': 'string',
            'BlockDurationMinutes': 123,
            'CreateTime': datetime(2015, 1, 1),
            'Fault': {
                'Code': 'string',
                'Message': 'string'
            },
            'InstanceId': 'string',
            'LaunchGroup': 'string',
            'LaunchSpecification': {
                'UserData': 'string',
                'SecurityGroups': [
                    {
                        'GroupName': 'string',
                        'GroupId': 'string'
                    },
                ],
                'AddressingType': 'string',
                'BlockDeviceMappings': [
                    {
                        'DeviceName': 'string',
                        'VirtualName': 'string',
                        'Ebs': {
                            'Encrypted': True|False,
                            'DeleteOnTermination': True|False,
                            'Iops': 123,
                            'KmsKeyId': 'string',
                            'SnapshotId': 'string',
                            'VolumeSize': 123,
                            'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
                        },
                        'NoDevice': 'string'
                    },
                ],
                'EbsOptimized': True|False,
                'IamInstanceProfile': {
                    'Arn': 'string',
                    'Name': 'string'
                },
                'ImageId': 'string',
                'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge',
                'KernelId': 'string',
                'KeyName': 'string',
                'NetworkInterfaces': [
                    {
                        'AssociatePublicIpAddress': True|False,
                        'DeleteOnTermination': True|False,
                        'Description': 'string',
                        'DeviceIndex': 123,
                        'Groups': [
                            'string',
                        ],
                        'Ipv6AddressCount': 123,
                        'Ipv6Addresses': [
                            {
                                'Ipv6Address': 'string'
                            },
                        ],
                        'NetworkInterfaceId': 'string',
                        'PrivateIpAddress': 'string',
                        'PrivateIpAddresses': [
                            {
                                'Primary': True|False,
                                'PrivateIpAddress': 'string'
                            },
                        ],
                        'SecondaryPrivateIpAddressCount': 123,
                        'SubnetId': 'string'
                    },
                ],
                'Placement': {
                    'AvailabilityZone': 'string',
                    'GroupName': 'string',
                    'Tenancy': 'default'|'dedicated'|'host'
                },
                'RamdiskId': 'string',
                'SubnetId': 'string',
                'Monitoring': {
                    'Enabled': True|False
                }
            },
            'LaunchedAvailabilityZone': 'string',
            'ProductDescription': 'Linux/UNIX'|'Linux/UNIX (Amazon VPC)'|'Windows'|'Windows (Amazon VPC)',
            'SpotInstanceRequestId': 'string',
            'SpotPrice': 'string',
            'State': 'open'|'active'|'closed'|'cancelled'|'failed',
            'Status': {
                'Code': 'string',
                'Message': 'string',
                'UpdateTime': datetime(2015, 1, 1)
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'Type': 'one-time'|'persistent',
            'ValidFrom': datetime(2015, 1, 1),
            'ValidUntil': datetime(2015, 1, 1),
            'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
        },
    ]
}

Response Structure

(dict) --

Contains the output of RequestSpotInstances.
- SpotInstanceRequests (list) --
  
  One or more Spot Instance requests.
  - (dict) --
    
    Describes a Spot Instance request.
    - ActualBlockHourlyPrice (string) --
      
      If you specified a duration and your Spot Instance request was fulfilled, this is the fixed hourly price in effect for the Spot Instance while it runs.
    - AvailabilityZoneGroup (string) --
      
      The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.
    - BlockDurationMinutes (integer) --
      
      The duration for the Spot Instance, in minutes.
    - CreateTime (datetime) --
      
      The date and time when the Spot Instance request was created, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
    - Fault (dict) --
      
      The fault codes for the Spot Instance request, if any.
      - Code (string) --
        
        The reason code for the Spot Instance state change.
      - Message (string) --
        
        The message for the Spot Instance state change.
    - InstanceId (string) --
      
      The instance ID, if an instance has been launched to fulfill the Spot Instance request.
    - LaunchGroup (string) --
      
      The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
    - LaunchSpecification (dict) --
      
      Additional information for launching instances.
      - UserData (string) --
        
        The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.
      - SecurityGroups (list) --
        
        One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
        
        (dict) --
        
        Describes a security group.
        
        GroupName (string) --
        
        The name of the security group.
        
        GroupId (string) --
        
        The ID of the security group.
      - AddressingType (string) --
        
        Deprecated.
      - BlockDeviceMappings (list) --
        
        One or more block device mapping entries.
        
        (dict) --
        
        Describes a block device mapping.
        
        DeviceName (string) --
        
        The device name (for example, /dev/sdh or xvdh ).
        
        VirtualName (string) --
        
        The virtual device name ( ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 .The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
        
        Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
        
        Ebs (dict) --
        
        Parameters used to automatically set up EBS volumes when the instance is launched.
        
        Encrypted (boolean) --
        
        Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. This is because only blank volumes can be encrypted on creation.
        
        DeleteOnTermination (boolean) --
        
        Indicates whether the EBS volume is deleted on instance termination.
        
        Iops (integer) --
        
        The number of I/O operations per second (IOPS) that the volume supports. For io1 , this represents the number of IOPS that are provisioned for the volume. For gp2 , this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide .
        
        Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
        
        Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2 , st1 , sc1 , or standard volumes.
        
        KmsKeyId (string) --
        
        ID for a user-managed CMK under which the EBS volume is encrypted.
        
        Note: This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
        
        SnapshotId (string) --
        
        The ID of the snapshot.
        
        VolumeSize (integer) --
        
        The size of the volume, in GiB.
        
        Constraints: 1-16384 for General Purpose SSD ( gp2 ), 4-16384 for Provisioned IOPS SSD ( io1 ), 500-16384 for Throughput Optimized HDD ( st1 ), 500-16384 for Cold HDD ( sc1 ), and 1-1024 for Magnetic ( standard ) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
        
        Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
        
        VolumeType (string) --
        
        The volume type: gp2 , io1 , st1 , sc1 , or standard .
        
        Default: standard
        
        NoDevice (string) --
        
        Suppresses the specified device included in the block device mapping of the AMI.
      - EbsOptimized (boolean) --
        
        Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
        
        Default: false
      - IamInstanceProfile (dict) --
        
        The IAM instance profile.
        
        Arn (string) --
        
        The Amazon Resource Name (ARN) of the instance profile.
        
        Name (string) --
        
        The name of the instance profile.
      - ImageId (string) --
        
        The ID of the AMI.
      - InstanceType (string) --
        
        The instance type.
      - KernelId (string) --
        
        The ID of the kernel.
      - KeyName (string) --
        
        The name of the key pair.
      - NetworkInterfaces (list) --
        
        One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
        
        (dict) --
        
        Describes a network interface.
        
        AssociatePublicIpAddress (boolean) --
        
        Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
        
        DeleteOnTermination (boolean) --
        
        If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
        
        Description (string) --
        
        The description of the network interface. Applies only if creating a network interface when launching an instance.
        
        DeviceIndex (integer) --
        
        The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.
        
        Groups (list) --
        
        The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
        
        (string) --
        
        Ipv6AddressCount (integer) --
        
        A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
        
        Ipv6Addresses (list) --
        
        One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
        
        (dict) --
        
        Describes an IPv6 address.
        
        Ipv6Address (string) --
        
        The IPv6 address.
        
        NetworkInterfaceId (string) --
        
        The ID of the network interface.
        
        PrivateIpAddress (string) --
        
        The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
        
        PrivateIpAddresses (list) --
        
        One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
        
        (dict) --
        
        Describes a secondary private IPv4 address for a network interface.
        
        Primary (boolean) --
        
        Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
        
        PrivateIpAddress (string) --
        
        The private IPv4 addresses.
        
        SecondaryPrivateIpAddressCount (integer) --
        
        The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
        
        SubnetId (string) --
        
        The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.
      - Placement (dict) --
        
        The placement information for the instance.
        
        AvailabilityZone (string) --
        
        The Availability Zone.
        
        [Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
        
        GroupName (string) --
        
        The name of the placement group (for cluster instances).
        
        Tenancy (string) --
        
        The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
      - RamdiskId (string) --
        
        The ID of the RAM disk.
      - SubnetId (string) --
        
        The ID of the subnet in which to launch the instance.
      - Monitoring (dict) --
        
        Describes the monitoring of an instance.
        
        Enabled (boolean) --
        
        Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
    - LaunchedAvailabilityZone (string) --
      
      The Availability Zone in which the request is launched.
    - ProductDescription (string) --
      
      The product description associated with the Spot Instance.
    - SpotInstanceRequestId (string) --
      
      The ID of the Spot Instance request.
    - SpotPrice (string) --
      
      The maximum price per hour that you are willing to pay for a Spot Instance.
    - State (string) --
      
      The state of the Spot Instance request. Spot status information can help you track your Spot Instance requests. For more information, see Spot Status in the Amazon Elastic Compute Cloud User Guide .
    - Status (dict) --
      
      The status code and status message describing the Spot Instance request.
      - Code (string) --
        
        The status code. For a list of status codes, see Spot Status Codes in the Amazon Elastic Compute Cloud User Guide .
      - Message (string) --
        
        The description for the status code.
      - UpdateTime (datetime) --
        
        The date and time of the most recent status update, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z).
    - Tags (list) --
      
      Any tags assigned 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 255 Unicode characters.
    - Type (string) --
      
      The Spot Instance request type.
    - ValidFrom (datetime) --
      
      The start date of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). The request becomes active at this date and time.
    - ValidUntil (datetime) --
      
      The end date of the request, in UTC format (for example, YYYY -MM -DD T*HH* :MM :SS Z). If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached. The default end date is 7 days from the current date.
    - InstanceInterruptionBehavior (string) --
      
      The behavior when a Spot Instance is interrupted.

RunInstances (updated)

Link ¶
Changes (request)

{'BlockDeviceMappings': {'Ebs': {'KmsKeyId': 'string'}},
 'InstanceMarketOptions': {'MarketType': 'spot',
                           'SpotOptions': {'BlockDurationMinutes': 'integer',
                                           'InstanceInterruptionBehavior': 'hibernate '
                                                                           '| '
                                                                           'stop '
                                                                           '| '
                                                                           'terminate',
                                           'MaxPrice': 'string',
                                           'SpotInstanceType': 'one-time | '
                                                               'persistent',
                                           'ValidUntil': 'timestamp'}},
 'LaunchTemplate': {'LaunchTemplateId': 'string',
                    'LaunchTemplateName': 'string',
                    'Version': 'string'}}

Launches the specified number of instances using an AMI for which you have permissions.

You can specify a number of options, or leave the default options. The following rules apply:

[EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.
[EC2-Classic] If don't specify an Availability Zone, we choose one for you.
Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance Types Available Only in a VPC.
[EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.
Not all instance types support IPv6 addresses. For more information, see Instance Types.
If you don't specify a security group ID, we use the default security group. For more information, see Security Groups.
If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.

You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging Your Amazon EC2 Resources.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide .

For troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.run_instances(
    BlockDeviceMappings=[
        {
            'DeviceName': 'string',
            'VirtualName': 'string',
            'Ebs': {
                'Encrypted': True|False,
                'DeleteOnTermination': True|False,
                'Iops': 123,
                'KmsKeyId': 'string',
                'SnapshotId': 'string',
                'VolumeSize': 123,
                'VolumeType': 'standard'|'io1'|'gp2'|'sc1'|'st1'
            },
            'NoDevice': 'string'
        },
    ],
    ImageId='string',
    InstanceType='t1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge',
    Ipv6AddressCount=123,
    Ipv6Addresses=[
        {
            'Ipv6Address': 'string'
        },
    ],
    KernelId='string',
    KeyName='string',
    MaxCount=123,
    MinCount=123,
    Monitoring={
        'Enabled': True|False
    },
    Placement={
        'AvailabilityZone': 'string',
        'Affinity': 'string',
        'GroupName': 'string',
        'HostId': 'string',
        'Tenancy': 'default'|'dedicated'|'host',
        'SpreadDomain': 'string'
    },
    RamdiskId='string',
    SecurityGroupIds=[
        'string',
    ],
    SecurityGroups=[
        'string',
    ],
    SubnetId='string',
    UserData='string',
    AdditionalInfo='string',
    ClientToken='string',
    DisableApiTermination=True|False,
    DryRun=True|False,
    EbsOptimized=True|False,
    IamInstanceProfile={
        'Arn': 'string',
        'Name': 'string'
    },
    InstanceInitiatedShutdownBehavior='stop'|'terminate',
    NetworkInterfaces=[
        {
            'AssociatePublicIpAddress': True|False,
            'DeleteOnTermination': True|False,
            'Description': 'string',
            'DeviceIndex': 123,
            'Groups': [
                'string',
            ],
            'Ipv6AddressCount': 123,
            'Ipv6Addresses': [
                {
                    'Ipv6Address': 'string'
                },
            ],
            'NetworkInterfaceId': 'string',
            'PrivateIpAddress': 'string',
            'PrivateIpAddresses': [
                {
                    'Primary': True|False,
                    'PrivateIpAddress': 'string'
                },
            ],
            'SecondaryPrivateIpAddressCount': 123,
            'SubnetId': 'string'
        },
    ],
    PrivateIpAddress='string',
    ElasticGpuSpecification=[
        {
            'Type': 'string'
        },
    ],
    TagSpecifications=[
        {
            'ResourceType': 'customer-gateway'|'dhcp-options'|'image'|'instance'|'internet-gateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'snapshot'|'spot-instances-request'|'subnet'|'security-group'|'volume'|'vpc'|'vpn-connection'|'vpn-gateway',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    LaunchTemplate={
        'LaunchTemplateId': 'string',
        'LaunchTemplateName': 'string',
        'Version': 'string'
    },
    InstanceMarketOptions={
        'MarketType': 'spot',
        'SpotOptions': {
            'MaxPrice': 'string',
            'SpotInstanceType': 'one-time'|'persistent',
            'BlockDurationMinutes': 123,
            'ValidUntil': datetime(2015, 1, 1),
            'InstanceInterruptionBehavior': 'hibernate'|'stop'|'terminate'
        }
    }
)

type BlockDeviceMappings

list

param BlockDeviceMappings

One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.

(dict) --

Describes a block device mapping.
- DeviceName (string) --
  
  The device name (for example, /dev/sdh or xvdh ).
- VirtualName (string) --
  
  The virtual device name ( ephemeral N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1 .The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
  
  Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
- Ebs (dict) --
  
  Parameters used to automatically set up EBS volumes when the instance is launched.
  - Encrypted (boolean) --
    
    Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value. This is because only blank volumes can be encrypted on creation.
  - DeleteOnTermination (boolean) --
    
    Indicates whether the EBS volume is deleted on instance termination.
  - Iops (integer) --
    
    The number of I/O operations per second (IOPS) that the volume supports. For io1 , this represents the number of IOPS that are provisioned for the volume. For gp2 , this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide .
    
    Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
    
    Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2 , st1 , sc1 , or standard volumes.
  - KmsKeyId (string) --
    
    ID for a user-managed CMK under which the EBS volume is encrypted.
    
    Note: This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
  - SnapshotId (string) --
    
    The ID of the snapshot.
  - VolumeSize (integer) --
    
    The size of the volume, in GiB.
    
    Constraints: 1-16384 for General Purpose SSD ( gp2 ), 4-16384 for Provisioned IOPS SSD ( io1 ), 500-16384 for Throughput Optimized HDD ( st1 ), 500-16384 for Cold HDD ( sc1 ), and 1-1024 for Magnetic ( standard ) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
    
    Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
  - VolumeType (string) --
    
    The volume type: gp2 , io1 , st1 , sc1 , or standard .
    
    Default: standard
- NoDevice (string) --
  
  Suppresses the specified device included in the block device mapping of the AMI.

type ImageId

string

param ImageId

The ID of the AMI, which you can get by calling DescribeImages.

type InstanceType

string

param InstanceType

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .

Default: m1.small

type Ipv6AddressCount

integer

param Ipv6AddressCount

[EC2-VPC] A number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

type Ipv6Addresses

list

param Ipv6Addresses

[EC2-VPC] Specify one or more IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

(dict) --

Describes an IPv6 address.
- Ipv6Address (string) --
  
  The IPv6 address.

type KernelId

string

param KernelId

The ID of the kernel.

Warning

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide .

type KeyName

string

param KeyName

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

Warning

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

type MaxCount

integer

param MaxCount

[REQUIRED]

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount .

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.

type MinCount

integer

param MinCount

[REQUIRED]

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

type Monitoring

dict

param Monitoring

The monitoring for the instance.

Enabled (boolean) -- [REQUIRED]

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

type Placement

dict

param Placement

The placement for the instance.

AvailabilityZone (string) --

The Availability Zone of the instance.
Affinity (string) --

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
GroupName (string) --

The name of the placement group the instance is in (for cluster compute instances).
HostId (string) --

The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
Tenancy (string) --

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
SpreadDomain (string) --

Reserved for future use.

type RamdiskId

string

param RamdiskId

The ID of the RAM disk.

Warning

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide .

type SecurityGroupIds

list

param SecurityGroupIds

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

(string) --

type SecurityGroups

list

param SecurityGroups

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

(string) --

type SubnetId

string

param SubnetId

[EC2-VPC] The ID of the subnet to launch the instance into.

type UserData

string

param UserData

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.

type AdditionalInfo

string

param AdditionalInfo

Reserved.

type ClientToken

string

param ClientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

type DisableApiTermination

boolean

param DisableApiTermination

If you set this parameter to true , you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute to false after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate , you can terminate the instance by running the shutdown command from the instance.

Default: false

type DryRun

boolean

param DryRun

type EbsOptimized

boolean

param EbsOptimized

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

type IamInstanceProfile

dict

param IamInstanceProfile

The IAM instance profile.

Arn (string) --

The Amazon Resource Name (ARN) of the instance profile.
Name (string) --

The name of the instance profile.

type InstanceInitiatedShutdownBehavior

string

param InstanceInitiatedShutdownBehavior

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

type NetworkInterfaces

list

param NetworkInterfaces

One or more network interfaces.

(dict) --

Describes a network interface.
- AssociatePublicIpAddress (boolean) --
  
  Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true .
- DeleteOnTermination (boolean) --
  
  If set to true , the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.
- Description (string) --
  
  The description of the network interface. Applies only if creating a network interface when launching an instance.
- DeviceIndex (integer) --
  
  The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.
- Groups (list) --
  
  The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
  - (string) --
- Ipv6AddressCount (integer) --
  
  A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
- Ipv6Addresses (list) --
  
  One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
  - (dict) --
    
    Describes an IPv6 address.
    - Ipv6Address (string) --
      
      The IPv6 address.
- NetworkInterfaceId (string) --
  
  The ID of the network interface.
- PrivateIpAddress (string) --
  
  The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
- PrivateIpAddresses (list) --
  
  One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
  - (dict) --
    
    Describes a secondary private IPv4 address for a network interface.
    - Primary (boolean) --
      
      Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
    - PrivateIpAddress (string) -- [REQUIRED]
      
      The private IPv4 addresses.
- SecondaryPrivateIpAddressCount (integer) --
  
  The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
- SubnetId (string) --
  
  The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

type PrivateIpAddress

string

param PrivateIpAddress

[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.

Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.

type ElasticGpuSpecification

list

param ElasticGpuSpecification

An elastic GPU to associate with the instance.

(dict) --

A specification for an Elastic GPU.
- Type (string) -- [REQUIRED]
  
  The type of Elastic GPU.

type TagSpecifications

list

param TagSpecifications

The tags to apply to the resources during launch. You can tag instances and volumes. The specified tags are applied to all instances or volumes that are created during launch.

(dict) --

The tags to apply to a resource when the resource is being created.
- ResourceType (string) --
  
  The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume .
- 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 255 Unicode characters.

type LaunchTemplate

dict

param LaunchTemplate

The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template.

LaunchTemplateId (string) --

The ID of the launch template.
LaunchTemplateName (string) --

The name of the launch template.
Version (string) --

The version number of the launch template.

Default: The default version for the launch template.

type InstanceMarketOptions

dict

param InstanceMarketOptions

The market (purchasing) option for the instances.

MarketType (string) --

The market type.
SpotOptions (dict) --

The options for Spot Instances.
- MaxPrice (string) --
  
  The maximum hourly price you're willing to pay for the Spot Instances. The default is the On-Demand price.
- SpotInstanceType (string) --
  
  The Spot Instance request type.
- BlockDurationMinutes (integer) --
  
  The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
- ValidUntil (datetime) --
  
  The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date.
- InstanceInterruptionBehavior (string) --
  
  The behavior when a Spot Instance is interrupted. The default is terminate .

rtype

dict

returns

Response Syntax

{
    'Groups': [
        {
            'GroupName': 'string',
            'GroupId': 'string'
        },
    ],
    'Instances': [
        {
            'AmiLaunchIndex': 123,
            'ImageId': 'string',
            'InstanceId': 'string',
            'InstanceType': 't1.micro'|'t2.nano'|'t2.micro'|'t2.small'|'t2.medium'|'t2.large'|'t2.xlarge'|'t2.2xlarge'|'m1.small'|'m1.medium'|'m1.large'|'m1.xlarge'|'m3.medium'|'m3.large'|'m3.xlarge'|'m3.2xlarge'|'m4.large'|'m4.xlarge'|'m4.2xlarge'|'m4.4xlarge'|'m4.10xlarge'|'m4.16xlarge'|'m2.xlarge'|'m2.2xlarge'|'m2.4xlarge'|'cr1.8xlarge'|'r3.large'|'r3.xlarge'|'r3.2xlarge'|'r3.4xlarge'|'r3.8xlarge'|'r4.large'|'r4.xlarge'|'r4.2xlarge'|'r4.4xlarge'|'r4.8xlarge'|'r4.16xlarge'|'x1.16xlarge'|'x1.32xlarge'|'x1e.xlarge'|'x1e.2xlarge'|'x1e.4xlarge'|'x1e.8xlarge'|'x1e.16xlarge'|'x1e.32xlarge'|'i2.xlarge'|'i2.2xlarge'|'i2.4xlarge'|'i2.8xlarge'|'i3.large'|'i3.xlarge'|'i3.2xlarge'|'i3.4xlarge'|'i3.8xlarge'|'i3.16xlarge'|'hi1.4xlarge'|'hs1.8xlarge'|'c1.medium'|'c1.xlarge'|'c3.large'|'c3.xlarge'|'c3.2xlarge'|'c3.4xlarge'|'c3.8xlarge'|'c4.large'|'c4.xlarge'|'c4.2xlarge'|'c4.4xlarge'|'c4.8xlarge'|'c5.large'|'c5.xlarge'|'c5.2xlarge'|'c5.4xlarge'|'c5.9xlarge'|'c5.18xlarge'|'cc1.4xlarge'|'cc2.8xlarge'|'g2.2xlarge'|'g2.8xlarge'|'g3.4xlarge'|'g3.8xlarge'|'g3.16xlarge'|'cg1.4xlarge'|'p2.xlarge'|'p2.8xlarge'|'p2.16xlarge'|'p3.2xlarge'|'p3.8xlarge'|'p3.16xlarge'|'d2.xlarge'|'d2.2xlarge'|'d2.4xlarge'|'d2.8xlarge'|'f1.2xlarge'|'f1.16xlarge',
            'KernelId': 'string',
            'KeyName': 'string',
            'LaunchTime': datetime(2015, 1, 1),
            'Monitoring': {
                'State': 'disabled'|'disabling'|'enabled'|'pending'
            },
            'Placement': {
                'AvailabilityZone': 'string',
                'Affinity': 'string',
                'GroupName': 'string',
                'HostId': 'string',
                'Tenancy': 'default'|'dedicated'|'host',
                'SpreadDomain': 'string'
            },
            'Platform': 'Windows',
            'PrivateDnsName': 'string',
            'PrivateIpAddress': 'string',
            'ProductCodes': [
                {
                    'ProductCodeId': 'string',
                    'ProductCodeType': 'devpay'|'marketplace'
                },
            ],
            'PublicDnsName': 'string',
            'PublicIpAddress': 'string',
            'RamdiskId': 'string',
            'State': {
                'Code': 123,
                'Name': 'pending'|'running'|'shutting-down'|'terminated'|'stopping'|'stopped'
            },
            'StateTransitionReason': 'string',
            'SubnetId': 'string',
            'VpcId': 'string',
            'Architecture': 'i386'|'x86_64',
            'BlockDeviceMappings': [
                {
                    'DeviceName': 'string',
                    'Ebs': {
                        'AttachTime': datetime(2015, 1, 1),
                        'DeleteOnTermination': True|False,
                        'Status': 'attaching'|'attached'|'detaching'|'detached',
                        'VolumeId': 'string'
                    }
                },
            ],
            'ClientToken': 'string',
            'EbsOptimized': True|False,
            'EnaSupport': True|False,
            'Hypervisor': 'ovm'|'xen',
            'IamInstanceProfile': {
                'Arn': 'string',
                'Id': 'string'
            },
            'InstanceLifecycle': 'spot'|'scheduled',
            'ElasticGpuAssociations': [
                {
                    'ElasticGpuId': 'string',
                    'ElasticGpuAssociationId': 'string',
                    'ElasticGpuAssociationState': 'string',
                    'ElasticGpuAssociationTime': 'string'
                },
            ],
            'NetworkInterfaces': [
                {
                    'Association': {
                        'IpOwnerId': 'string',
                        'PublicDnsName': 'string',
                        'PublicIp': 'string'
                    },
                    'Attachment': {
                        'AttachTime': datetime(2015, 1, 1),
                        'AttachmentId': 'string',
                        'DeleteOnTermination': True|False,
                        'DeviceIndex': 123,
                        'Status': 'attaching'|'attached'|'detaching'|'detached'
                    },
                    'Description': 'string',
                    'Groups': [
                        {
                            'GroupName': 'string',
                            'GroupId': 'string'
                        },
                    ],
                    'Ipv6Addresses': [
                        {
                            'Ipv6Address': 'string'
                        },
                    ],
                    'MacAddress': 'string',
                    'NetworkInterfaceId': 'string',
                    'OwnerId': 'string',
                    'PrivateDnsName': 'string',
                    'PrivateIpAddress': 'string',
                    'PrivateIpAddresses': [
                        {
                            'Association': {
                                'IpOwnerId': 'string',
                                'PublicDnsName': 'string',
                                'PublicIp': 'string'
                            },
                            'Primary': True|False,
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string'
                        },
                    ],
                    'SourceDestCheck': True|False,
                    'Status': 'available'|'attaching'|'in-use'|'detaching',
                    'SubnetId': 'string',
                    'VpcId': 'string'
                },
            ],
            'RootDeviceName': 'string',
            'RootDeviceType': 'ebs'|'instance-store',
            'SecurityGroups': [
                {
                    'GroupName': 'string',
                    'GroupId': 'string'
                },
            ],
            'SourceDestCheck': True|False,
            'SpotInstanceRequestId': 'string',
            'SriovNetSupport': 'string',
            'StateReason': {
                'Code': 'string',
                'Message': 'string'
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'VirtualizationType': 'hvm'|'paravirtual'
        },
    ],
    'OwnerId': 'string',
    'RequesterId': 'string',
    'ReservationId': 'string'
}

Response Structure

(dict) --

Describes a reservation.
- Groups (list) --
  
  [EC2-Classic only] One or more security groups.
  - (dict) --
    
    Describes a security group.
    - GroupName (string) --
      
      The name of the security group.
    - GroupId (string) --
      
      The ID of the security group.
- Instances (list) --
  
  One or more instances.
  - (dict) --
    
    Describes an instance.
    - AmiLaunchIndex (integer) --
      
      The AMI launch index, which can be used to find this instance in the launch group.
    - ImageId (string) --
      
      The ID of the AMI used to launch the instance.
    - InstanceId (string) --
      
      The ID of the instance.
    - InstanceType (string) --
      
      The instance type.
    - KernelId (string) --
      
      The kernel associated with this instance, if applicable.
    - KeyName (string) --
      
      The name of the key pair, if this instance was launched with an associated key pair.
    - LaunchTime (datetime) --
      
      The time the instance was launched.
    - Monitoring (dict) --
      
      The monitoring for the instance.
      - State (string) --
        
        Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
    - Placement (dict) --
      
      The location where the instance launched, if applicable.
      - AvailabilityZone (string) --
        
        The Availability Zone of the instance.
      - Affinity (string) --
        
        The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.
      - GroupName (string) --
        
        The name of the placement group the instance is in (for cluster compute instances).
      - HostId (string) --
        
        The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
      - Tenancy (string) --
        
        The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
      - SpreadDomain (string) --
        
        Reserved for future use.
    - Platform (string) --
      
      The value is Windows for Windows instances; otherwise blank.
    - PrivateDnsName (string) --
      
      (IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.
      
      [EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.
    - PrivateIpAddress (string) --
      
      The private IPv4 address assigned to the instance.
    - ProductCodes (list) --
      
      The product codes attached to this instance, if applicable.
      - (dict) --
        
        Describes a product code.
        
        ProductCodeId (string) --
        
        The product code.
        
        ProductCodeType (string) --
        
        The type of product code.
    - PublicDnsName (string) --
      
      (IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.
    - PublicIpAddress (string) --
      
      The public IPv4 address assigned to the instance, if applicable.
    - RamdiskId (string) --
      
      The RAM disk associated with this instance, if applicable.
    - State (dict) --
      
      The current state of the instance.
      - Code (integer) --
        
        The low byte represents the state. The high byte is an opaque internal value and should be ignored.
        
        0 : pending
        
        16 : running
        
        32 : shutting-down
        
        48 : terminated
        
        64 : stopping
        
        80 : stopped
      - Name (string) --
        
        The current state of the instance.
    - StateTransitionReason (string) --
      
      The reason for the most recent state transition. This might be an empty string.
    - SubnetId (string) --
      
      [EC2-VPC] The ID of the subnet in which the instance is running.
    - VpcId (string) --
      
      [EC2-VPC] The ID of the VPC in which the instance is running.
    - Architecture (string) --
      
      The architecture of the image.
    - BlockDeviceMappings (list) --
      
      Any block device mapping entries for the instance.
      - (dict) --
        
        Describes a block device mapping.
        
        DeviceName (string) --
        
        The device name (for example, /dev/sdh or xvdh ).
        
        Ebs (dict) --
        
        Parameters used to automatically set up EBS volumes when the instance is launched.
        
        AttachTime (datetime) --
        
        The time stamp when the attachment initiated.
        
        DeleteOnTermination (boolean) --
        
        Indicates whether the volume is deleted on instance termination.
        
        Status (string) --
        
        The attachment state.
        
        VolumeId (string) --
        
        The ID of the EBS volume.
    - ClientToken (string) --
      
      The idempotency token you provided when you launched the instance, if applicable.
    - EbsOptimized (boolean) --
      
      Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
    - EnaSupport (boolean) --
      
      Specifies whether enhanced networking with ENA is enabled.
    - Hypervisor (string) --
      
      The hypervisor type of the instance.
    - IamInstanceProfile (dict) --
      
      The IAM instance profile associated with the instance, if applicable.
      - Arn (string) --
        
        The Amazon Resource Name (ARN) of the instance profile.
      - Id (string) --
        
        The ID of the instance profile.
    - InstanceLifecycle (string) --
      
      Indicates whether this is a Spot Instance or a Scheduled Instance.
    - ElasticGpuAssociations (list) --
      
      The Elastic GPU associated with the instance.
      - (dict) --
        
        Describes the association between an instance and an Elastic GPU.
        
        ElasticGpuId (string) --
        
        The ID of the Elastic GPU.
        
        ElasticGpuAssociationId (string) --
        
        The ID of the association.
        
        ElasticGpuAssociationState (string) --
        
        The state of the association between the instance and the Elastic GPU.
        
        ElasticGpuAssociationTime (string) --
        
        The time the Elastic GPU was associated with the instance.
    - NetworkInterfaces (list) --
      
      [EC2-VPC] One or more network interfaces for the instance.
      - (dict) --
        
        Describes a network interface.
        
        Association (dict) --
        
        The association information for an Elastic IPv4 associated with the network interface.
        
        IpOwnerId (string) --
        
        The ID of the owner of the Elastic IP address.
        
        PublicDnsName (string) --
        
        The public DNS name.
        
        PublicIp (string) --
        
        The public IP address or Elastic IP address bound to the network interface.
        
        Attachment (dict) --
        
        The network interface attachment.
        
        AttachTime (datetime) --
        
        The time stamp when the attachment initiated.
        
        AttachmentId (string) --
        
        The ID of the network interface attachment.
        
        DeleteOnTermination (boolean) --
        
        Indicates whether the network interface is deleted when the instance is terminated.
        
        DeviceIndex (integer) --
        
        The index of the device on the instance for the network interface attachment.
        
        Status (string) --
        
        The attachment state.
        
        Description (string) --
        
        The description.
        
        Groups (list) --
        
        One or more security groups.
        
        (dict) --
        
        Describes a security group.
        
        GroupName (string) --
        
        The name of the security group.
        
        GroupId (string) --
        
        The ID of the security group.
        
        Ipv6Addresses (list) --
        
        One or more IPv6 addresses associated with the network interface.
        
        (dict) --
        
        Describes an IPv6 address.
        
        Ipv6Address (string) --
        
        The IPv6 address.
        
        MacAddress (string) --
        
        The MAC address.
        
        NetworkInterfaceId (string) --
        
        The ID of the network interface.
        
        OwnerId (string) --
        
        The ID of the AWS account that created the network interface.
        
        PrivateDnsName (string) --
        
        The private DNS name.
        
        PrivateIpAddress (string) --
        
        The IPv4 address of the network interface within the subnet.
        
        PrivateIpAddresses (list) --
        
        One or more private IPv4 addresses associated with the network interface.
        
        (dict) --
        
        Describes a private IPv4 address.
        
        Association (dict) --
        
        The association information for an Elastic IP address for the network interface.
        
        IpOwnerId (string) --
        
        The ID of the owner of the Elastic IP address.
        
        PublicDnsName (string) --
        
        The public DNS name.
        
        PublicIp (string) --
        
        The public IP address or Elastic IP address bound to the network interface.
        
        Primary (boolean) --
        
        Indicates whether this IPv4 address is the primary private IP address of the network interface.
        
        PrivateDnsName (string) --
        
        The private IPv4 DNS name.
        
        PrivateIpAddress (string) --
        
        The private IPv4 address of the network interface.
        
        SourceDestCheck (boolean) --
        
        Indicates whether to validate network traffic to or from this network interface.
        
        Status (string) --
        
        The status of the network interface.
        
        SubnetId (string) --
        
        The ID of the subnet.
        
        VpcId (string) --
        
        The ID of the VPC.
    - RootDeviceName (string) --
      
      The device name of the root device volume (for example, /dev/sda1 ).
    - RootDeviceType (string) --
      
      The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
    - SecurityGroups (list) --
      
      One or more security groups for the instance.
      - (dict) --
        
        Describes a security group.
        
        GroupName (string) --
        
        The name of the security group.
        
        GroupId (string) --
        
        The ID of the security group.
    - SourceDestCheck (boolean) --
      
      Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide .
    - SpotInstanceRequestId (string) --
      
      If the request is a Spot Instance request, the ID of the request.
    - SriovNetSupport (string) --
      
      Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
    - StateReason (dict) --
      
      The reason for the most recent state transition.
      - Code (string) --
        
        The reason code for the state change.
      - Message (string) --
        
        The message for the state change.
        
        Server.InsufficientInstanceCapacity : There was insufficient instance capacity to satisfy the launch request.
        
        Server.InternalError : An internal error occurred during instance launch, resulting in termination.
        
        Server.ScheduledStop : The instance was stopped due to a scheduled retirement.
        
        Server.SpotInstanceTermination : A Spot Instance was terminated due to an increase in the Spot price.
        
        Client.InternalError : A client error caused the instance to terminate on launch.
        
        Client.InstanceInitiatedShutdown : The instance was shut down using the shutdown -h command from the instance.
        
        Client.InstanceTerminated : The instance was terminated or rebooted during AMI creation.
        
        Client.UserInitiatedShutdown : The instance was shut down using the Amazon EC2 API.
        
        Client.VolumeLimitExceeded : The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your limits.
        
        Client.InvalidSnapshot.NotFound : The specified snapshot was not found.
    - Tags (list) --
      
      Any tags assigned to the instance.
      - (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 255 Unicode characters.
    - VirtualizationType (string) --
      
      The virtualization type of the instance.
- OwnerId (string) --
  
  The ID of the AWS account that owns the reservation.
- RequesterId (string) --
  
  The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).
- ReservationId (string) --
  
  The ID of the reservation.