EC2 / Client / describe_capacity_block_extension_offerings

describe_capacity_block_extension_offerings#

EC2.Client.describe_capacity_block_extension_offerings(**kwargs)#

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

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

  • DryRun (boolean) – 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.

  • CapacityBlockExtensionDurationHours (integer) –

    [REQUIRED]

    The duration of the Capacity Block extension offering in hours.

  • CapacityReservationId (string) –

    [REQUIRED]

    The ID of the Capacity reservation to be extended.

  • NextToken (string) – The token to use to retrieve the next page of results.

  • MaxResults (integer) – 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.

Return type:

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.