Amazon Elastic Compute Cloud

See also: AWS API Documentation

Request Syntax

client.get_capacity_reservation_usage(
    CapacityReservationId='string',
    NextToken='string',
    MaxResults=123,
    DryRun=True|False
)

type CapacityReservationId

string

param CapacityReservationId

[REQUIRED]

type NextToken

string

param NextToken

type MaxResults

integer

param MaxResults

type DryRun

boolean

param DryRun

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'CapacityReservationId': 'string',
    'InstanceType': 'string',
    'TotalInstanceCount': 123,
    'AvailableInstanceCount': 123,
    'State': 'active'|'expired'|'cancelled'|'pending'|'failed',
    'InstanceUsages': [
        {
            'AccountId': 'string',
            'UsedInstanceCount': 123
        },
    ]
}

Response Structure

• (dict) --

  • NextToken (string) --

  • CapacityReservationId (string) --

  • InstanceType (string) --

  • TotalInstanceCount (integer) --

  • AvailableInstanceCount (integer) --

  • State (string) --

  • InstanceUsages (list) --

    • (dict) --

      • AccountId (string) --

      • UsedInstanceCount (integer) --

{'AvailabilityZoneId': 'string'}

{'CapacityReservation': {'AvailabilityZoneId': 'string',
                         'CapacityReservationArn': 'string',
                         'OwnerId': 'string'}}

Creates a new Capacity Reservation with the specified attributes.

Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon Elastic Compute Cloud User Guide .

Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.

Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Limits in the Amazon Elastic Compute Cloud User Guide .

See also: AWS API Documentation

Request Syntax

