CloudWatchOmni / Paginator / ListAccessGrants

ListAccessGrants

class CloudWatchOmni.Paginator.ListAccessGrants

paginator = client.get_paginator('list_access_grants')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CloudWatchOmni.Client.list_access_grants().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    domainId='string',
    spaceId='string',
    principalId='string',
    principalType='IDC_USER'|'IDC_GROUP'|'IAM_USER'|'IAM_ROLE'|'IAM_ROOT'|'ACCESS_PROFILE'|'ALERT'|'AGENT',
    permission='SPACE_ADMIN'|'READ'|'READ_WRITE_DELETE'|'CUSTOM',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• domainId (string) – Filter by domain ID.

• spaceId (string) – Filter by space ID.

• principalId (string) – Filter by principal ID.

• principalType (string) – Filter by principal type.

• permission (string) – Filter by permission level.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'grantId': 'string',
            'grantArn': 'string',
            'name': 'string',
            'domainId': 'string',
            'principal': {
                'principalType': 'IDC_USER'|'IDC_GROUP'|'IAM_USER'|'IAM_ROLE'|'IAM_ROOT'|'ACCESS_PROFILE'|'ALERT'|'AGENT',
                'principalId': 'string',
                'principalAttributes': [
                    {
                        'key': 'string',
                        'value': 'string'
                    },
                ]
            },
            'permission': 'SPACE_ADMIN'|'READ'|'READ_WRITE_DELETE'|'CUSTOM',
            'grantType': 'SERVICE_MANAGED'|'CUSTOMER_MANAGED',
            'spaceId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The list of access grant summaries.

    • (dict) –

      Summary of an AccessGrant. Call GetAccessGrant for the full 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 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.

      • spaceId (string) –

        The space this grant applies to. Domain-scoped grants are returned by ListDomainAccessGrantsForOrganization instead.

  • NextToken (string) –

    A token to resume pagination.