EC2 / Paginator / DescribeCapacityReservations

DescribeCapacityReservations#

class EC2.Paginator.DescribeCapacityReservations#

paginator = client.get_paginator('describe_capacity_reservations')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from EC2.Client.describe_capacity_reservations().

Request Syntax

response_iterator = paginator.paginate(
    CapacityReservationIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    DryRun=True|False,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

CapacityReservationIds (list) –
The ID of the Capacity Reservation.
- (string) –
Filters (list) –
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.
  
  For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
  - 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) –
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.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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) –
- 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.