client.create_capacity_reservation(
    ClientToken='string',
    InstanceType='string',
    InstancePlatform='Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise',
    AvailabilityZone='string',
    AvailabilityZoneId='string',
    Tenancy='default'|'dedicated',
    InstanceCount=123,
    EbsOptimized=True|False,
    EphemeralStorage=True|False,
    EndDate=datetime(2015, 1, 1),
    EndDateType='unlimited'|'limited',
    InstanceMatchCriteria='open'|'targeted',
    TagSpecifications=[
        {
            'ResourceType': 'client-vpn-endpoint'|'customer-gateway'|'dedicated-host'|'dhcp-options'|'elastic-ip'|'fleet'|'fpga-image'|'host-reservation'|'image'|'instance'|'internet-gateway'|'launch-template'|'natgateway'|'network-acl'|'network-interface'|'reserved-instances'|'route-table'|'security-group'|'snapshot'|'spot-instances-request'|'subnet'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-route-table'|'volume'|'vpc'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DryRun=True|False
)

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.

Constraint: Maximum 64 ASCII characters.

type InstanceType

string

param InstanceType

[REQUIRED]

The instance type for which to reserve capacity. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide .

type InstancePlatform

string

param InstancePlatform

[REQUIRED]

The type of operating system for which to reserve capacity.

type AvailabilityZone

string

param AvailabilityZone

The Availability Zone in which to create the Capacity Reservation.

type AvailabilityZoneId

string

param AvailabilityZoneId

type Tenancy

string

param Tenancy

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

• default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

• dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

type InstanceCount

integer

param InstanceCount

[REQUIRED]

The number of instances for which to reserve capacity.

type EbsOptimized

boolean

param EbsOptimized

Indicates whether the Capacity Reservation supports EBS-optimized instances. 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.

type EphemeralStorage

boolean

param EphemeralStorage

Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.

type EndDate

datetime

param EndDate

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

You must provide an EndDate value if EndDateType is limited . Omit EndDate if EndDateType is unlimited .

If the EndDateType is limited , the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

type EndDateType

string

param EndDateType

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

• unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited .

• limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited .

type InstanceMatchCriteria

string

param InstanceMatchCriteria

Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

• open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.

• targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

Default: open

type TagSpecifications

list

param TagSpecifications

The tags to apply to the Capacity Reservation 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: capacity-reservation | client-vpn-endpoint | dedicated-host | fleet | instance | launch-template | snapshot | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume .

    To tag a resource after it has been created, see CreateTags.

  • 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 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 .

rtype

dict

returns

Response Syntax

{
    'CapacityReservation': {
        'CapacityReservationId': 'string',
        'OwnerId': 'string',
        'CapacityReservationArn': 'string',
        'AvailabilityZoneId': 'string',
        'InstanceType': 'string',
        'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise',
        'AvailabilityZone': 'string',
        'Tenancy': 'default'|'dedicated',
        'TotalInstanceCount': 123,
        'AvailableInstanceCount': 123,
        'EbsOptimized': True|False,
        'EphemeralStorage': True|False,
        'State': 'active'|'expired'|'cancelled'|'pending'|'failed',
        'EndDate': datetime(2015, 1, 1),
        'EndDateType': 'unlimited'|'limited',
        'InstanceMatchCriteria': 'open'|'targeted',
        'CreateDate': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

• (dict) --

  • CapacityReservation (dict) --

    Information about the Capacity Reservation.

    • CapacityReservationId (string) --

      The ID of the Capacity Reservation.

    • OwnerId (string) --

    • CapacityReservationArn (string) --

    • AvailabilityZoneId (string) --

    • InstanceType (string) --

      The type of instance for which the Capacity Reservation reserves capacity.

    • InstancePlatform (string) --

      The type of operating system for which the Capacity Reservation reserves capacity.

    • AvailabilityZone (string) --

      The Availability Zone in which the capacity is reserved.

    • Tenancy (string) --

      Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

      • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

      • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

    • TotalInstanceCount (integer) --

      The number of instances for which the Capacity Reservation reserves capacity.

    • AvailableInstanceCount (integer) --

      The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

    • EbsOptimized (boolean) --

      Indicates whether the Capacity Reservation supports EBS-optimized instances. 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.

    • EphemeralStorage (boolean) --

      Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.

    • State (string) --

      The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

      • active - The Capacity Reservation is active and the capacity is available for your use.

      • cancelled - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

      • expired - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.

      • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

      • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

    • EndDate (datetime) --

      The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

    • EndDateType (string) --

      Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

      • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

      • limited - The Capacity Reservation expires automatically at a specified date and time.

    • InstanceMatchCriteria (string) --

      Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

      • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

      • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

    • CreateDate (datetime) --

      The date and time at which the Capacity Reservation was created.

    • Tags (list) --

      Any tags assigned to the Capacity Reservation.

      • (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.

{'CapacityReservations': {'AvailabilityZoneId': 'string',
                          'CapacityReservationArn': 'string',
                          'OwnerId': 'string'}}

Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS Region that you're currently using.

See also: AWS API Documentation

Request Syntax

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

type CapacityReservationIds

list

param CapacityReservationIds

The ID of the Capacity Reservation.

• (string) --

type NextToken

string

param NextToken

The token to retrieve the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value.

type Filters

list

param Filters

One or more filters.

• (dict) --

  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:

  • DescribeAvailabilityZones

  • DescribeImages

  • DescribeInstances

  • DescribeKeyPairs

  • DescribeSecurityGroups

  • DescribeSnapshots

  • DescribeSubnets

  • DescribeTags

  • DescribeVolumes

  • DescribeVpcs

  • Name (string) --

    The name of the filter. Filter names are case-sensitive.

  • Values (list) --

    The filter values. Filter values are case-sensitive.

    • (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 .

rtype

dict

returns

Response Syntax

{
    'NextToken': 'string',
    'CapacityReservations': [
        {
            'CapacityReservationId': 'string',
            'OwnerId': 'string',
            'CapacityReservationArn': 'string',
            'AvailabilityZoneId': 'string',
            'InstanceType': 'string',
            'InstancePlatform': 'Linux/UNIX'|'Red Hat Enterprise Linux'|'SUSE Linux'|'Windows'|'Windows with SQL Server'|'Windows with SQL Server Enterprise'|'Windows with SQL Server Standard'|'Windows with SQL Server Web'|'Linux with SQL Server Standard'|'Linux with SQL Server Web'|'Linux with SQL Server Enterprise',
            'AvailabilityZone': 'string',
            'Tenancy': 'default'|'dedicated',
            'TotalInstanceCount': 123,
            'AvailableInstanceCount': 123,
            'EbsOptimized': True|False,
            'EphemeralStorage': True|False,
            'State': 'active'|'expired'|'cancelled'|'pending'|'failed',
            'EndDate': datetime(2015, 1, 1),
            'EndDateType': 'unlimited'|'limited',
            'InstanceMatchCriteria': 'open'|'targeted',
            'CreateDate': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
}

Response Structure

• (dict) --

  • 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.

  • CapacityReservations (list) --

    Information about the Capacity Reservations.

    • (dict) --

      Describes a Capacity Reservation.

      • CapacityReservationId (string) --

        The ID of the Capacity Reservation.

      • OwnerId (string) --

      • CapacityReservationArn (string) --

      • AvailabilityZoneId (string) --

      • InstanceType (string) --

        The type of instance for which the Capacity Reservation reserves capacity.

      • InstancePlatform (string) --

        The type of operating system for which the Capacity Reservation reserves capacity.

      • AvailabilityZone (string) --

        The Availability Zone in which the capacity is reserved.

      • Tenancy (string) --

        Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

        • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

        • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

      • TotalInstanceCount (integer) --

        The number of instances for which the Capacity Reservation reserves capacity.

      • AvailableInstanceCount (integer) --

        The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

      • EbsOptimized (boolean) --

        Indicates whether the Capacity Reservation supports EBS-optimized instances. 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.

      • EphemeralStorage (boolean) --

        Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.

      • State (string) --

        The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

        • active - The Capacity Reservation is active and the capacity is available for your use.

        • cancelled - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

        • expired - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.

        • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

        • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

      • EndDate (datetime) --

        The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

      • EndDateType (string) --

        Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

        • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

        • limited - The Capacity Reservation expires automatically at a specified date and time.

      • InstanceMatchCriteria (string) --

        Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

        • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

        • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

      • CreateDate (datetime) --

        The date and time at which the Capacity Reservation was created.

      • Tags (list) --

        Any tags assigned to the Capacity Reservation.

        • (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.