Organizations / Client / list_delegated_administrators

list_delegated_administrators#

Organizations.Client.list_delegated_administrators(**kwargs)#

Lists the Amazon Web Services accounts that are designated as delegated administrators in this organization.

This operation can be called only from the organization’s management account or by a member account that is a delegated administrator for an Amazon Web Services service.

Request Syntax

response = client.list_delegated_administrators(
    ServicePrincipal='string',
    NextToken='string',
    MaxResults=123
)

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.
NextToken (string) – The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call’s NextToken response to indicate where the output should continue from.
MaxResults (integer) – The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Return type:

dict

Returns:

Response Syntax

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

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.
    - 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.
- NextToken (string) –
  
  If present, indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

Exceptions

Organizations.Client.exceptions.AccessDeniedException
Organizations.Client.exceptions.AWSOrganizationsNotInUseException
Organizations.Client.exceptions.ConstraintViolationException
Organizations.Client.exceptions.InvalidInputException
Organizations.Client.exceptions.TooManyRequestsException
Organizations.Client.exceptions.ServiceException
Organizations.Client.exceptions.UnsupportedAPIEndpointException