CloudWatchOmni / Client / get_domain_access_grant_for_organization

get_domain_access_grant_for_organization

CloudWatchOmni.Client.get_domain_access_grant_for_organization(**kwargs)

Retrieves the full detail of a single organization access grant by ID.

See also: AWS API Documentation

Request Syntax

response = client.get_domain_access_grant_for_organization(
    grantId='string'
)

Parameters:

grantId (string) –

[REQUIRED]

The ID of the access grant to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'accessGrant': {
        'grantId': 'string',
        'grantArn': 'string',
        'name': 'string',
        'domainId': 'string',
        'principal': {
            'principalType': 'IDC_USER'|'IDC_GROUP'|'IAM_USER'|'IAM_ROLE'|'IAM_ROOT',
            'principalId': 'string',
            'principalAttributes': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ]
        },
        'permission': 'ADMIN',
        'grantType': 'SERVICE_MANAGED'|'CUSTOMER_MANAGED',
        'createdBy': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) –

  • accessGrant (dict) –

    The retrieved organization access grant.

    • grantId (string) –

      The unique ID of the access grant.

    • grantArn (string) –

      The Amazon Resource Name (ARN) of the access grant.

    • name (string) –

      A name that identifies the access grant.

    • domainId (string) –

      The ID of the organization domain the grant belongs to.

    • principal (dict) –

      The principal receiving the grant.

      • principalType (string) –

        The type of principal receiving the grant.

      • principalId (string) –

        The ID of the principal receiving the grant.

      • principalAttributes (list) –

        Attribute conditions for attribute-based access. When provided, the grant targets any principal matching all specified conditions. Supported only for IDC_USER principals.

        • (dict) –

          A single attribute condition used to match principals for attribute-based access.

          • key (string) –

            The Identity Center user attribute to match on. One of userName, active, userStatus, displayName, email, name.givenName, name.familyName, enterprise.department, enterprise.division, enterprise.organization, enterprise.costCenter, or enterprise.employeeNumber. Each key may appear only once per grant.

          • value (string) –

            The attribute value.

    • permission (string) –

      The permission granted.

    • grantType (string) –

      Who manages the grant.

    • createdBy (string) –

      The principal that created the grant.

    • createdAt (datetime) –

      The timestamp when the grant was created.

    • updatedAt (datetime) –

      The timestamp when the grant was last updated.

Exceptions

• CloudWatchOmni.Client.exceptions.ThrottlingException

• CloudWatchOmni.Client.exceptions.ValidationException

• CloudWatchOmni.Client.exceptions.ResourceNotFoundException

• CloudWatchOmni.Client.exceptions.AccessDeniedException

• CloudWatchOmni.Client.exceptions.InternalServerException