DataZone / Client / get_user_profile

get_user_profile#

DataZone.Client.get_user_profile(**kwargs)#

Gets a user profile in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

response = client.get_user_profile(
    domainIdentifier='string',
    type='IAM'|'SSO',
    userIdentifier='string'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

    the ID of the Amazon DataZone domain the data portal of which you want to get.

  • type (string) – The type of the user profile.

  • userIdentifier (string) –

    [REQUIRED]

    The identifier of the user for which you want to get the user profile.

Return type:

dict

Returns:

Response Syntax

{
    'details': {
        'iam': {
            'arn': 'string'
        },
        'sso': {
            'firstName': 'string',
            'lastName': 'string',
            'username': 'string'
        }
    },
    'domainId': 'string',
    'id': 'string',
    'status': 'ASSIGNED'|'NOT_ASSIGNED'|'ACTIVATED'|'DEACTIVATED',
    'type': 'IAM'|'SSO'
}

Response Structure

  • (dict) –

    • details (dict) –

      The details of the user profile in Amazon DataZone.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: iam, sso. 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'}

      • iam (dict) –

        The IAM details included in the user profile details.

        • arn (string) –

          The ARN of an IAM user profile in Amazon DataZone.

      • sso (dict) –

        The single sign-on details included in the user profile details.

        • firstName (string) –

          The first name included in the single sign-on details of the user profile.

        • lastName (string) –

          The last name included in the single sign-on details of the user profile.

        • username (string) –

          The username included in the single sign-on details of the user profile.

    • domainId (string) –

      the identifier of the Amazon DataZone domain of which you want to get the user profile.

    • id (string) –

      The identifier of the user profile.

    • status (string) –

      The status of the user profile.

    • type (string) –

      The type of the user profile.

Exceptions