WellArchitected / Client / list_profile_notifications

list_profile_notifications#

WellArchitected.Client.list_profile_notifications(**kwargs)#

List profile notifications.

See also: AWS API Documentation

Request Syntax

response = client.list_profile_notifications(
    WorkloadId='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • WorkloadId (string) – The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

  • NextToken (string) – The token to use to retrieve the next set of results.

  • MaxResults (integer) – The maximum number of results to return for this request.

Return type:

dict

Returns:

Response Syntax

{
    'NotificationSummaries': [
        {
            'CurrentProfileVersion': 'string',
            'LatestProfileVersion': 'string',
            'Type': 'PROFILE_ANSWERS_UPDATED'|'PROFILE_DELETED',
            'ProfileArn': 'string',
            'ProfileName': 'string',
            'WorkloadId': 'string',
            'WorkloadName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • NotificationSummaries (list) –

      Notification summaries.

      • (dict) –

        The profile notification summary.

        • CurrentProfileVersion (string) –

          The current profile version.

        • LatestProfileVersion (string) –

          The latest profile version.

        • Type (string) –

          Type of notification.

        • ProfileArn (string) –

          The profile ARN.

        • ProfileName (string) –

          The profile name.

        • WorkloadId (string) –

          The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

        • WorkloadName (string) –

          The name of the workload.

          The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

    • NextToken (string) –

      The token to use to retrieve the next set of results.

Exceptions

  • WellArchitected.Client.exceptions.ValidationException

  • WellArchitected.Client.exceptions.InternalServerException

  • WellArchitected.Client.exceptions.AccessDeniedException

  • WellArchitected.Client.exceptions.ThrottlingException