AWS API Changes

2024/11/22 - Amazon Elastic Compute Cloud - 3 new12 updated api methods

Changes Adds support for requesting future-dated Capacity Reservations with a minimum commitment duration, enabling IPAM for organizational units within AWS Organizations, reserving EC2 Capacity Blocks that start in 30 minutes, and extending the end date of existing Capacity Blocks.

PurchaseCapacityBlockExtension (new)

Link ¶

Purchase the Capacity Block extension for use with your account. You must specify the ID of the Capacity Block extension offering you are purchasing.

See also: AWS API Documentation

Request Syntax

client.purchase_capacity_block_extension(
    CapacityBlockExtensionOfferingId='string',
    CapacityReservationId='string',
    DryRun=True|False
)

type CapacityBlockExtensionOfferingId:

string

param CapacityBlockExtensionOfferingId:

[REQUIRED]

The ID of the Capacity Block extension offering to purchase.

type CapacityReservationId:

string

param CapacityReservationId:

[REQUIRED]

The ID of the Capacity reservation to be extended.

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

{
    'CapacityBlockExtensions': [
        {
            'CapacityReservationId': 'string',
            'InstanceType': 'string',
            'InstanceCount': 123,
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'CapacityBlockExtensionOfferingId': 'string',
            'CapacityBlockExtensionDurationHours': 123,
            'CapacityBlockExtensionStatus': 'payment-pending'|'payment-failed'|'payment-succeeded',
            'CapacityBlockExtensionPurchaseDate': datetime(2015, 1, 1),
            'CapacityBlockExtensionStartDate': datetime(2015, 1, 1),
            'CapacityBlockExtensionEndDate': datetime(2015, 1, 1),
            'UpfrontFee': 'string',
            'CurrencyCode': 'string'
        },
    ]
}

Response Structure

(dict) --
- CapacityBlockExtensions (list) --
  
  The purchased Capacity Block extensions.
  - (dict) --
    
    Describes a Capacity Block extension. With an extension, you can extend the duration of time for an existing Capacity Block.
    - CapacityReservationId (string) --
      
      The reservation ID of the Capacity Block extension.
    - InstanceType (string) --
      
      The instance type of the Capacity Block extension.
    - InstanceCount (integer) --
      
      The number of instances in the Capacity Block extension.
    - AvailabilityZone (string) --
      
      The Availability Zone of the Capacity Block extension.
    - AvailabilityZoneId (string) --
      
      The Availability Zone ID of the Capacity Block extension.
    - CapacityBlockExtensionOfferingId (string) --
      
      The ID of the Capacity Block extension offering.
    - CapacityBlockExtensionDurationHours (integer) --
      
      The duration of the Capacity Block extension in hours.
    - CapacityBlockExtensionStatus (string) --
      
      The status of the Capacity Block extension. A Capacity Block extension can have one of the following statuses:
      - payment-pending - The Capacity Block extension payment is processing. If your payment can't be processed within 12 hours, the Capacity Block extension is failed.
      - payment-failed - Payment for the Capacity Block extension request was not successful.
      - payment-succeeded - Payment for the Capacity Block extension request was successful. You receive an invoice that reflects the one-time upfront payment. In the invoice, you can associate the paid amount with the Capacity Block reservation ID.
    - CapacityBlockExtensionPurchaseDate (datetime) --
      
      The date when the Capacity Block extension was purchased.
    - CapacityBlockExtensionStartDate (datetime) --
      
      The start date of the Capacity Block extension.
    - CapacityBlockExtensionEndDate (datetime) --
      
      The end date of the Capacity Block extension.
    - UpfrontFee (string) --
      
      The total price to be paid up front.
    - CurrencyCode (string) --
      
      The currency of the payment for the Capacity Block extension.

DescribeCapacityBlockExtensionOfferings (new)

Link ¶

Describes Capacity Block extension offerings available for purchase in the Amazon Web Services Region that you're currently using.

See also: AWS API Documentation

Request Syntax

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

type DryRun:

boolean

param DryRun:

type CapacityBlockExtensionDurationHours:

integer

param CapacityBlockExtensionDurationHours:

[REQUIRED]

The duration of the Capacity Block extension offering in hours.

type CapacityReservationId:

string

param CapacityReservationId:

[REQUIRED]

The ID of the Capacity reservation to be extended.

type NextToken:

string

param NextToken:

The token to use to retrieve the next page of results.

type MaxResults:

integer

param MaxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

rtype:

dict

returns:

Response Syntax

