Outposts / Paginator / GetOutpostBillingInformation

GetOutpostBillingInformation

class Outposts.Paginator.GetOutpostBillingInformation

paginator = client.get_paginator('get_outpost_billing_information')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Outposts.Client.get_outpost_billing_information().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    OutpostIdentifier='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• OutpostIdentifier (string) –

  [REQUIRED]

  The ID or ARN of the Outpost.

• 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

{
    'Subscriptions': [
        {
            'SubscriptionId': 'string',
            'SubscriptionType': 'ORIGINAL'|'RENEWAL'|'CAPACITY_INCREASE',
            'SubscriptionStatus': 'ACTIVE'|'INACTIVE'|'CANCELLED',
            'OrderIds': [
                'string',
            ],
            'BeginDate': datetime(2015, 1, 1),
            'EndDate': datetime(2015, 1, 1),
            'MonthlyRecurringPrice': 123.0,
            'UpfrontPrice': 123.0
        },
    ],
    'ContractEndDate': 'string'
}

Response Structure

• (dict) –

  • Subscriptions (list) –

    The subscription details for the specified Outpost.

    • (dict) –

      Provides information about your Amazon Web Services Outposts subscriptions.

      • SubscriptionId (string) –

        The ID of the subscription that appears on the Amazon Web Services Billing Center console.

      • SubscriptionType (string) –

        The type of subscription which can be one of the following:

        • ORIGINAL - The first order on the Amazon Web Services Outposts.

        • RENEWAL - Renewal requests, both month to month and longer term.

        • CAPACITY_INCREASE - Capacity scaling orders.

      • SubscriptionStatus (string) –

        The status of subscription which can be one of the following:

        • INACTIVE - Subscription requests that are inactive.

        • ACTIVE - Subscription requests that are in progress and have an end date in the future.

        • CANCELLED - Subscription requests that are cancelled.

      • OrderIds (list) –

        The order ID for your subscription.

        • (string) –

      • BeginDate (datetime) –

        The date your subscription starts.

      • EndDate (datetime) –

        The date your subscription ends.

      • MonthlyRecurringPrice (float) –

        The amount you are billed each month in the subscription period.

      • UpfrontPrice (float) –

        The amount billed when the subscription is created. This is a one-time charge.

  • ContractEndDate (string) –

    The date the current contract term ends for the specified Outpost. You must start the renewal or decommission process at least 5 business days before the current term for your Amazon Web Services Outposts ends. Failing to complete these steps at least 5 business days before the current term ends might result in unanticipated charges.