CloudWatchOmni / Client / update_access_profile

update_access_profile

CloudWatchOmni.Client.update_access_profile(**kwargs)

Updates the name or description of an access profile.

Only the provided fields are changed; omitted fields are left unchanged.

See also: AWS API Documentation

Request Syntax

response = client.update_access_profile(
    spaceId='string',
    profileId='string',
    name='string',
    description='string'
)
Parameters:

  • spaceId (string) –

    [REQUIRED]

    The unique ID of the space.

  • profileId (string) –

    [REQUIRED]

    The unique ID of the access profile to update.

  • name (string) – A new name for the access profile. Omit to leave unchanged.

  • description (string) – A new description of the access profile. Omit to leave unchanged.

Return type:

dict

Returns:

Response Syntax

{
    'accessProfile': {
        'profileId': 'string',
        'spaceId': 'string',
        'arn': 'string',
        'name': 'string',
        'description': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'assumeStatus': 'ALLOWED'|'DENIED',
        'profileType': 'SERVICE_MANAGED'|'CUSTOMER_MANAGED'
    }
}

Response Structure

  • (dict) –

    • accessProfile (dict) –

      The access profile.

      • profileId (string) –

        The unique ID of the access profile.

      • spaceId (string) –

        The ID of the space the profile belongs to.

      • 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.

      • createdAt (datetime) –

        The timestamp when the access profile was created.

      • updatedAt (datetime) –

        The timestamp when the access profile was last updated.

      • assumeStatus (string) –

        The calling principal’s authorization to assume this access profile.

      • profileType (string) –

        Who manages the access profile.

Exceptions