{
    'CapacityBlockExtensionOfferings': [
        {
            'CapacityBlockExtensionOfferingId': 'string',
            'InstanceType': 'string',
            'InstanceCount': 123,
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'StartDate': datetime(2015, 1, 1),
            'CapacityBlockExtensionStartDate': datetime(2015, 1, 1),
            'CapacityBlockExtensionEndDate': datetime(2015, 1, 1),
            'CapacityBlockExtensionDurationHours': 123,
            'UpfrontFee': 'string',
            'CurrencyCode': 'string',
            'Tenancy': 'default'|'dedicated'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- CapacityBlockExtensionOfferings (list) --
  
  The recommended Capacity Block extension offerings for the dates specified.
  - (dict) --
    
    The recommended Capacity Block extension that fits your search requirements.
    - CapacityBlockExtensionOfferingId (string) --
      
      The ID of the Capacity Block extension offering.
    - InstanceType (string) --
      
      The instance type of the Capacity Block that will be extended.
    - InstanceCount (integer) --
      
      The number of instances in the Capacity Block extension offering.
    - AvailabilityZone (string) --
      
      The Availability Zone of the Capacity Block that will be extended.
    - AvailabilityZoneId (string) --
      
      The Availability Zone ID of the Capacity Block that will be extended.
    - StartDate (datetime) --
      
      The start date of the Capacity Block that will be extended.
    - CapacityBlockExtensionStartDate (datetime) --
      
      The date and time at which the Capacity Block extension will start. This date is also the same as the end date of the Capacity Block that will be extended.
    - CapacityBlockExtensionEndDate (datetime) --
      
      The date and time at which the Capacity Block extension expires. When a Capacity Block expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Block's state changes to expired when it reaches its end date
    - CapacityBlockExtensionDurationHours (integer) --
      
      The amount of time of the Capacity Block extension offering in hours.
    - UpfrontFee (string) --
      
      The total price of the Capacity Block extension offering, to be paid up front.
    - CurrencyCode (string) --
      
      The currency of the payment for the Capacity Block extension offering.
    - Tenancy (string) --
      
      Indicates the tenancy of the Capacity Block extension offering. A Capacity Block can have one of the following tenancy settings:
      - default - The Capacity Block is created on hardware that is shared with other Amazon Web Services accounts.
      - dedicated - The Capacity Block is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
- 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.

DescribeCapacityBlockExtensionHistory (new)

Link ¶

Describes the events for the specified Capacity Block extension during the specified time.

See also: AWS API Documentation

Request Syntax

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

type CapacityReservationIds:

list

param CapacityReservationIds:

The IDs of Capacity Block reservations that you want to display the history for.

(string) --

type NextToken:

string

param NextToken:

The token to use to retrieve the next page of results.

type MaxResults:

integer

param MaxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

type Filters:

list

param Filters:

One or more filters

availability-zone - The Availability Zone of the extension.
availability-zone-id - The Availability Zone ID of the extension.
capacity-block-extension-offering-id - The ID of the extension offering.
capacity-block-extension-status - The status of the extension ( payment-pending | payment-failed | payment-succeeded).
capacity-reservation-id - The reservation ID of the extension.
instance-type - The instance type of the extension.

(dict) --

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

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

type DryRun:

boolean

param DryRun:

rtype:

dict

returns:

Response Syntax

{
    'CapacityBlockExtensions': [
        {
            'CapacityReservationId': 'string',
            'InstanceType': 'string',
            'InstanceCount': 123,
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string',
            'CapacityBlockExtensionOfferingId': 'string',
            'CapacityBlockExtensionDurationHours': 123,
            'CapacityBlockExtensionStatus': 'payment-pending'|'payment-failed'|'payment-succeeded',
            'CapacityBlockExtensionPurchaseDate': datetime(2015, 1, 1),
            'CapacityBlockExtensionStartDate': datetime(2015, 1, 1),
            'CapacityBlockExtensionEndDate': datetime(2015, 1, 1),
            'UpfrontFee': 'string',
            'CurrencyCode': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- CapacityBlockExtensions (list) --
  
  Describes one or more of your Capacity Block extensions. The results describe only the Capacity Block extensions in the Amazon Web Services Region that you're currently using.
  - (dict) --
    
    Describes a Capacity Block extension. With an extension, you can extend the duration of time for an existing Capacity Block.
    - CapacityReservationId (string) --
      
      The reservation ID of the Capacity Block extension.
    - InstanceType (string) --
      
      The instance type of the Capacity Block extension.
    - InstanceCount (integer) --
      
      The number of instances in the Capacity Block extension.
    - AvailabilityZone (string) --
      
      The Availability Zone of the Capacity Block extension.
    - AvailabilityZoneId (string) --
      
      The Availability Zone ID of the Capacity Block extension.
    - CapacityBlockExtensionOfferingId (string) --
      
      The ID of the Capacity Block extension offering.
    - CapacityBlockExtensionDurationHours (integer) --
      
      The duration of the Capacity Block extension in hours.
    - CapacityBlockExtensionStatus (string) --
      
      The status of the Capacity Block extension. A Capacity Block extension can have one of the following statuses:
      - payment-pending - The Capacity Block extension payment is processing. If your payment can't be processed within 12 hours, the Capacity Block extension is failed.
      - payment-failed - Payment for the Capacity Block extension request was not successful.
      - payment-succeeded - Payment for the Capacity Block extension request was successful. You receive an invoice that reflects the one-time upfront payment. In the invoice, you can associate the paid amount with the Capacity Block reservation ID.
    - CapacityBlockExtensionPurchaseDate (datetime) --
      
      The date when the Capacity Block extension was purchased.
    - CapacityBlockExtensionStartDate (datetime) --
      
      The start date of the Capacity Block extension.
    - CapacityBlockExtensionEndDate (datetime) --
      
      The end date of the Capacity Block extension.
    - UpfrontFee (string) --
      
      The total price to be paid up front.
    - CurrencyCode (string) --
      
      The currency of the payment for the Capacity Block extension.
- 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.

CreateCapacityReservation (updated)

Link ¶
Changes (request, response)
Request

{'CommitmentDuration': 'long',
 'DeliveryPreference': 'fixed | incremental',
 'StartDate': 'timestamp'}

Response

{'CapacityReservation': {'CommitmentInfo': {'CommitmentEndDate': 'timestamp',
                                            'CommittedInstanceCount': 'integer'},
                         'DeliveryPreference': 'fixed | incremental',
                         'State': {'delayed', 'assessing', 'unsupported'}}}

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.

You can create a Capacity Reservation at any time, and you can choose when it starts. You can create a Capacity Reservation for immediate use or you can request a Capacity Reservation for a future date.

For more information, see Reserve compute capacity with On-Demand Capacity Reservations in the Amazon EC2 User Guide.

Your request to create a Capacity Reservation could fail if:

Amazon EC2 does not have sufficient capacity. In this case, try again at a later time, try in a different Availability Zone, or request a smaller Capacity Reservation. If your workload is flexible across instance types and sizes, try with different instance attributes.
The requested quantity exceeds your On-Demand Instance quota. In this case, increase your On-Demand Instance quota for the requested instance type and try again. For more information, see Amazon EC2 Service Quotas in the Amazon EC2 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'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro',
    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': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'ipam-external-resource-verification-token',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    DryRun=True|False,
    OutpostArn='string',
    PlacementGroupArn='string',
    StartDate=datetime(2015, 1, 1),
    CommitmentDuration=123,
    DeliveryPreference='fixed'|'incremental'
)

type ClientToken:

string

param ClientToken:

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

type InstanceType:

string

param InstanceType:

[REQUIRED]

The instance type for which to reserve capacity.

For more information, see Instance types in the Amazon EC2 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:

The ID of the Availability Zone in which to create the Capacity Reservation.

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 Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.

type InstanceCount:

integer

param InstanceCount:

[REQUIRED]

The number of instances for which to reserve capacity.

Valid range: 1 - 1000

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:

Deprecated.

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.

If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration.

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. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
- ResourceType (string) --
  
  The type of resource to tag on creation.
- Tags (list) --
  
  The tags to apply to the resource.
  - (dict) --
    
    Describes a tag.
    - Key (string) --
      
      The key of the tag.
      
      Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
    - Value (string) --
      
      The value of the tag.
      
      Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

type DryRun:

boolean

param DryRun:

type OutpostArn:

string

param OutpostArn:

The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.

type PlacementGroupArn:

string

param PlacementGroupArn:

The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.

type StartDate:

datetime

param StartDate:

The date and time at which the future-dated Capacity Reservation should become available for use, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ).

You can request a future-dated Capacity Reservation between 5 and 120 days in advance.

type CommitmentDuration:

integer

param CommitmentDuration:

Specify a commitment duration, in seconds, for the future-dated Capacity Reservation.

The commitment duration is a minimum duration for which you commit to having the future-dated Capacity Reservation in the active state in your account after it has been delivered.

For more information, see Commitment duration.

type DeliveryPreference:

string

param DeliveryPreference:

Indicates that the requested capacity will be delivered in addition to any running instances or reserved capacity that you have in your account at the requested date and time.

The only supported value is incremental.

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'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro',
        'AvailabilityZone': 'string',
        'Tenancy': 'default'|'dedicated',
        'TotalInstanceCount': 123,
        'AvailableInstanceCount': 123,
        'EbsOptimized': True|False,
        'EphemeralStorage': True|False,
        'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported',
        'StartDate': datetime(2015, 1, 1),
        'EndDate': datetime(2015, 1, 1),
        'EndDateType': 'unlimited'|'limited',
        'InstanceMatchCriteria': 'open'|'targeted',
        'CreateDate': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'OutpostArn': 'string',
        'CapacityReservationFleetId': 'string',
        'PlacementGroupArn': 'string',
        'CapacityAllocations': [
            {
                'AllocationType': 'used',
                'Count': 123
            },
        ],
        'ReservationType': 'default'|'capacity-block',
        'UnusedReservationBillingOwnerId': 'string',
        'CommitmentInfo': {
            'CommittedInstanceCount': 123,
            'CommitmentEndDate': datetime(2015, 1, 1)
        },
        'DeliveryPreference': 'fixed'|'incremental'
    }
}

Response Structure

(dict) --
- CapacityReservation (dict) --
  
  Information about the Capacity Reservation.
  - CapacityReservationId (string) --
    
    The ID of the Capacity Reservation.
  - OwnerId (string) --
    
    The ID of the Amazon Web Services account that owns the Capacity Reservation.
  - CapacityReservationArn (string) --
    
    The Amazon Resource Name (ARN) of the Capacity Reservation.
  - AvailabilityZoneId (string) --
    
    The Availability Zone ID of the Capacity Reservation.
  - 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 Amazon Web Services accounts.
    - dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
  - TotalInstanceCount (integer) --
    
    The total 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) --
    
    Deprecated.
  - State (string) --
    
    The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
    - active - The capacity is available for use.
    - expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
    - cancelled - The Capacity Reservation was canceled. 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 can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
    - scheduled - (Future-dated Capacity Reservations only) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
    - assessing - (Future-dated Capacity Reservations only) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
    - delayed - (Future-dated Capacity Reservations only) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
    - unsupported - (Future-dated Capacity Reservations only) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
  - StartDate (datetime) --
    
    The date and time at which the Capacity Reservation was started.
  - 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 256 Unicode characters.
  - OutpostArn (string) --
    
    The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
  - CapacityReservationFleetId (string) --
    
    The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
  - PlacementGroupArn (string) --
    
    The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.
  - CapacityAllocations (list) --
    
    Information about instance capacity usage.
    - (dict) --
      
      Information about instance capacity usage for a Capacity Reservation.
      - AllocationType (string) --
        
        The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
      - Count (integer) --
        
        The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.
  - ReservationType (string) --
    
    The type of Capacity Reservation.
  - UnusedReservationBillingOwnerId (string) --
    
    The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned.
  - CommitmentInfo (dict) --
    
    Information about your commitment for a future-dated Capacity Reservation.
    - CommittedInstanceCount (integer) --
      
      The instance capacity that you committed to when you requested the future-dated Capacity Reservation.
    - CommitmentEndDate (datetime) --
      
      The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ). You can't decrease the instance count or cancel the Capacity Reservation before this date and time.
  - DeliveryPreference (string) --
    
    The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.

CreateCapacityReservationBySplitting (updated)

Link ¶
Changes (response)

{'DestinationCapacityReservation': {'CommitmentInfo': {'CommitmentEndDate': 'timestamp',
                                                       'CommittedInstanceCount': 'integer'},
                                    'DeliveryPreference': 'fixed | incremental',
                                    'State': {'assessing',
                                              'delayed',
                                              'unsupported'}},
 'SourceCapacityReservation': {'CommitmentInfo': {'CommitmentEndDate': 'timestamp',
                                                  'CommittedInstanceCount': 'integer'},
                               'DeliveryPreference': 'fixed | incremental',
                               'State': {'assessing',
                                         'delayed',
                                         'unsupported'}}}

Create a new Capacity Reservation by splitting the capacity of the source Capacity Reservation. The new Capacity Reservation will have the same attributes as the source Capacity Reservation except for tags. The source Capacity Reservation must be active and owned by your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

