Organizations / Paginator / ListDelegatedAdministrators

ListDelegatedAdministrators

class Organizations.Paginator.ListDelegatedAdministrators

paginator = client.get_paginator('list_delegated_administrators')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Organizations.Client.list_delegated_administrators().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ServicePrincipal (string) –

  Specifies a service principal name. If specified, then the operation lists the delegated administrators only for the specified service.

  If you don’t specify a service principal, the operation lists all delegated administrators for all services in your 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

{
    'DelegatedAdministrators': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Email': 'string',
            'Name': 'string',
            'Status': 'ACTIVE'|'SUSPENDED'|'PENDING_CLOSURE',
            'State': 'PENDING_ACTIVATION'|'ACTIVE'|'SUSPENDED'|'PENDING_CLOSURE'|'CLOSED',
            'JoinedMethod': 'INVITED'|'CREATED',
            'JoinedTimestamp': datetime(2015, 1, 1),
            'DelegationEnabledDate': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • DelegatedAdministrators (list) –

    The list of delegated administrators in your organization.

    • (dict) –

      Contains information about the delegated administrator.

      • Id (string) –

        The unique identifier (ID) of the delegated administrator’s account.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the delegated administrator’s account.

      • Email (string) –

        The email address that is associated with the delegated administrator’s Amazon Web Services account.

      • Name (string) –

        The friendly name of the delegated administrator’s account.

      • Status (string) –

        The status of the delegated administrator’s account in the organization.

      • State (string) –

        Each state represents a specific phase in the account lifecycle. Use this information to manage account access, automate workflows, or trigger actions based on account state changes.

        For more information about account states and their implications, see Monitor the state of your Amazon Web Services accounts in the Organizations User Guide.

      • JoinedMethod (string) –

        The method by which the delegated administrator’s account joined the organization.

      • JoinedTimestamp (datetime) –

        The date when the delegated administrator’s account became a part of the organization.

      • DelegationEnabledDate (datetime) –

        The date when the account was made a delegated administrator.