CostOptimizationHub / Paginator / ListEnrollmentStatuses

ListEnrollmentStatuses

class CostOptimizationHub.Paginator.ListEnrollmentStatuses

paginator = client.get_paginator('list_enrollment_statuses')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CostOptimizationHub.Client.list_enrollment_statuses().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    includeOrganizationInfo=True|False,
    accountId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• includeOrganizationInfo (boolean) – Indicates whether to return the enrollment status for the organization.

• accountId (string) – The account ID of a member account in the organization.

• 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': [
        {
            'accountId': 'string',
            'status': 'Active'|'Inactive',
            'lastUpdatedTimestamp': datetime(2015, 1, 1),
            'createdTimestamp': datetime(2015, 1, 1)
        },
    ],
    'includeMemberAccounts': True|False,
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The enrollment status of a specific account ID, including creation and last updated timestamps.

    • (dict) –

      Describes the enrollment status of an organization’s member accounts in Cost Optimization Hub.

      • accountId (string) –

        The Amazon Web Services account ID.

      • status (string) –

        The account enrollment status.

      • lastUpdatedTimestamp (datetime) –

        The time when the account enrollment status was last updated.

      • createdTimestamp (datetime) –

        The time when the account enrollment status was created.

  • includeMemberAccounts (boolean) –

    The enrollment status of all member accounts in the organization if the account is the management account or delegated administrator.

  • NextToken (string) –

    A token to resume pagination.