client.create_capacity_reservation_by_splitting(
    DryRun=True|False,
    ClientToken='string',
    SourceCapacityReservationId='string',
    InstanceCount=123,
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'ipam-external-resource-verification-token',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)

type DryRun:

boolean

param DryRun:

type ClientToken:

string

param ClientToken:

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

This field is autopopulated if not provided.

type SourceCapacityReservationId:

string

param SourceCapacityReservationId:

[REQUIRED]

The ID of the Capacity Reservation from which you want to split the capacity.

type InstanceCount:

integer

param InstanceCount:

[REQUIRED]

The number of instances to split from the source Capacity Reservation.

type TagSpecifications:

list

param TagSpecifications:

The tags to apply to the new Capacity Reservation.

(dict) --

The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
- ResourceType (string) --
  
  The type of resource to tag on creation.
- Tags (list) --
  
  The tags to apply to the resource.
  - (dict) --
    
    Describes a tag.
    - Key (string) --
      
      The key of the tag.
      
      Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
    - Value (string) --
      
      The value of the tag.
      
      Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

rtype:

dict

returns:

Response Syntax

{
    'SourceCapacityReservation': {
        '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'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro',
        'AvailabilityZone': 'string',
        'Tenancy': 'default'|'dedicated',
        'TotalInstanceCount': 123,
        'AvailableInstanceCount': 123,
        'EbsOptimized': True|False,
        'EphemeralStorage': True|False,
        'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported',
        'StartDate': datetime(2015, 1, 1),
        'EndDate': datetime(2015, 1, 1),
        'EndDateType': 'unlimited'|'limited',
        'InstanceMatchCriteria': 'open'|'targeted',
        'CreateDate': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'OutpostArn': 'string',
        'CapacityReservationFleetId': 'string',
        'PlacementGroupArn': 'string',
        'CapacityAllocations': [
            {
                'AllocationType': 'used',
                'Count': 123
            },
        ],
        'ReservationType': 'default'|'capacity-block',
        'UnusedReservationBillingOwnerId': 'string',
        'CommitmentInfo': {
            'CommittedInstanceCount': 123,
            'CommitmentEndDate': datetime(2015, 1, 1)
        },
        'DeliveryPreference': 'fixed'|'incremental'
    },
    'DestinationCapacityReservation': {
        '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'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro',
        'AvailabilityZone': 'string',
        'Tenancy': 'default'|'dedicated',
        'TotalInstanceCount': 123,
        'AvailableInstanceCount': 123,
        'EbsOptimized': True|False,
        'EphemeralStorage': True|False,
        'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported',
        'StartDate': datetime(2015, 1, 1),
        'EndDate': datetime(2015, 1, 1),
        'EndDateType': 'unlimited'|'limited',
        'InstanceMatchCriteria': 'open'|'targeted',
        'CreateDate': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'OutpostArn': 'string',
        'CapacityReservationFleetId': 'string',
        'PlacementGroupArn': 'string',
        'CapacityAllocations': [
            {
                'AllocationType': 'used',
                'Count': 123
            },
        ],
        'ReservationType': 'default'|'capacity-block',
        'UnusedReservationBillingOwnerId': 'string',
        'CommitmentInfo': {
            'CommittedInstanceCount': 123,
            'CommitmentEndDate': datetime(2015, 1, 1)
        },
        'DeliveryPreference': 'fixed'|'incremental'
    },
    'InstanceCount': 123
}

Response Structure

(dict) --
- SourceCapacityReservation (dict) --
  
  Information about the source Capacity Reservation.
  - CapacityReservationId (string) --
    
    The ID of the Capacity Reservation.
  - OwnerId (string) --
    
    The ID of the Amazon Web Services account that owns the Capacity Reservation.
  - CapacityReservationArn (string) --
    
    The Amazon Resource Name (ARN) of the Capacity Reservation.
  - AvailabilityZoneId (string) --
    
    The Availability Zone ID of the Capacity Reservation.
  - 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 Amazon Web Services accounts.
    - dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
  - TotalInstanceCount (integer) --
    
    The total 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) --
    
    Deprecated.
  - State (string) --
    
    The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
    - active - The capacity is available for use.
    - expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
    - cancelled - The Capacity Reservation was canceled. 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 can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
    - scheduled - (Future-dated Capacity Reservations only) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
    - assessing - (Future-dated Capacity Reservations only) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
    - delayed - (Future-dated Capacity Reservations only) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
    - unsupported - (Future-dated Capacity Reservations only) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
  - StartDate (datetime) --
    
    The date and time at which the Capacity Reservation was started.
  - 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 256 Unicode characters.
  - OutpostArn (string) --
    
    The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
  - CapacityReservationFleetId (string) --
    
    The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
  - PlacementGroupArn (string) --
    
    The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.
  - CapacityAllocations (list) --
    
    Information about instance capacity usage.
    - (dict) --
      
      Information about instance capacity usage for a Capacity Reservation.
      - AllocationType (string) --
        
        The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
      - Count (integer) --
        
        The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.
  - ReservationType (string) --
    
    The type of Capacity Reservation.
  - UnusedReservationBillingOwnerId (string) --
    
    The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned.
  - CommitmentInfo (dict) --
    
    Information about your commitment for a future-dated Capacity Reservation.
    - CommittedInstanceCount (integer) --
      
      The instance capacity that you committed to when you requested the future-dated Capacity Reservation.
    - CommitmentEndDate (datetime) --
      
      The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ). You can't decrease the instance count or cancel the Capacity Reservation before this date and time.
  - DeliveryPreference (string) --
    
    The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.
- DestinationCapacityReservation (dict) --
  
  Information about the destination Capacity Reservation.
  - CapacityReservationId (string) --
    
    The ID of the Capacity Reservation.
  - OwnerId (string) --
    
    The ID of the Amazon Web Services account that owns the Capacity Reservation.
  - CapacityReservationArn (string) --
    
    The Amazon Resource Name (ARN) of the Capacity Reservation.
  - AvailabilityZoneId (string) --
    
    The Availability Zone ID of the Capacity Reservation.
  - 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 Amazon Web Services accounts.
    - dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
  - TotalInstanceCount (integer) --
    
    The total 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) --
    
    Deprecated.
  - State (string) --
    
    The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
    - active - The capacity is available for use.
    - expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
    - cancelled - The Capacity Reservation was canceled. 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 can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
    - scheduled - (Future-dated Capacity Reservations only) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
    - assessing - (Future-dated Capacity Reservations only) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
    - delayed - (Future-dated Capacity Reservations only) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
    - unsupported - (Future-dated Capacity Reservations only) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
  - StartDate (datetime) --
    
    The date and time at which the Capacity Reservation was started.
  - 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 256 Unicode characters.
  - OutpostArn (string) --
    
    The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
  - CapacityReservationFleetId (string) --
    
    The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
  - PlacementGroupArn (string) --
    
    The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.
  - CapacityAllocations (list) --
    
    Information about instance capacity usage.
    - (dict) --
      
      Information about instance capacity usage for a Capacity Reservation.
      - AllocationType (string) --
        
        The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
      - Count (integer) --
        
        The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.
  - ReservationType (string) --
    
    The type of Capacity Reservation.
  - UnusedReservationBillingOwnerId (string) --
    
    The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned.
  - CommitmentInfo (dict) --
    
    Information about your commitment for a future-dated Capacity Reservation.
    - CommittedInstanceCount (integer) --
      
      The instance capacity that you committed to when you requested the future-dated Capacity Reservation.
    - CommitmentEndDate (datetime) --
      
      The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ). You can't decrease the instance count or cancel the Capacity Reservation before this date and time.
  - DeliveryPreference (string) --
    
    The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.
- InstanceCount (integer) --
  
  The number of instances in the new Capacity Reservation. The number of instances in the source Capacity Reservation was reduced by this amount.

CreateIpamResourceDiscovery (updated)

Link ¶
Changes (response)

{'IpamResourceDiscovery': {'OrganizationalUnitExclusions': [{'OrganizationsEntityPath': 'string'}]}}

Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

See also: AWS API Documentation

Request Syntax

client.create_ipam_resource_discovery(
    DryRun=True|False,
    Description='string',
    OperatingRegions=[
        {
            'RegionName': 'string'
        },
    ],
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'ipam-external-resource-verification-token',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    ClientToken='string'
)

type DryRun:

boolean

param DryRun:

A check for 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 Description:

string

param Description:

A description for the IPAM resource discovery.

type OperatingRegions:

list

param OperatingRegions:

Operating Regions for the IPAM resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

(dict) --

Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
- RegionName (string) --
  
  The name of the operating Region.

type TagSpecifications:

list

param TagSpecifications:

Tag specifications for the IPAM resource discovery.

(dict) --

