DataZone / Client / get_account_pool

get_account_pool¶

DataZone.Client.get_account_pool(**kwargs)¶

Gets the details of the account pool.

Request Syntax

response = client.get_account_pool(
    domainIdentifier='string',
    identifier='string'
)

Parameters:

domainIdentifier (string) –
[REQUIRED]

The ID of the domain in which the account pool lives whose details are to be displayed.
identifier (string) –
[REQUIRED]

The ID of the account pool whose details are to be displayed.

Return type:

dict

Returns:

Response Syntax

{
    'accountSource': {
        'accounts': [
            {
                'awsAccountId': 'string',
                'awsAccountName': 'string',
                'supportedRegions': [
                    'string',
                ]
            },
        ],
        'customAccountPoolHandler': {
            'lambdaExecutionRoleArn': 'string',
            'lambdaFunctionArn': 'string'
        }
    },
    'createdAt': datetime(2015, 1, 1),
    'createdBy': 'string',
    'description': 'string',
    'domainId': 'string',
    'domainUnitId': 'string',
    'id': 'string',
    'lastUpdatedAt': datetime(2015, 1, 1),
    'name': 'string',
    'resolutionStrategy': 'MANUAL',
    'updatedBy': 'string'
}

Response Structure

(dict) –
- accountSource (dict) –
  
  The source of accounts for the account pool. In the current release, it’s either a static list of accounts provided by the customer or a custom Amazon Web Services Lambda handler.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: accounts, customAccountPoolHandler. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
  'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
  - accounts (list) –
    
    The static list of accounts within an account pool.
    - (dict) –
      
      The account information within an account pool.
      - awsAccountId (string) –
        
        The account ID.
      - awsAccountName (string) –
        
        The account name.
      - supportedRegions (list) –
        
        The regions supported for an account within an account pool.
        
        (string) –
  - customAccountPoolHandler (dict) –
    
    The custom Amazon Web Services Lambda handler within an account pool.
    - lambdaExecutionRoleArn (string) –
      
      The ARN of the IAM role that enables Amazon SageMaker Unified Studio to invoke the Amazon Web Services Lambda funtion if the account source is the custom account pool handler.
    - lambdaFunctionArn (string) –
      
      The ARN of the Amazon Web Services Lambda function for the custom Amazon Web Services Lambda handler.
- createdAt (datetime) –
  
  The timestamp at which the account pool was created.
- createdBy (string) –
  
  The user who created the account pool.
- description (string) –
  
  The description of the account pool.
- domainId (string) –
  
  The ID of the domain in which the account pool lives whose details are to be displayed.
- domainUnitId (string) –
  
  The domain unit ID of the account pool.
- id (string) –
  
  The ID of the account pool.
- lastUpdatedAt (datetime) –
  
  The timestamp at which the account pool was last updated.
- name (string) –
  
  The name of the account pool.
- resolutionStrategy (string) –
  
  The mechanism used to resolve the account selection from the account pool.
- updatedBy (string) –
  
  The user who last updated the account pool.

Exceptions

DataZone.Client.exceptions.InternalServerException
DataZone.Client.exceptions.ResourceNotFoundException
DataZone.Client.exceptions.AccessDeniedException
DataZone.Client.exceptions.ThrottlingException
DataZone.Client.exceptions.ValidationException
DataZone.Client.exceptions.UnauthorizedException