Amazon Elastic Compute Cloud

Create a new Capacity Reservation by splitting the available 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:

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

type 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 available 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.

  • 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',
        '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'
    },
    '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',
        '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'
    },
    '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 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.

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

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

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

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

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:

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

type 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',
        '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'
    },
    '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',
        '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'
    },
    '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 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.

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

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

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

  • InstanceCount (integer) --

    The number of instances that were moved from the source Capacity Reservation to the destination Capacity Reservation.

{'InstanceMatchCriteria': 'open | targeted'}

Modifies a Capacity Reservation's capacity, instance eligibility, and the conditions under which it is to be released. You can't modify a Capacity Reservation's instance type, EBS optimization, platform, instance store settings, Availability Zone, or tenancy. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes. For more information, see Modify an active Capacity Reservation.

See also: AWS API Documentation

Request Syntax

client.modify_capacity_reservation(
    CapacityReservationId='string',
    InstanceCount=123,
    EndDate=datetime(2015, 1, 1),
    EndDateType='unlimited'|'limited',
    Accept=True|False,
    DryRun=True|False,
    AdditionalInfo='string',
    InstanceMatchCriteria='open'|'targeted'
)

type CapacityReservationId:

string

param CapacityReservationId:

[REQUIRED]

The ID of the Capacity Reservation.

type InstanceCount:

integer

param InstanceCount:

The number of instances for which to reserve capacity. The number of instances can't be increased or decreased by more than 1000 in a single request.

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.

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.

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

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 value if EndDateType is unlimited.

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

type Accept:

boolean

param Accept:

Reserved. Capacity Reservations you have created are accepted by default.

type DryRun:

boolean

param DryRun:

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

type AdditionalInfo:

string

param AdditionalInfo:

Reserved for future use.

type InstanceMatchCriteria:

string

param InstanceMatchCriteria:

The matching criteria (instance eligibility) that you want to use in the modified Capacity Reservation. If you change the instance eligibility of an existing Capacity Reservation from targeted to open, any running instances that match the attributes of the Capacity Reservation, have the CapacityReservationPreference set to open, and are not yet running in the Capacity Reservation, will automatically use the modified Capacity Reservation.

To modify the instance eligibility, the Capacity Reservation must be completely idle (zero usage).

rtype:

dict

returns:

Response Syntax

{
    'Return': True|False
}

Response Structure

• (dict) --

  • Return (boolean) --

    Returns true if the request succeeds; otherwise, it returns an error.