The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
- ResourceType (string) --
  
  The type of resource to tag on creation.
- Tags (list) --
  
  The tags to apply to the resource.
  - (dict) --
    
    Describes a tag.
    - Key (string) --
      
      The key of the tag.
      
      Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
    - Value (string) --
      
      The value of the tag.
      
      Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

type ClientToken:

string

param ClientToken:

A client token for the IPAM resource discovery.

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'IpamResourceDiscovery': {
        'OwnerId': 'string',
        'IpamResourceDiscoveryId': 'string',
        'IpamResourceDiscoveryArn': 'string',
        'IpamResourceDiscoveryRegion': 'string',
        'Description': 'string',
        'OperatingRegions': [
            {
                'RegionName': 'string'
            },
        ],
        'IsDefault': True|False,
        'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'OrganizationalUnitExclusions': [
            {
                'OrganizationsEntityPath': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- IpamResourceDiscovery (dict) --
  
  An IPAM resource discovery.
  - OwnerId (string) --
    
    The ID of the owner.
  - IpamResourceDiscoveryId (string) --
    
    The resource discovery ID.
  - IpamResourceDiscoveryArn (string) --
    
    The resource discovery Amazon Resource Name (ARN).
  - IpamResourceDiscoveryRegion (string) --
    
    The resource discovery Region.
  - Description (string) --
    
    The resource discovery description.
  - OperatingRegions (list) --
    
    The operating Regions for the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
    - (dict) --
      
      The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
      
      For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
      - RegionName (string) --
        
        The name of the operating Region.
  - IsDefault (boolean) --
    
    Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.
  - State (string) --
    
    The lifecycle state of the resource discovery.
    - create-in-progress - Resource discovery is being created.
    - create-complete - Resource discovery creation is complete.
    - create-failed - Resource discovery creation has failed.
    - modify-in-progress - Resource discovery is being modified.
    - modify-complete - Resource discovery modification is complete.
    - modify-failed - Resource discovery modification has failed.
    - delete-in-progress - Resource discovery is being deleted.
    - delete-complete - Resource discovery deletion is complete.
    - delete-failed - Resource discovery deletion has failed.
    - isolate-in-progress - Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated.
    - isolate-complete - Resource discovery isolation is complete.
    - restore-in-progress - Amazon Web Services account that created the resource discovery and was isolated has been restored.
  - Tags (list) --
    
    A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
    - (dict) --
      
      Describes a tag.
      - Key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) --
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
  - OrganizationalUnitExclusions (list) --
    
    If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.
    - (dict) --
      
      If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.
      - OrganizationsEntityPath (string) --
        
        An Amazon Web Services Organizations entity path. For more information on the entity path, see Understand the Amazon Web Services Organizations entity path in the Amazon Web Services Identity and Access Management User Guide.

DeleteIpamResourceDiscovery (updated)

Link ¶
Changes (response)

{'IpamResourceDiscovery': {'OrganizationalUnitExclusions': [{'OrganizationsEntityPath': 'string'}]}}

Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

See also: AWS API Documentation

Request Syntax

client.delete_ipam_resource_discovery(
    DryRun=True|False,
    IpamResourceDiscoveryId='string'
)

type DryRun:

boolean

param DryRun:

type IpamResourceDiscoveryId:

string

param IpamResourceDiscoveryId:

[REQUIRED]

The IPAM resource discovery ID.

rtype:

dict

returns:

Response Syntax

{
    'IpamResourceDiscovery': {
        'OwnerId': 'string',
        'IpamResourceDiscoveryId': 'string',
        'IpamResourceDiscoveryArn': 'string',
        'IpamResourceDiscoveryRegion': 'string',
        'Description': 'string',
        'OperatingRegions': [
            {
                'RegionName': 'string'
            },
        ],
        'IsDefault': True|False,
        'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'OrganizationalUnitExclusions': [
            {
                'OrganizationsEntityPath': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- IpamResourceDiscovery (dict) --
  
  The IPAM resource discovery.
  - OwnerId (string) --
    
    The ID of the owner.
  - IpamResourceDiscoveryId (string) --
    
    The resource discovery ID.
  - IpamResourceDiscoveryArn (string) --
    
    The resource discovery Amazon Resource Name (ARN).
  - IpamResourceDiscoveryRegion (string) --
    
    The resource discovery Region.
  - Description (string) --
    
    The resource discovery description.
  - OperatingRegions (list) --
    
    The operating Regions for the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
    - (dict) --
      
      The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
      
      For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
      - RegionName (string) --
        
        The name of the operating Region.
  - IsDefault (boolean) --
    
    Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.
  - State (string) --
    
    The lifecycle state of the resource discovery.
    - create-in-progress - Resource discovery is being created.
    - create-complete - Resource discovery creation is complete.
    - create-failed - Resource discovery creation has failed.
    - modify-in-progress - Resource discovery is being modified.
    - modify-complete - Resource discovery modification is complete.
    - modify-failed - Resource discovery modification has failed.
    - delete-in-progress - Resource discovery is being deleted.
    - delete-complete - Resource discovery deletion is complete.
    - delete-failed - Resource discovery deletion has failed.
    - isolate-in-progress - Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated.
    - isolate-complete - Resource discovery isolation is complete.
    - restore-in-progress - Amazon Web Services account that created the resource discovery and was isolated has been restored.
  - Tags (list) --
    
    A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
    - (dict) --
      
      Describes a tag.
      - Key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) --
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
  - OrganizationalUnitExclusions (list) --
    
    If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.
    - (dict) --
      
      If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.
      - OrganizationsEntityPath (string) --
        
        An Amazon Web Services Organizations entity path. For more information on the entity path, see Understand the Amazon Web Services Organizations entity path in the Amazon Web Services Identity and Access Management User Guide.

DescribeCapacityBlockOfferings (updated)

Link ¶
Changes (response)

{'CapacityBlockOfferings': {'CapacityBlockDurationMinutes': 'integer'}}

Describes Capacity Block offerings available for purchase in the Amazon Web Services Region that you're currently using. With Capacity Blocks, you purchase a specific instance type for a period of time.

See also: AWS API Documentation

Request Syntax

client.describe_capacity_block_offerings(
    DryRun=True|False,
    InstanceType='string',
    InstanceCount=123,
    StartDateRange=datetime(2015, 1, 1),
    EndDateRange=datetime(2015, 1, 1),
    CapacityDurationHours=123,
    NextToken='string',
    MaxResults=123
)

type DryRun:

boolean

param DryRun:

type InstanceType:

string

param InstanceType:

The type of instance for which the Capacity Block offering reserves capacity.

type InstanceCount:

integer

param InstanceCount:

The number of instances for which to reserve capacity.

type StartDateRange:

datetime

param StartDateRange:

The earliest start date for the Capacity Block offering.

type EndDateRange:

datetime

param EndDateRange:

The latest end date for the Capacity Block offering.

type CapacityDurationHours:

integer

param CapacityDurationHours:

[REQUIRED]

The number of hours for which to reserve Capacity Block.

type NextToken:

string

param NextToken:

The token to use to retrieve the next page of results.

type MaxResults:

integer

param MaxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

rtype:

dict

returns:

Response Syntax

{
    'CapacityBlockOfferings': [
        {
            'CapacityBlockOfferingId': 'string',
            'InstanceType': 'string',
            'AvailabilityZone': 'string',
            'InstanceCount': 123,
            'StartDate': datetime(2015, 1, 1),
            'EndDate': datetime(2015, 1, 1),
            'CapacityBlockDurationHours': 123,
            'UpfrontFee': 'string',
            'CurrencyCode': 'string',
            'Tenancy': 'default'|'dedicated',
            'CapacityBlockDurationMinutes': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- CapacityBlockOfferings (list) --
  
  The recommended Capacity Block offering for the dates specified.
  - (dict) --
    
    The recommended Capacity Block that fits your search requirements.
    - CapacityBlockOfferingId (string) --
      
      The ID of the Capacity Block offering.
    - InstanceType (string) --
      
      The instance type of the Capacity Block offering.
    - AvailabilityZone (string) --
      
      The Availability Zone of the Capacity Block offering.
    - InstanceCount (integer) --
      
      The number of instances in the Capacity Block offering.
    - StartDate (datetime) --
      
      The start date of the Capacity Block offering.
    - EndDate (datetime) --
      
      The end date of the Capacity Block offering.
    - CapacityBlockDurationHours (integer) --
      
      The number of hours (in addition to capacityBlockDurationMinutes) for the duration of the Capacity Block reservation. For example, if a Capacity Block starts at 04:55 and ends at 11:30, the hours field would be 6.
    - UpfrontFee (string) --
      
      The total price to be paid up front.
    - CurrencyCode (string) --
      
      The currency of the payment for the Capacity Block.
    - Tenancy (string) --
      
      The tenancy of the Capacity Block.
    - CapacityBlockDurationMinutes (integer) --
      
      The number of minutes (in addition to capacityBlockDurationHours) for the duration of the Capacity Block reservation. For example, if a Capacity Block starts at 08:55 and ends at 11:30, the minutes field would be 35.
- 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.

DescribeCapacityReservations (updated)

Link ¶
Changes (response)

{'CapacityReservations': {'CommitmentInfo': {'CommitmentEndDate': 'timestamp',
                                             'CommittedInstanceCount': 'integer'},
                          'DeliveryPreference': 'fixed | incremental',
                          'State': {'delayed', 'assessing', 'unsupported'}}}

Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the Amazon Web Services 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 use to retrieve the next page of results.

type MaxResults:

integer

param MaxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

type Filters:

list

param Filters:

One or more filters.

instance-type - The type of instance for which the Capacity Reservation reserves capacity.
owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
availability-zone - The Availability Zone of the Capacity Reservation.
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 Amazon Web Services accounts.
- dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
state - 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.
- expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
- cancelled - The Capacity Reservation was 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.
start-date - The date and time at which the Capacity Reservation was started.
end-date - 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.
end-date-type - 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.
instance-match-criteria - 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.
placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was created.

(dict) --

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

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

type DryRun:

boolean

param DryRun:

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'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro',
            'AvailabilityZone': 'string',
            'Tenancy': 'default'|'dedicated',
            'TotalInstanceCount': 123,
            'AvailableInstanceCount': 123,
            'EbsOptimized': True|False,
            'EphemeralStorage': True|False,
            'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported',
            'StartDate': datetime(2015, 1, 1),
            'EndDate': datetime(2015, 1, 1),
            'EndDateType': 'unlimited'|'limited',
            'InstanceMatchCriteria': 'open'|'targeted',
            'CreateDate': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'OutpostArn': 'string',
            'CapacityReservationFleetId': 'string',
            'PlacementGroupArn': 'string',
            'CapacityAllocations': [
                {
                    'AllocationType': 'used',
                    'Count': 123
                },
            ],
            'ReservationType': 'default'|'capacity-block',
            'UnusedReservationBillingOwnerId': 'string',
            'CommitmentInfo': {
                'CommittedInstanceCount': 123,
                'CommitmentEndDate': datetime(2015, 1, 1)
            },
            'DeliveryPreference': 'fixed'|'incremental'
        },
    ]
}

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) --
      
      The ID of the Amazon Web Services account that owns the Capacity Reservation.
    - CapacityReservationArn (string) --
      
      The Amazon Resource Name (ARN) of the Capacity Reservation.
    - AvailabilityZoneId (string) --
      
      The Availability Zone ID of the Capacity Reservation.
    - 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 Amazon Web Services accounts.
      - dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
    - TotalInstanceCount (integer) --
      
      The total 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) --
      
      Deprecated.
    - State (string) --
      
      The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
      - active - The capacity is available for use.
      - expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
      - cancelled - The Capacity Reservation was canceled. 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 can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
      - scheduled - (Future-dated Capacity Reservations only) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
      - assessing - (Future-dated Capacity Reservations only) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
      - delayed - (Future-dated Capacity Reservations only) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
      - unsupported - (Future-dated Capacity Reservations only) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
    - StartDate (datetime) --
      
      The date and time at which the Capacity Reservation was started.
    - 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 256 Unicode characters.
    - OutpostArn (string) --
      
      The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
    - CapacityReservationFleetId (string) --
      
      The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
    - PlacementGroupArn (string) --
      
      The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.
    - CapacityAllocations (list) --
      
      Information about instance capacity usage.
      - (dict) --
        
        Information about instance capacity usage for a Capacity Reservation.
        
        AllocationType (string) --
        
        The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
        
        Count (integer) --
        
        The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.
    - ReservationType (string) --
      
      The type of Capacity Reservation.
    - UnusedReservationBillingOwnerId (string) --
      
      The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned.
    - CommitmentInfo (dict) --
      
      Information about your commitment for a future-dated Capacity Reservation.
      - CommittedInstanceCount (integer) --
        
        The instance capacity that you committed to when you requested the future-dated Capacity Reservation.
      - CommitmentEndDate (datetime) --
        
        The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ). You can't decrease the instance count or cancel the Capacity Reservation before this date and time.
    - DeliveryPreference (string) --
      
      The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.

