DataZone / Client / create_group_profile

create_group_profile

DataZone.Client.create_group_profile(**kwargs)

Creates a group profile in Amazon DataZone.

See also: AWS API Documentation

Request Syntax

response = client.create_group_profile(
    domainIdentifier='string',
    groupIdentifier='string',
    rolePrincipalArn='string',
    clientToken='string'
)
Parameters:

  • domainIdentifier (string) –

    [REQUIRED]

    The identifier of the Amazon DataZone domain in which the group profile is created.

  • groupIdentifier (string) – The identifier of the group for which the group profile is created.

  • rolePrincipalArn (string) – The ARN of the IAM role that will be associated with the group profile. This role defines the permissions that group members will assume when accessing Amazon DataZone resources.

  • clientToken (string) –

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'domainId': 'string',
    'id': 'string',
    'status': 'ASSIGNED'|'NOT_ASSIGNED',
    'groupName': 'string',
    'rolePrincipalArn': 'string',
    'rolePrincipalId': 'string'
}

Response Structure

  • (dict) –

    • domainId (string) –

      The identifier of the Amazon DataZone domain in which the group profile is created.

    • id (string) –

      The identifier of the group profile.

    • status (string) –

      The status of the group profile.

    • groupName (string) –

      The name of the group for which group profile is created.

    • rolePrincipalArn (string) –

      The ARN of the IAM role principal. This role is associated with the group profile.

    • rolePrincipalId (string) –

      The unique identifier of the IAM role principal. This principal is associated with the group profile.

Exceptions