MediaLive / Client / list_signal_maps

list_signal_maps#

MediaLive.Client.list_signal_maps(**kwargs)#

Lists signal maps.

Request Syntax

response = client.list_signal_maps(
    CloudWatchAlarmTemplateGroupIdentifier='string',
    EventBridgeRuleTemplateGroupIdentifier='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

CloudWatchAlarmTemplateGroupIdentifier (string) – A cloudwatch alarm template group’s identifier. Can be either be its id or current name.
EventBridgeRuleTemplateGroupIdentifier (string) – An eventbridge rule template group’s identifier. Can be either be its id or current name.
MaxResults (integer) – Placeholder documentation for MaxResults
NextToken (string) – A token used to retrieve the next set of results in paginated list responses.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'SignalMaps': [
        {
            'Arn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'Description': 'string',
            'Id': 'string',
            'ModifiedAt': datetime(2015, 1, 1),
            'MonitorDeploymentStatus': 'NOT_DEPLOYED'|'DRY_RUN_DEPLOYMENT_COMPLETE'|'DRY_RUN_DEPLOYMENT_FAILED'|'DRY_RUN_DEPLOYMENT_IN_PROGRESS'|'DEPLOYMENT_COMPLETE'|'DEPLOYMENT_FAILED'|'DEPLOYMENT_IN_PROGRESS'|'DELETE_COMPLETE'|'DELETE_FAILED'|'DELETE_IN_PROGRESS',
            'Name': 'string',
            'Status': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_REVERTED'|'UPDATE_FAILED'|'READY'|'NOT_READY',
            'Tags': {
                'string': 'string'
            }
        },
    ]
}

Response Structure

(dict) – ListSignalMaps 200 response
- NextToken (string) – A token used to retrieve the next set of results in paginated list responses.
- SignalMaps (list) – Placeholder documentation for __listOfSignalMapSummary
  - (dict) – Placeholder documentation for SignalMapSummary
    - Arn (string) – A signal map’s ARN (Amazon Resource Name)
    - CreatedAt (datetime) – Placeholder documentation for __timestampIso8601
    - Description (string) – A resource’s optional description.
    - Id (string) – A signal map’s id.
    - ModifiedAt (datetime) – Placeholder documentation for __timestampIso8601
    - MonitorDeploymentStatus (string) – A signal map’s monitor deployment status.
    - Name (string) – A resource’s name. Names must be unique within the scope of a resource type in a specific region.
    - Status (string) – A signal map’s current status which is dependent on its lifecycle actions or associated jobs.
    - Tags (dict) – Represents the tags associated with a resource.
      - (string) – Placeholder documentation for __string
        
        (string) – Placeholder documentation for __string

Exceptions

MediaLive.Client.exceptions.NotFoundException
MediaLive.Client.exceptions.TooManyRequestsException
MediaLive.Client.exceptions.BadRequestException
MediaLive.Client.exceptions.InternalServerErrorException
MediaLive.Client.exceptions.ForbiddenException