DescribeIpamResourceDiscoveries (updated)

Link ¶
Changes (response)

{'IpamResourceDiscoveries': {'OrganizationalUnitExclusions': [{'OrganizationsEntityPath': 'string'}]}}

Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

See also: AWS API Documentation

Request Syntax

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

type DryRun:

boolean

param DryRun:

type IpamResourceDiscoveryIds:

list

param IpamResourceDiscoveryIds:

The IPAM resource discovery IDs.

(string) --

type NextToken:

string

param NextToken:

Specify the pagination token from a previous request to retrieve the next page of results.

type MaxResults:

integer

param MaxResults:

The maximum number of resource discoveries to return in one page of results.

type Filters:

list

param Filters:

The resource discovery 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.

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

rtype:

dict

returns:

Response Syntax

{
    'IpamResourceDiscoveries': [
        {
            'OwnerId': 'string',
            'IpamResourceDiscoveryId': 'string',
            'IpamResourceDiscoveryArn': 'string',
            'IpamResourceDiscoveryRegion': 'string',
            'Description': 'string',
            'OperatingRegions': [
                {
                    'RegionName': 'string'
                },
            ],
            'IsDefault': True|False,
            'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'OrganizationalUnitExclusions': [
                {
                    'OrganizationsEntityPath': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- IpamResourceDiscoveries (list) --
  
  The resource discoveries.
  - (dict) --
    
    A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
    - OwnerId (string) --
      
      The ID of the owner.
    - IpamResourceDiscoveryId (string) --
      
      The resource discovery ID.
    - IpamResourceDiscoveryArn (string) --
      
      The resource discovery Amazon Resource Name (ARN).
    - IpamResourceDiscoveryRegion (string) --
      
      The resource discovery Region.
    - Description (string) --
      
      The resource discovery description.
    - OperatingRegions (list) --
      
      The operating Regions for the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
      - (dict) --
        
        The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
        
        For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
        
        RegionName (string) --
        
        The name of the operating Region.
    - IsDefault (boolean) --
      
      Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.
    - State (string) --
      
      The lifecycle state of the resource discovery.
      - create-in-progress - Resource discovery is being created.
      - create-complete - Resource discovery creation is complete.
      - create-failed - Resource discovery creation has failed.
      - modify-in-progress - Resource discovery is being modified.
      - modify-complete - Resource discovery modification is complete.
      - modify-failed - Resource discovery modification has failed.
      - delete-in-progress - Resource discovery is being deleted.
      - delete-complete - Resource discovery deletion is complete.
      - delete-failed - Resource discovery deletion has failed.
      - isolate-in-progress - Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated.
      - isolate-complete - Resource discovery isolation is complete.
      - restore-in-progress - Amazon Web Services account that created the resource discovery and was isolated has been restored.
    - Tags (list) --
      
      A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
      - (dict) --
        
        Describes a tag.
        
        Key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) --
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
    - OrganizationalUnitExclusions (list) --
      
      If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.
      - (dict) --
        
        If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.
        
        OrganizationsEntityPath (string) --
        
        An Amazon Web Services Organizations entity path. For more information on the entity path, see Understand the Amazon Web Services Organizations entity path in the Amazon Web Services Identity and Access Management User Guide.
- NextToken (string) --
  
  Specify the pagination token from a previous request to retrieve the next page of results.

GetCapacityReservationUsage (updated)

Link ¶
Changes (response)

{'State': {'delayed', 'assessing', 'unsupported'}}

Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each Amazon Web Services account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner's usage.

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]

The ID of the Capacity Reservation.

type NextToken:

string

param NextToken:

The token to use to retrieve the next page of results.

type MaxResults:

integer

param MaxResults:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

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'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported',
    'InstanceUsages': [
        {
            'AccountId': 'string',
            'UsedInstanceCount': 123
        },
    ]
}

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.
- CapacityReservationId (string) --
  
  The ID of the Capacity Reservation.
- InstanceType (string) --
  
  The type of instance for which the Capacity Reservation reserves capacity.
- 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.
- State (string) --
  
  The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
  - active - The capacity is available for use.
  - expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
  - cancelled - The Capacity Reservation was canceled. 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 can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
  - scheduled - (Future-dated Capacity Reservations only) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
  - assessing - (Future-dated Capacity Reservations only) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
  - delayed - (Future-dated Capacity Reservations only) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
  - unsupported - (Future-dated Capacity Reservations only) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
- InstanceUsages (list) --
  
  Information about the Capacity Reservation usage.
  - (dict) --
    
    Information about the Capacity Reservation usage.
    - AccountId (string) --
      
      The ID of the Amazon Web Services account that is making use of the Capacity Reservation.
    - UsedInstanceCount (integer) --
      
      The number of instances the Amazon Web Services account currently has in the Capacity Reservation.

GetIpamDiscoveredAccounts (updated)

Link ¶
Changes (response)

{'IpamDiscoveredAccounts': {'OrganizationalUnitId': 'string'}}

Gets IPAM discovered accounts. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization.

See also: AWS API Documentation

Request Syntax

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

type DryRun:

boolean

param DryRun:

type IpamResourceDiscoveryId:

string

param IpamResourceDiscoveryId:

[REQUIRED]

A resource discovery ID.

type DiscoveryRegion:

string

param DiscoveryRegion:

[REQUIRED]

The Amazon Web Services Region that the account information is returned from.

type Filters:

list

param Filters:

Discovered account 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.

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

type NextToken:

string

param NextToken:

Specify the pagination token from a previous request to retrieve the next page of results.

type MaxResults:

integer

param MaxResults:

The maximum number of discovered accounts to return in one page of results.

rtype:

dict

returns:

Response Syntax

{
    'IpamDiscoveredAccounts': [
        {
            'AccountId': 'string',
            'DiscoveryRegion': 'string',
            'FailureReason': {
                'Code': 'assume-role-failure'|'throttling-failure'|'unauthorized-failure',
                'Message': 'string'
            },
            'LastAttemptedDiscoveryTime': datetime(2015, 1, 1),
            'LastSuccessfulDiscoveryTime': datetime(2015, 1, 1),
            'OrganizationalUnitId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- IpamDiscoveredAccounts (list) --
  
  Discovered accounts.
  - (dict) --
    
    An IPAM discovered account. A discovered account is an Amazon Web Services account that is monitored under a resource discovery. If you have integrated IPAM with Amazon Web Services Organizations, all accounts in the organization are discovered accounts.
    - AccountId (string) --
      
      The account ID.
    - DiscoveryRegion (string) --
      
      The Amazon Web Services Region that the account information is returned from. An account can be discovered in multiple regions and will have a separate discovered account for each Region.
    - FailureReason (dict) --
      
      The resource discovery failure reason.
      - Code (string) --
        
        The discovery failure code.
        
        assume-role-failure - IPAM could not assume the Amazon Web Services IAM service-linked role. This could be because of any of the following:
        
        SLR has not been created yet and IPAM is still creating it.
        
        You have opted-out of the IPAM home Region.
        
        Account you are using as your IPAM account has been suspended.
        
        throttling-failure - IPAM account is already using the allotted transactions per second and IPAM is receiving a throttling error when assuming the Amazon Web Services IAM SLR.
        
        unauthorized-failure - Amazon Web Services account making the request is not authorized. For more information, see AuthFailure in the Amazon Elastic Compute Cloud API Reference.
      - Message (string) --
        
        The discovery failure message.
    - LastAttemptedDiscoveryTime (datetime) --
      
      The last attempted resource discovery time.
    - LastSuccessfulDiscoveryTime (datetime) --
      
      The last successful resource discovery time.
    - OrganizationalUnitId (string) --
      
      The ID of an Organizational Unit in Amazon Web Services Organizations.
- NextToken (string) --
  
  Specify the pagination token from a previous request to retrieve the next page of results.

ModifyIpamResourceDiscovery (updated)

Link ¶
Changes (request, response)
Request

{'AddOrganizationalUnitExclusions': [{'OrganizationsEntityPath': 'string'}],
 'RemoveOrganizationalUnitExclusions': [{'OrganizationsEntityPath': 'string'}]}

Response

{'IpamResourceDiscovery': {'OrganizationalUnitExclusions': [{'OrganizationsEntityPath': 'string'}]}}

Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

See also: AWS API Documentation

Request Syntax

client.modify_ipam_resource_discovery(
    DryRun=True|False,
    IpamResourceDiscoveryId='string',
    Description='string',
    AddOperatingRegions=[
        {
            'RegionName': 'string'
        },
    ],
    RemoveOperatingRegions=[
        {
            'RegionName': 'string'
        },
    ],
    AddOrganizationalUnitExclusions=[
        {
            'OrganizationsEntityPath': 'string'
        },
    ],
    RemoveOrganizationalUnitExclusions=[
        {
            'OrganizationsEntityPath': 'string'
        },
    ]
)

type DryRun:

boolean

param DryRun:

type IpamResourceDiscoveryId:

string

param IpamResourceDiscoveryId:

[REQUIRED]

A resource discovery ID.

type Description:

string

param Description:

A resource discovery description.

type AddOperatingRegions:

list

param AddOperatingRegions:

Add operating Regions to the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

(dict) --

Add an operating Region to an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
- RegionName (string) --
  
  The name of the operating Region.

type RemoveOperatingRegions:

list

param RemoveOperatingRegions:

Remove operating Regions.

(dict) --

Remove an operating Region from an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide
- RegionName (string) --
  
  The name of the operating Region you want to remove.

type AddOrganizationalUnitExclusions:

list

param AddOrganizationalUnitExclusions:

Add an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

(dict) --

Add an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
- OrganizationsEntityPath (string) --
  
  An Amazon Web Services Organizations entity path. Build the path for the OU(s) using Amazon Web Services Organizations IDs separated by a /. Include all child OUs by ending the path with /*.
  - Example 1
    - Path to a child OU: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/
    - In this example, o-a1b2c3d4e5 is the organization ID, r-f6g7h8i9j0example is the root ID , ou-ghi0-awsccccc is an OU ID, and ou-jkl0-awsddddd is a child OU ID.
    - IPAM will not manage the IP addresses in accounts in the child OU.
  - Example 2
    - Path where all child OUs will be part of the exclusion: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/*
    - In this example, IPAM will not manage the IP addresses in accounts in the OU ( ou-ghi0-awsccccc) or in accounts in any OUs that are children of the OU.
  For more information on how to construct an entity path, see Understand the Amazon Web Services Organizations entity path in the Amazon Web Services Identity and Access Management User Guide.

type RemoveOrganizationalUnitExclusions:

list

param RemoveOrganizationalUnitExclusions:

Remove an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

(dict) --

Remove an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.
- OrganizationsEntityPath (string) --
  
  An Amazon Web Services Organizations entity path. Build the path for the OU(s) using Amazon Web Services Organizations IDs separated by a /. Include all child OUs by ending the path with /*.
  - Example 1
    - Path to a child OU: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/
    - In this example, o-a1b2c3d4e5 is the organization ID, r-f6g7h8i9j0example is the root ID , ou-ghi0-awsccccc is an OU ID, and ou-jkl0-awsddddd is a child OU ID.
    - IPAM will not manage the IP addresses in accounts in the child OU.
  - Example 2
    - Path where all child OUs will be part of the exclusion: o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/*
    - In this example, IPAM will not manage the IP addresses in accounts in the OU ( ou-ghi0-awsccccc) or in accounts in any OUs that are children of the OU.
  For more information on how to construct an entity path, see Understand the Amazon Web Services Organizations entity path in the Amazon Web Services Identity and Access Management User Guide.

rtype:

dict

returns:

Response Syntax

{
    'IpamResourceDiscovery': {
        'OwnerId': 'string',
        'IpamResourceDiscoveryId': 'string',
        'IpamResourceDiscoveryArn': 'string',
        'IpamResourceDiscoveryRegion': 'string',
        'Description': 'string',
        'OperatingRegions': [
            {
                'RegionName': 'string'
            },
        ],
        'IsDefault': True|False,
        'State': 'create-in-progress'|'create-complete'|'create-failed'|'modify-in-progress'|'modify-complete'|'modify-failed'|'delete-in-progress'|'delete-complete'|'delete-failed'|'isolate-in-progress'|'isolate-complete'|'restore-in-progress',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'OrganizationalUnitExclusions': [
            {
                'OrganizationsEntityPath': 'string'
            },
        ]
    }
}

Response Structure

(dict) --
- IpamResourceDiscovery (dict) --
  
  A resource discovery.
  - OwnerId (string) --
    
    The ID of the owner.
  - IpamResourceDiscoveryId (string) --
    
    The resource discovery ID.
  - IpamResourceDiscoveryArn (string) --
    
    The resource discovery Amazon Resource Name (ARN).
  - IpamResourceDiscoveryRegion (string) --
    
    The resource discovery Region.
  - Description (string) --
    
    The resource discovery description.
  - OperatingRegions (list) --
    
    The operating Regions for the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
    - (dict) --
      
      The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
      
      For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
      - RegionName (string) --
        
        The name of the operating Region.
  - IsDefault (boolean) --
    
    Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.
  - State (string) --
    
    The lifecycle state of the resource discovery.
    - create-in-progress - Resource discovery is being created.
    - create-complete - Resource discovery creation is complete.
    - create-failed - Resource discovery creation has failed.
    - modify-in-progress - Resource discovery is being modified.
    - modify-complete - Resource discovery modification is complete.
    - modify-failed - Resource discovery modification has failed.
    - delete-in-progress - Resource discovery is being deleted.
    - delete-complete - Resource discovery deletion is complete.
    - delete-failed - Resource discovery deletion has failed.
    - isolate-in-progress - Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated.
    - isolate-complete - Resource discovery isolation is complete.
    - restore-in-progress - Amazon Web Services account that created the resource discovery and was isolated has been restored.
  - Tags (list) --
    
    A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
    - (dict) --
      
      Describes a tag.
      - Key (string) --
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
      - Value (string) --
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
  - OrganizationalUnitExclusions (list) --
    
    If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.
    - (dict) --
      
      If your IPAM is integrated with Amazon Web Services Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion.
      - OrganizationsEntityPath (string) --
        
        An Amazon Web Services Organizations entity path. For more information on the entity path, see Understand the Amazon Web Services Organizations entity path in the Amazon Web Services Identity and Access Management User Guide.

MoveCapacityReservationInstances (updated)

Link ¶
Changes (response)

{'DestinationCapacityReservation': {'CommitmentInfo': {'CommitmentEndDate': 'timestamp',
                                                       'CommittedInstanceCount': 'integer'},
                                    'DeliveryPreference': 'fixed | incremental',
                                    'State': {'assessing',
                                              'delayed',
                                              'unsupported'}},
 'SourceCapacityReservation': {'CommitmentInfo': {'CommitmentEndDate': 'timestamp',
                                                  'CommittedInstanceCount': 'integer'},
                               'DeliveryPreference': 'fixed | incremental',
                               'State': {'assessing',
                                         'delayed',
                                         'unsupported'}}}

Move available capacity from a source Capacity Reservation to a destination Capacity Reservation. The source Capacity Reservation and the destination Capacity Reservation must be active, owned by your Amazon Web Services account, and share the following:

Instance type
Platform
Availability Zone
Tenancy
Placement group
Capacity Reservation end time - At specific time or Manually.

See also: AWS API Documentation

Request Syntax

client.move_capacity_reservation_instances(
    DryRun=True|False,
    ClientToken='string',
    SourceCapacityReservationId='string',
    DestinationCapacityReservationId='string',
    InstanceCount=123
)

type DryRun:

boolean

param DryRun:

type ClientToken:

string

param ClientToken:

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

This field is autopopulated if not provided.

type SourceCapacityReservationId:

string

param SourceCapacityReservationId:

[REQUIRED]

The ID of the Capacity Reservation from which you want to move capacity.

type DestinationCapacityReservationId:

string

param DestinationCapacityReservationId:

[REQUIRED]

The ID of the Capacity Reservation that you want to move capacity into.

type InstanceCount:

integer

param InstanceCount:

[REQUIRED]

The number of instances that you want to move from the source Capacity Reservation.

rtype:

dict

returns:

Response Syntax

{
    'SourceCapacityReservation': {
        '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'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro',
        'AvailabilityZone': 'string',
        'Tenancy': 'default'|'dedicated',
        'TotalInstanceCount': 123,
        'AvailableInstanceCount': 123,
        'EbsOptimized': True|False,
        'EphemeralStorage': True|False,
        'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported',
        'StartDate': datetime(2015, 1, 1),
        'EndDate': datetime(2015, 1, 1),
        'EndDateType': 'unlimited'|'limited',
        'InstanceMatchCriteria': 'open'|'targeted',
        'CreateDate': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'OutpostArn': 'string',
        'CapacityReservationFleetId': 'string',
        'PlacementGroupArn': 'string',
        'CapacityAllocations': [
            {
                'AllocationType': 'used',
                'Count': 123
            },
        ],
        'ReservationType': 'default'|'capacity-block',
        'UnusedReservationBillingOwnerId': 'string',
        'CommitmentInfo': {
            'CommittedInstanceCount': 123,
            'CommitmentEndDate': datetime(2015, 1, 1)
        },
        'DeliveryPreference': 'fixed'|'incremental'
    },
    'DestinationCapacityReservation': {
        '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'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro',
        'AvailabilityZone': 'string',
        'Tenancy': 'default'|'dedicated',
        'TotalInstanceCount': 123,
        'AvailableInstanceCount': 123,
        'EbsOptimized': True|False,
        'EphemeralStorage': True|False,
        'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported',
        'StartDate': datetime(2015, 1, 1),
        'EndDate': datetime(2015, 1, 1),
        'EndDateType': 'unlimited'|'limited',
        'InstanceMatchCriteria': 'open'|'targeted',
        'CreateDate': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'OutpostArn': 'string',
        'CapacityReservationFleetId': 'string',
        'PlacementGroupArn': 'string',
        'CapacityAllocations': [
            {
                'AllocationType': 'used',
                'Count': 123
            },
        ],
        'ReservationType': 'default'|'capacity-block',
        'UnusedReservationBillingOwnerId': 'string',
        'CommitmentInfo': {
            'CommittedInstanceCount': 123,
            'CommitmentEndDate': datetime(2015, 1, 1)
        },
        'DeliveryPreference': 'fixed'|'incremental'
    },
    'InstanceCount': 123
}

Response Structure

(dict) --
- SourceCapacityReservation (dict) --
  
  Information about the source Capacity Reservation.
  - CapacityReservationId (string) --
    
    The ID of the Capacity Reservation.
  - OwnerId (string) --
    
    The ID of the Amazon Web Services account that owns the Capacity Reservation.
  - CapacityReservationArn (string) --
    
    The Amazon Resource Name (ARN) of the Capacity Reservation.
  - AvailabilityZoneId (string) --
    
    The Availability Zone ID of the Capacity Reservation.
  - 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 Amazon Web Services accounts.
    - dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
  - TotalInstanceCount (integer) --
    
    The total 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) --
    
    Deprecated.
  - State (string) --
    
    The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
    - active - The capacity is available for use.
    - expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
    - cancelled - The Capacity Reservation was canceled. 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 can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
    - scheduled - (Future-dated Capacity Reservations only) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
    - assessing - (Future-dated Capacity Reservations only) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
    - delayed - (Future-dated Capacity Reservations only) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
    - unsupported - (Future-dated Capacity Reservations only) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
  - StartDate (datetime) --
    
    The date and time at which the Capacity Reservation was started.
  - 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 256 Unicode characters.
  - OutpostArn (string) --
    
    The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
  - CapacityReservationFleetId (string) --
    
    The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
  - PlacementGroupArn (string) --
    
    The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.
  - CapacityAllocations (list) --
    
    Information about instance capacity usage.
    - (dict) --
      
      Information about instance capacity usage for a Capacity Reservation.
      - AllocationType (string) --
        
        The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
      - Count (integer) --
        
        The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.
  - ReservationType (string) --
    
    The type of Capacity Reservation.
  - UnusedReservationBillingOwnerId (string) --
    
    The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned.
  - CommitmentInfo (dict) --
    
    Information about your commitment for a future-dated Capacity Reservation.
    - CommittedInstanceCount (integer) --
      
      The instance capacity that you committed to when you requested the future-dated Capacity Reservation.
    - CommitmentEndDate (datetime) --
      
      The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ). You can't decrease the instance count or cancel the Capacity Reservation before this date and time.
  - DeliveryPreference (string) --
    
    The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.
- DestinationCapacityReservation (dict) --
  
  Information about the destination Capacity Reservation.
  - CapacityReservationId (string) --
    
    The ID of the Capacity Reservation.
  - OwnerId (string) --
    
    The ID of the Amazon Web Services account that owns the Capacity Reservation.
  - CapacityReservationArn (string) --
    
    The Amazon Resource Name (ARN) of the Capacity Reservation.
  - AvailabilityZoneId (string) --
    
    The Availability Zone ID of the Capacity Reservation.
  - 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 Amazon Web Services accounts.
    - dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
  - TotalInstanceCount (integer) --
    
    The total 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) --
    
    Deprecated.
  - State (string) --
    
    The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
    - active - The capacity is available for use.
    - expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
    - cancelled - The Capacity Reservation was canceled. 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 can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
    - scheduled - (Future-dated Capacity Reservations only) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
    - assessing - (Future-dated Capacity Reservations only) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
    - delayed - (Future-dated Capacity Reservations only) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
    - unsupported - (Future-dated Capacity Reservations only) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
  - StartDate (datetime) --
    
    The date and time at which the Capacity Reservation was started.
  - 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 256 Unicode characters.
  - OutpostArn (string) --
    
    The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
  - CapacityReservationFleetId (string) --
    
    The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
  - PlacementGroupArn (string) --
    
    The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.
  - CapacityAllocations (list) --
    
    Information about instance capacity usage.
    - (dict) --
      
      Information about instance capacity usage for a Capacity Reservation.
      - AllocationType (string) --
        
        The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
      - Count (integer) --
        
        The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.
  - ReservationType (string) --
    
    The type of Capacity Reservation.
  - UnusedReservationBillingOwnerId (string) --
    
    The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned.
  - CommitmentInfo (dict) --
    
    Information about your commitment for a future-dated Capacity Reservation.
    - CommittedInstanceCount (integer) --
      
      The instance capacity that you committed to when you requested the future-dated Capacity Reservation.
    - CommitmentEndDate (datetime) --
      
      The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ). You can't decrease the instance count or cancel the Capacity Reservation before this date and time.
  - DeliveryPreference (string) --
    
    The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.
- InstanceCount (integer) --
  
  The number of instances that were moved from the source Capacity Reservation to the destination Capacity Reservation.

PurchaseCapacityBlock (updated)

Link ¶
Changes (response)

{'CapacityReservation': {'CommitmentInfo': {'CommitmentEndDate': 'timestamp',
                                            'CommittedInstanceCount': 'integer'},
                         'DeliveryPreference': 'fixed | incremental',
                         'State': {'delayed', 'assessing', 'unsupported'}}}

Purchase the Capacity Block for use with your account. With Capacity Blocks you ensure GPU capacity is available for machine learning (ML) workloads. You must specify the ID of the Capacity Block offering you are purchasing.

See also: AWS API Documentation

Request Syntax

client.purchase_capacity_block(
    DryRun=True|False,
    TagSpecifications=[
        {
            'ResourceType': 'capacity-reservation'|'client-vpn-endpoint'|'customer-gateway'|'carrier-gateway'|'coip-pool'|'dedicated-host'|'dhcp-options'|'egress-only-internet-gateway'|'elastic-ip'|'elastic-gpu'|'export-image-task'|'export-instance-task'|'fleet'|'fpga-image'|'host-reservation'|'image'|'import-image-task'|'import-snapshot-task'|'instance'|'instance-event-window'|'internet-gateway'|'ipam'|'ipam-pool'|'ipam-scope'|'ipv4pool-ec2'|'ipv6pool-ec2'|'key-pair'|'launch-template'|'local-gateway'|'local-gateway-route-table'|'local-gateway-virtual-interface'|'local-gateway-virtual-interface-group'|'local-gateway-route-table-vpc-association'|'local-gateway-route-table-virtual-interface-group-association'|'natgateway'|'network-acl'|'network-interface'|'network-insights-analysis'|'network-insights-path'|'network-insights-access-scope'|'network-insights-access-scope-analysis'|'placement-group'|'prefix-list'|'replace-root-volume-task'|'reserved-instances'|'route-table'|'security-group'|'security-group-rule'|'snapshot'|'spot-fleet-request'|'spot-instances-request'|'subnet'|'subnet-cidr-reservation'|'traffic-mirror-filter'|'traffic-mirror-session'|'traffic-mirror-target'|'transit-gateway'|'transit-gateway-attachment'|'transit-gateway-connect-peer'|'transit-gateway-multicast-domain'|'transit-gateway-policy-table'|'transit-gateway-route-table'|'transit-gateway-route-table-announcement'|'volume'|'vpc'|'vpc-endpoint'|'vpc-endpoint-connection'|'vpc-endpoint-service'|'vpc-endpoint-service-permission'|'vpc-peering-connection'|'vpn-connection'|'vpn-gateway'|'vpc-flow-log'|'capacity-reservation-fleet'|'traffic-mirror-filter-rule'|'vpc-endpoint-connection-device-type'|'verified-access-instance'|'verified-access-group'|'verified-access-endpoint'|'verified-access-policy'|'verified-access-trust-provider'|'vpn-connection-device-type'|'vpc-block-public-access-exclusion'|'ipam-resource-discovery'|'ipam-resource-discovery-association'|'instance-connect-endpoint'|'ipam-external-resource-verification-token',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    CapacityBlockOfferingId='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'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro'
)

type DryRun:

boolean

param DryRun:

type TagSpecifications:

list

param TagSpecifications:

The tags to apply to the Capacity Block during launch.

(dict) --

The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

Note

The Valid Values lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
- ResourceType (string) --
  
  The type of resource to tag on creation.
- Tags (list) --
  
  The tags to apply to the resource.
  - (dict) --
    
    Describes a tag.
    - Key (string) --
      
      The key of the tag.
      
      Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
    - Value (string) --
      
      The value of the tag.
      
      Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

type CapacityBlockOfferingId:

string

param CapacityBlockOfferingId:

[REQUIRED]

The ID of the Capacity Block offering.

type InstancePlatform:

string

param InstancePlatform:

[REQUIRED]

The type of operating system for which to reserve capacity.

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'|'RHEL with SQL Server Standard'|'RHEL with SQL Server Enterprise'|'RHEL with SQL Server Web'|'RHEL with HA'|'RHEL with HA and SQL Server Standard'|'RHEL with HA and SQL Server Enterprise'|'Ubuntu Pro',
        'AvailabilityZone': 'string',
        'Tenancy': 'default'|'dedicated',
        'TotalInstanceCount': 123,
        'AvailableInstanceCount': 123,
        'EbsOptimized': True|False,
        'EphemeralStorage': True|False,
        'State': 'active'|'expired'|'cancelled'|'pending'|'failed'|'scheduled'|'payment-pending'|'payment-failed'|'assessing'|'delayed'|'unsupported',
        'StartDate': datetime(2015, 1, 1),
        'EndDate': datetime(2015, 1, 1),
        'EndDateType': 'unlimited'|'limited',
        'InstanceMatchCriteria': 'open'|'targeted',
        'CreateDate': datetime(2015, 1, 1),
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'OutpostArn': 'string',
        'CapacityReservationFleetId': 'string',
        'PlacementGroupArn': 'string',
        'CapacityAllocations': [
            {
                'AllocationType': 'used',
                'Count': 123
            },
        ],
        'ReservationType': 'default'|'capacity-block',
        'UnusedReservationBillingOwnerId': 'string',
        'CommitmentInfo': {
            'CommittedInstanceCount': 123,
            'CommitmentEndDate': datetime(2015, 1, 1)
        },
        'DeliveryPreference': 'fixed'|'incremental'
    }
}

Response Structure

(dict) --
- CapacityReservation (dict) --
  
  The Capacity Reservation.
  - CapacityReservationId (string) --
    
    The ID of the Capacity Reservation.
  - OwnerId (string) --
    
    The ID of the Amazon Web Services account that owns the Capacity Reservation.
  - CapacityReservationArn (string) --
    
    The Amazon Resource Name (ARN) of the Capacity Reservation.
  - AvailabilityZoneId (string) --
    
    The Availability Zone ID of the Capacity Reservation.
  - 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 Amazon Web Services accounts.
    - dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
  - TotalInstanceCount (integer) --
    
    The total 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) --
    
    Deprecated.
  - State (string) --
    
    The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
    - active - The capacity is available for use.
    - expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.
    - cancelled - The Capacity Reservation was canceled. 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 can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.
    - scheduled - (Future-dated Capacity Reservations only) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.
    - assessing - (Future-dated Capacity Reservations only) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.
    - delayed - (Future-dated Capacity Reservations only) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.
    - unsupported - (Future-dated Capacity Reservations only) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.
  - StartDate (datetime) --
    
    The date and time at which the Capacity Reservation was started.
  - 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 256 Unicode characters.
  - OutpostArn (string) --
    
    The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
  - CapacityReservationFleetId (string) --
    
    The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
  - PlacementGroupArn (string) --
    
    The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. For more information, see Capacity Reservations for cluster placement groups in the Amazon EC2 User Guide.
  - CapacityAllocations (list) --
    
    Information about instance capacity usage.
    - (dict) --
      
      Information about instance capacity usage for a Capacity Reservation.
      - AllocationType (string) --
        
        The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
      - Count (integer) --
        
        The amount of instance capacity associated with the usage. For example a value of 4 indicates that instance capacity for 4 instances is currently in use.
  - ReservationType (string) --
    
    The type of Capacity Reservation.
  - UnusedReservationBillingOwnerId (string) --
    
    The ID of the Amazon Web Services account to which billing of the unused capacity of the Capacity Reservation is assigned.
  - CommitmentInfo (dict) --
    
    Information about your commitment for a future-dated Capacity Reservation.
    - CommittedInstanceCount (integer) --
      
      The instance capacity that you committed to when you requested the future-dated Capacity Reservation.
    - CommitmentEndDate (datetime) --
      
      The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone ( YYYY-MM-DDThh:mm:ss.sssZ). You can't decrease the instance count or cancel the Capacity Reservation before this date and time.
  - DeliveryPreference (string) --
    
    The delivery method for a future-dated Capacity Reservation. incremental indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.