list_event_types

CodeStarNotifications.Client.list_event_types(**kwargs)

Returns information about the event types available for configuring notifications.

See also: AWS API Documentation

Request Syntax

response = client.list_event_types(
    Filters=[
        {
            'Name': 'RESOURCE_TYPE'|'SERVICE_NAME',
            'Value': 'string'
        },
    ],
    NextToken='string',
    MaxResults=123
)

Parameters

• Filters (list) --

  The filters to use to return information by service or resource type.

  • (dict) --

    Information about a filter to apply to the list of returned event types. You can filter by resource type or service name.

    • Name (string) -- [REQUIRED]

      The system-generated name of the filter type you want to filter by.

    • Value (string) -- [REQUIRED]

      The name of the resource type (for example, pipeline) or service name (for example, CodePipeline) that you want to filter by.

• NextToken (string) -- An enumeration token that, when provided in a request, returns the next batch of the results.
• MaxResults (integer) -- A non-negative integer used to limit the number of returned results. The default number is 50. The maximum number of results that can be returned is 100.

Return type

dict

Returns

Response Syntax

{
    'EventTypes': [
        {
            'EventTypeId': 'string',
            'ServiceName': 'string',
            'EventTypeName': 'string',
            'ResourceType': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • EventTypes (list) --

    Information about each event, including service name, resource type, event ID, and event name.

    • (dict) --

      Returns information about an event that has triggered a notification rule.

      • EventTypeId (string) --

        The system-generated ID of the event. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide .

      • ServiceName (string) --

        The name of the service for which the event applies.

      • EventTypeName (string) --

        The name of the event.

      • ResourceType (string) --

        The resource type of the event.

  • NextToken (string) --

    An enumeration token that can be used in a request to return the next batch of the results.

Exceptions

• CodeStarNotifications.Client.exceptions.InvalidNextTokenException
• CodeStarNotifications.Client.exceptions.ValidationException