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.

You can only call this operation from the management account or a member account that is a delegated administrator.

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 maximum number of items to return in the response. If more results exist than the specified MaxResults value, a token is included in the response so that you can retrieve the remaining results.

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)
        },
    ],
    '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.
    - 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.
- 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