ComputeOptimizer / Paginator / GetEnrollmentStatusesForOrganization

GetEnrollmentStatusesForOrganization

class ComputeOptimizer.Paginator.GetEnrollmentStatusesForOrganization

paginator = client.get_paginator('get_enrollment_statuses_for_organization')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ComputeOptimizer.Client.get_enrollment_statuses_for_organization().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filters=[
        {
            'name': 'Status',
            'values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filters (list) –

  An array of objects to specify a filter that returns a more specific list of account enrollment statuses.

  • (dict) –

    Describes a filter that returns a more specific list of account enrollment statuses. Use this filter with the GetEnrollmentStatusesForOrganization action.

    • name (string) –

      The name of the filter.

      Specify Status to return accounts with a specific enrollment status (for example, Active).

    • values (list) –

      The value of the filter.

      The valid values are Active, Inactive, Pending, and Failed.

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

{
    'accountEnrollmentStatuses': [
        {
            'accountId': 'string',
            'status': 'Active'|'Inactive'|'Pending'|'Failed',
            'statusReason': 'string',
            'lastUpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • accountEnrollmentStatuses (list) –

    An array of objects that describe the enrollment statuses of organization member accounts.

    • (dict) –

      Describes the enrollment status of an organization’s member accounts in Compute Optimizer.

      • accountId (string) –

        The Amazon Web Services account ID.

      • status (string) –

        The account enrollment status.

      • statusReason (string) –

        The reason for the account enrollment status.

        For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.

      • lastUpdatedTimestamp (datetime) –

        The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.

  • NextToken (string) –

    A token to resume pagination.