EC2 / Paginator / DescribeCapacityManagerDataExports

DescribeCapacityManagerDataExports

class EC2.Paginator.DescribeCapacityManagerDataExports

paginator = client.get_paginator('describe_capacity_manager_data_exports')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• CapacityManagerDataExportIds (list) –

  The IDs of the data export configurations to describe. If not specified, all export configurations are returned.

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

• Filters (list) –

  One or more filters to narrow the results. Supported filters include export status, creation date, and S3 bucket name.

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

• 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

{
    'CapacityManagerDataExports': [
        {
            'CapacityManagerDataExportId': 'string',
            'S3BucketName': 'string',
            'S3BucketPrefix': 'string',
            'Schedule': 'hourly',
            'OutputFormat': 'csv'|'parquet',
            'CreateTime': datetime(2015, 1, 1),
            'LatestDeliveryStatus': 'pending'|'in-progress'|'delivered'|'failed',
            'LatestDeliveryStatusMessage': 'string',
            'LatestDeliveryS3LocationUri': 'string',
            'LatestDeliveryTime': datetime(2015, 1, 1),
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],

}

Response Structure

• (dict) –

  • CapacityManagerDataExports (list) –

    Information about the data export configurations, including export settings, delivery status, and recent activity.

    • (dict) –

      Contains information about a Capacity Manager data export configuration, including export settings, delivery status, and recent export activity.

      • CapacityManagerDataExportId (string) –

        The unique identifier for the data export configuration.

      • S3BucketName (string) –

        The name of the S3 bucket where export files are delivered.

      • S3BucketPrefix (string) –

        The S3 key prefix used for organizing export files within the bucket.

      • Schedule (string) –

        The frequency at which data exports are generated.

      • OutputFormat (string) –

        The file format of the exported data.

      • CreateTime (datetime) –

        The timestamp when the data export configuration was created.

      • LatestDeliveryStatus (string) –

        The status of the most recent export delivery.

      • LatestDeliveryStatusMessage (string) –

        A message describing the status of the most recent export delivery, including any error details if the delivery failed.

      • LatestDeliveryS3LocationUri (string) –

        The S3 URI of the most recently delivered export file.

      • LatestDeliveryTime (datetime) –

        The timestamp when the most recent export was delivered to S3.

      • Tags (list) –

        The tags associated with the data export configuration.

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