CloudWatchOmni / Client / list_access_profiles

list_access_profiles

CloudWatchOmni.Client.list_access_profiles(**kwargs)

Returns the access profiles in a space.

See also: AWS API Documentation

Request Syntax

response = client.list_access_profiles(
    spaceId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • spaceId (string) –

    [REQUIRED]

    The unique ID of the space.

  • nextToken (string) – A token to retrieve the next page of results.

  • maxResults (integer) – The maximum number of access profiles to return per page. Defaults to 100.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'profileId': 'string',
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'profileType': 'SERVICE_MANAGED'|'CUSTOMER_MANAGED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      The list of access profile summaries.

      • (dict) –

        Summary of an access profile. Call GetAccessProfile for the full profile.

        • profileId (string) –

          The unique ID of the access profile.

        • arn (string) –

          The ARN of this access profile.

        • name (string) –

          A name that identifies the access profile.

        • description (string) –

          An optional description of the access profile.

        • profileType (string) –

          Who manages the access profile.

    • nextToken (string) –

      A token to retrieve the next page of results, or null if there are no more results.

Exceptions