BillingandCostManagementPricingCalculator / Paginator / ListBillScenarioCommitmentModifications

ListBillScenarioCommitmentModifications

class BillingandCostManagementPricingCalculator.Paginator.ListBillScenarioCommitmentModifications

paginator = client.get_paginator('list_bill_scenario_commitment_modifications')

paginate(**kwargs)

Creates an iterator that will paginate through responses from BillingandCostManagementPricingCalculator.Client.list_bill_scenario_commitment_modifications().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• billScenarioId (string) –

  [REQUIRED]

  The unique identifier of the bill scenario to list commitment modifications for.

• 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

{
    'items': [
        {
            'id': 'string',
            'usageAccountId': 'string',
            'group': 'string',
            'commitmentAction': {
                'addReservedInstanceAction': {
                    'reservedInstancesOfferingId': 'string',
                    'instanceCount': 123
                },
                'addSavingsPlanAction': {
                    'savingsPlanOfferingId': 'string',
                    'commitment': 123.0
                },
                'negateReservedInstanceAction': {
                    'reservedInstancesId': 'string'
                },
                'negateSavingsPlanAction': {
                    'savingsPlanId': 'string'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The list of commitment modifications associated with the bill scenario.

    • (dict) –

      Represents a commitment modification item in a bill scenario.

      • id (string) –

        The unique identifier of the commitment modification.

      • usageAccountId (string) –

        The Amazon Web Services account ID associated with this commitment modification.

      • group (string) –

        The group identifier for the commitment modification.

      • commitmentAction (dict) –

        The specific commitment action taken in this modification.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: addReservedInstanceAction, addSavingsPlanAction, negateReservedInstanceAction, negateSavingsPlanAction. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • addReservedInstanceAction (dict) –

          Action to add a Reserved Instance to the scenario.

          • reservedInstancesOfferingId (string) –

            The ID of the Reserved Instance offering to add. For more information, see DescribeReservedInstancesOfferings.

          • instanceCount (integer) –

            The number of instances to add for this Reserved Instance offering.

        • addSavingsPlanAction (dict) –

          Action to add a Savings Plan to the scenario.

          • savingsPlanOfferingId (string) –

            The ID of the Savings Plan offering to add. For more information, see DescribeSavingsPlansOfferings.

          • commitment (float) –

            The hourly commitment, in the same currency of the savingsPlanOfferingId. This is a value between 0.001 and 1 million. You cannot specify more than five digits after the decimal point.

        • negateReservedInstanceAction (dict) –

          Action to remove a Reserved Instance from the scenario.

          • reservedInstancesId (string) –

            The ID of the Reserved Instance to remove.

        • negateSavingsPlanAction (dict) –

          Action to remove a Savings Plan from the scenario.

          • savingsPlanId (string) –

            The ID of the Savings Plan to remove.

  • NextToken (string) –

    A token to resume pagination.