AWS API Changes

2024/04/11 - AWS Elemental MediaLive - 27 new api methods

Changes AWS Elemental MediaLive introduces workflow monitor, a new feature that enables the visualization and monitoring of your media workflows. Create signal maps of your existing workflows and monitor them by creating notification and monitoring template groups.

CreateEventBridgeRuleTemplateGroup (new)

Link ¶

Creates an eventbridge rule template group to group your eventbridge rule templates and to attach to signal maps for dynamically creating notification rules.

See also: AWS API Documentation

Request Syntax

client.create_event_bridge_rule_template_group(
    Description='string',
    Name='string',
    Tags={
        'string': 'string'
    }
)

type Description:

string

param Description:

A resource's optional description.

type Name:

string

param Name:

[REQUIRED] A resource's name. Names must be unique within the scope of a resource type in a specific region.

type Tags:

dict

param Tags:

Represents the tags associated with a resource.

(string) -- Placeholder documentation for __string
- (string) -- Placeholder documentation for __string

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'Id': 'string',
    'ModifiedAt': datetime(2015, 1, 1),
    'Name': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- CreateEventBridgeRuleTemplateGroup 201 response
- Arn (string) -- An eventbridge rule template group's ARN (Amazon Resource Name)
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Description (string) -- A resource's optional description.
- Id (string) -- An eventbridge rule template group's id. AWS provided template groups have ids that start with aws-
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Name (string) -- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- Tags (dict) -- Represents the tags associated with a resource.
  - (string) -- Placeholder documentation for __string
    - (string) -- Placeholder documentation for __string

GetEventBridgeRuleTemplate (new)

Link ¶

Retrieves the specified eventbridge rule template.

See also: AWS API Documentation

Request Syntax

client.get_event_bridge_rule_template(
    Identifier='string'
)

type Identifier:

string

param Identifier:

[REQUIRED] An eventbridge rule template's identifier. Can be either be its id or current name.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'EventTargets': [
        {
            'Arn': 'string'
        },
    ],
    'EventType': 'MEDIALIVE_MULTIPLEX_ALERT'|'MEDIALIVE_MULTIPLEX_STATE_CHANGE'|'MEDIALIVE_CHANNEL_ALERT'|'MEDIALIVE_CHANNEL_INPUT_CHANGE'|'MEDIALIVE_CHANNEL_STATE_CHANGE'|'MEDIAPACKAGE_INPUT_NOTIFICATION'|'MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION'|'MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION'|'SIGNAL_MAP_ACTIVE_ALARM'|'MEDIACONNECT_ALERT'|'MEDIACONNECT_SOURCE_HEALTH'|'MEDIACONNECT_OUTPUT_HEALTH'|'MEDIACONNECT_FLOW_STATUS_CHANGE',
    'GroupId': 'string',
    'Id': 'string',
    'ModifiedAt': datetime(2015, 1, 1),
    'Name': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- GetEventBridgeRuleTemplate 200 response
- Arn (string) -- An eventbridge rule template's ARN (Amazon Resource Name)
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Description (string) -- A resource's optional description.
- EventTargets (list) -- Placeholder documentation for __listOfEventBridgeRuleTemplateTarget
  - (dict) -- The target to which to send matching events.
    - Arn (string) -- Target ARNs must be either an SNS topic or CloudWatch log group.
- EventType (string) -- The type of event to match with the rule.
- GroupId (string) -- An eventbridge rule template group's id. AWS provided template groups have ids that start with aws-
- Id (string) -- An eventbridge rule template's id. AWS provided templates have ids that start with aws-
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Name (string) -- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- Tags (dict) -- Represents the tags associated with a resource.
  - (string) -- Placeholder documentation for __string
    - (string) -- Placeholder documentation for __string

UpdateEventBridgeRuleTemplateGroup (new)

Link ¶

Updates the specified eventbridge rule template group.

See also: AWS API Documentation

Request Syntax

client.update_event_bridge_rule_template_group(
    Description='string',
    Identifier='string'
)

type Description:

string

param Description:

A resource's optional description.

type Identifier:

string

param Identifier:

[REQUIRED] An eventbridge rule template group's identifier. Can be either be its id or current name.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'Id': 'string',
    'ModifiedAt': datetime(2015, 1, 1),
    'Name': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- UpdateEventBridgeRuleTemplateGroup 200 response
- Arn (string) -- An eventbridge rule template group's ARN (Amazon Resource Name)
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Description (string) -- A resource's optional description.
- Id (string) -- An eventbridge rule template group's id. AWS provided template groups have ids that start with aws-
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Name (string) -- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- Tags (dict) -- Represents the tags associated with a resource.
  - (string) -- Placeholder documentation for __string
    - (string) -- Placeholder documentation for __string

GetSignalMap (new)

Link ¶

Retrieves the specified signal map.

See also: AWS API Documentation

Request Syntax

client.get_signal_map(
    Identifier='string'
)

type Identifier:

string

param Identifier:

[REQUIRED] A signal map's identifier. Can be either be its id or current name.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'CloudWatchAlarmTemplateGroupIds': [
        'string',
    ],
    'CreatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'DiscoveryEntryPointArn': 'string',
    'ErrorMessage': 'string',
    'EventBridgeRuleTemplateGroupIds': [
        'string',
    ],
    'FailedMediaResourceMap': {
        'string': {
            'Destinations': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ],
            'Name': 'string',
            'Sources': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ]
        }
    },
    'Id': 'string',
    'LastDiscoveredAt': datetime(2015, 1, 1),
    'LastSuccessfulMonitorDeployment': {
        'DetailsUri': 'string',
        'Status': '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'
    },
    'MediaResourceMap': {
        'string': {
            'Destinations': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ],
            'Name': 'string',
            'Sources': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ]
        }
    },
    'ModifiedAt': datetime(2015, 1, 1),
    'MonitorChangesPendingDeployment': True|False,
    'MonitorDeployment': {
        'DetailsUri': 'string',
        'ErrorMessage': 'string',
        'Status': '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) -- GetSignalMap 200 response
- Arn (string) -- A signal map's ARN (Amazon Resource Name)
- CloudWatchAlarmTemplateGroupIds (list) -- Placeholder documentation for __listOf__stringMin7Max11PatternAws097
  - (string) -- Placeholder documentation for __stringMin7Max11PatternAws097
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Description (string) -- A resource's optional description.
- DiscoveryEntryPointArn (string) -- A top-level supported AWS resource ARN to discovery a signal map from.
- ErrorMessage (string) -- Error message associated with a failed creation or failed update attempt of a signal map.
- EventBridgeRuleTemplateGroupIds (list) -- Placeholder documentation for __listOf__stringMin7Max11PatternAws097
  - (string) -- Placeholder documentation for __stringMin7Max11PatternAws097
- FailedMediaResourceMap (dict) -- A map representing an incomplete AWS media workflow as a graph.
  - (string) -- Placeholder documentation for __string
    - (dict) -- An AWS resource used in media workflows.
      - Destinations (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
      - Name (string) -- The logical name of an AWS media resource.
      - Sources (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
- Id (string) -- A signal map's id.
- LastDiscoveredAt (datetime) -- Placeholder documentation for __timestampIso8601
- LastSuccessfulMonitorDeployment (dict) -- Represents the latest successful monitor deployment of a signal map.
  - DetailsUri (string) -- URI associated with a signal map's monitor deployment.
  - Status (string) -- A signal map's monitor deployment status.
- MediaResourceMap (dict) -- A map representing an AWS media workflow as a graph.
  - (string) -- Placeholder documentation for __string
    - (dict) -- An AWS resource used in media workflows.
      - Destinations (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
      - Name (string) -- The logical name of an AWS media resource.
      - Sources (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- MonitorChangesPendingDeployment (boolean) -- If true, there are pending monitor changes for this signal map that can be deployed.
- MonitorDeployment (dict) -- Represents the latest monitor deployment of a signal map.
  - DetailsUri (string) -- URI associated with a signal map's monitor deployment.
  - ErrorMessage (string) -- Error message associated with a failed monitor deployment of a signal map.
  - Status (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

ListEventBridgeRuleTemplateGroups (new)

Link ¶

Lists eventbridge rule template groups.

See also: AWS API Documentation

Request Syntax

client.list_event_bridge_rule_template_groups(
    MaxResults=123,
    NextToken='string',
    SignalMapIdentifier='string'
)

type MaxResults:

integer

param MaxResults:

Placeholder documentation for MaxResults

type NextToken:

string

param NextToken:

A token used to retrieve the next set of results in paginated list responses.

type SignalMapIdentifier:

string

param SignalMapIdentifier:

A signal map's identifier. Can be either be its id or current name.

rtype:

dict

returns:

Response Syntax

{
    'EventBridgeRuleTemplateGroups': [
        {
            'Arn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'Description': 'string',
            'Id': 'string',
            'ModifiedAt': datetime(2015, 1, 1),
            'Name': 'string',
            'Tags': {
                'string': 'string'
            },
            'TemplateCount': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) -- ListEventBridgeRuleTemplateGroups 200 response
- EventBridgeRuleTemplateGroups (list) -- Placeholder documentation for __listOfEventBridgeRuleTemplateGroupSummary
  - (dict) -- Placeholder documentation for EventBridgeRuleTemplateGroupSummary
    - Arn (string) -- An eventbridge rule template group's ARN (Amazon Resource Name)
    - CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
    - Description (string) -- A resource's optional description.
    - Id (string) -- An eventbridge rule template group's id. AWS provided template groups have ids that start with aws-
    - ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
    - Name (string) -- A resource's name. Names must be unique within the scope of a resource type in a specific region.
    - Tags (dict) -- Represents the tags associated with a resource.
      - (string) -- Placeholder documentation for __string
        
        (string) -- Placeholder documentation for __string
    - TemplateCount (integer) -- The number of templates in a group.
- NextToken (string) -- A token used to retrieve the next set of results in paginated list responses.

CreateCloudWatchAlarmTemplate (new)

Link ¶

Creates a cloudwatch alarm template to dynamically generate cloudwatch metric alarms on targeted resource types.

See also: AWS API Documentation

Request Syntax

client.create_cloud_watch_alarm_template(
    ComparisonOperator='GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
    DatapointsToAlarm=123,
    Description='string',
    EvaluationPeriods=123,
    GroupIdentifier='string',
    MetricName='string',
    Name='string',
    Period=123,
    Statistic='SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
    Tags={
        'string': 'string'
    },
    TargetResourceType='CLOUDFRONT_DISTRIBUTION'|'MEDIALIVE_MULTIPLEX'|'MEDIALIVE_CHANNEL'|'MEDIALIVE_INPUT_DEVICE'|'MEDIAPACKAGE_CHANNEL'|'MEDIAPACKAGE_ORIGIN_ENDPOINT'|'MEDIACONNECT_FLOW'|'S3_BUCKET',
    Threshold=123.0,
    TreatMissingData='notBreaching'|'breaching'|'ignore'|'missing'
)

type ComparisonOperator:

string

param ComparisonOperator:

[REQUIRED] The comparison operator used to compare the specified statistic and the threshold.

type DatapointsToAlarm:

integer

param DatapointsToAlarm:

The number of datapoints within the evaluation period that must be breaching to trigger the alarm.

type Description:

string

param Description:

A resource's optional description.

type EvaluationPeriods:

integer

param EvaluationPeriods:

[REQUIRED] The number of periods over which data is compared to the specified threshold.

type GroupIdentifier:

string

param GroupIdentifier:

[REQUIRED] A cloudwatch alarm template group's identifier. Can be either be its id or current name.

type MetricName:

string

param MetricName:

[REQUIRED] The name of the metric associated with the alarm. Must be compatible with targetResourceType.

type Name:

string

param Name:

[REQUIRED] A resource's name. Names must be unique within the scope of a resource type in a specific region.

type Period:

integer

param Period:

[REQUIRED] The period, in seconds, over which the specified statistic is applied.

type Statistic:

string

param Statistic:

[REQUIRED] The statistic to apply to the alarm's metric data.

type Tags:

dict

param Tags:

Represents the tags associated with a resource.

(string) -- Placeholder documentation for __string
- (string) -- Placeholder documentation for __string

type TargetResourceType:

string

param TargetResourceType:

[REQUIRED] The resource type this template should dynamically generate cloudwatch metric alarms for.

type Threshold:

float

param Threshold:

[REQUIRED] The threshold value to compare with the specified statistic.

type TreatMissingData:

string

param TreatMissingData:

[REQUIRED] Specifies how missing data points are treated when evaluating the alarm's condition.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
    'CreatedAt': datetime(2015, 1, 1),
    'DatapointsToAlarm': 123,
    'Description': 'string',
    'EvaluationPeriods': 123,
    'GroupId': 'string',
    'Id': 'string',
    'MetricName': 'string',
    'ModifiedAt': datetime(2015, 1, 1),
    'Name': 'string',
    'Period': 123,
    'Statistic': 'SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
    'Tags': {
        'string': 'string'
    },
    'TargetResourceType': 'CLOUDFRONT_DISTRIBUTION'|'MEDIALIVE_MULTIPLEX'|'MEDIALIVE_CHANNEL'|'MEDIALIVE_INPUT_DEVICE'|'MEDIAPACKAGE_CHANNEL'|'MEDIAPACKAGE_ORIGIN_ENDPOINT'|'MEDIACONNECT_FLOW'|'S3_BUCKET',
    'Threshold': 123.0,
    'TreatMissingData': 'notBreaching'|'breaching'|'ignore'|'missing'
}

Response Structure

(dict) -- CreateCloudWatchAlarmTemplate 201 response
- Arn (string) -- A cloudwatch alarm template's ARN (Amazon Resource Name)
- ComparisonOperator (string) -- The comparison operator used to compare the specified statistic and the threshold.
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- DatapointsToAlarm (integer) -- The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
- Description (string) -- A resource's optional description.
- EvaluationPeriods (integer) -- The number of periods over which data is compared to the specified threshold.
- GroupId (string) -- A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
- Id (string) -- A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-
- MetricName (string) -- The name of the metric associated with the alarm. Must be compatible with targetResourceType.
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Name (string) -- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- Period (integer) -- The period, in seconds, over which the specified statistic is applied.
- Statistic (string) -- The statistic to apply to the alarm's metric data.
- Tags (dict) -- Represents the tags associated with a resource.
  - (string) -- Placeholder documentation for __string
    - (string) -- Placeholder documentation for __string
- TargetResourceType (string) -- The resource type this template should dynamically generate cloudwatch metric alarms for.
- Threshold (float) -- The threshold value to compare with the specified statistic.
- TreatMissingData (string) -- Specifies how missing data points are treated when evaluating the alarm's condition.

CreateEventBridgeRuleTemplate (new)

Link ¶

Creates an eventbridge rule template to monitor events and send notifications to your targeted resources.

See also: AWS API Documentation

Request Syntax

client.create_event_bridge_rule_template(
    Description='string',
    EventTargets=[
        {
            'Arn': 'string'
        },
    ],
    EventType='MEDIALIVE_MULTIPLEX_ALERT'|'MEDIALIVE_MULTIPLEX_STATE_CHANGE'|'MEDIALIVE_CHANNEL_ALERT'|'MEDIALIVE_CHANNEL_INPUT_CHANGE'|'MEDIALIVE_CHANNEL_STATE_CHANGE'|'MEDIAPACKAGE_INPUT_NOTIFICATION'|'MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION'|'MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION'|'SIGNAL_MAP_ACTIVE_ALARM'|'MEDIACONNECT_ALERT'|'MEDIACONNECT_SOURCE_HEALTH'|'MEDIACONNECT_OUTPUT_HEALTH'|'MEDIACONNECT_FLOW_STATUS_CHANGE',
    GroupIdentifier='string',
    Name='string',
    Tags={
        'string': 'string'
    }
)

type Description:

string

param Description:

A resource's optional description.

type EventTargets:

list

param EventTargets:

Placeholder documentation for __listOfEventBridgeRuleTemplateTarget

(dict) -- The target to which to send matching events.
- Arn (string) -- [REQUIRED] Target ARNs must be either an SNS topic or CloudWatch log group.

type EventType:

string

param EventType:

[REQUIRED] The type of event to match with the rule.

type GroupIdentifier:

string

param GroupIdentifier:

[REQUIRED] An eventbridge rule template group's identifier. Can be either be its id or current name.

type Name:

string

param Name:

[REQUIRED] A resource's name. Names must be unique within the scope of a resource type in a specific region.

type Tags:

dict

param Tags:

Represents the tags associated with a resource.

(string) -- Placeholder documentation for __string
- (string) -- Placeholder documentation for __string

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'EventTargets': [
        {
            'Arn': 'string'
        },
    ],
    'EventType': 'MEDIALIVE_MULTIPLEX_ALERT'|'MEDIALIVE_MULTIPLEX_STATE_CHANGE'|'MEDIALIVE_CHANNEL_ALERT'|'MEDIALIVE_CHANNEL_INPUT_CHANGE'|'MEDIALIVE_CHANNEL_STATE_CHANGE'|'MEDIAPACKAGE_INPUT_NOTIFICATION'|'MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION'|'MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION'|'SIGNAL_MAP_ACTIVE_ALARM'|'MEDIACONNECT_ALERT'|'MEDIACONNECT_SOURCE_HEALTH'|'MEDIACONNECT_OUTPUT_HEALTH'|'MEDIACONNECT_FLOW_STATUS_CHANGE',
    'GroupId': 'string',
    'Id': 'string',
    'ModifiedAt': datetime(2015, 1, 1),
    'Name': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- CreateEventBridgeRuleTemplate 201 response
- Arn (string) -- An eventbridge rule template's ARN (Amazon Resource Name)
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Description (string) -- A resource's optional description.
- EventTargets (list) -- Placeholder documentation for __listOfEventBridgeRuleTemplateTarget
  - (dict) -- The target to which to send matching events.
    - Arn (string) -- Target ARNs must be either an SNS topic or CloudWatch log group.
- EventType (string) -- The type of event to match with the rule.
- GroupId (string) -- An eventbridge rule template group's id. AWS provided template groups have ids that start with aws-
- Id (string) -- An eventbridge rule template's id. AWS provided templates have ids that start with aws-
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Name (string) -- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- Tags (dict) -- Represents the tags associated with a resource.
  - (string) -- Placeholder documentation for __string
    - (string) -- Placeholder documentation for __string

DeleteSignalMap (new)

Link ¶

Deletes the specified signal map.

See also: AWS API Documentation

Request Syntax

client.delete_signal_map(
    Identifier='string'
)

type Identifier:: string
param Identifier:: [REQUIRED] A signal map's identifier. Can be either be its id or current name.
returns:: None

ListSignalMaps (new)

Link ¶

Lists signal maps.

See also: AWS API Documentation

Request Syntax

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

type CloudWatchAlarmTemplateGroupIdentifier:

string

param CloudWatchAlarmTemplateGroupIdentifier:

A cloudwatch alarm template group's identifier. Can be either be its id or current name.

type EventBridgeRuleTemplateGroupIdentifier:

string

param EventBridgeRuleTemplateGroupIdentifier:

An eventbridge rule template group's identifier. Can be either be its id or current name.

type MaxResults:

integer

param MaxResults:

Placeholder documentation for MaxResults

type NextToken:

string

param NextToken:

A token used to retrieve the next set of results in paginated list responses.

rtype:

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

GetEventBridgeRuleTemplateGroup (new)

Link ¶

Retrieves the specified eventbridge rule template group.

See also: AWS API Documentation

Request Syntax

client.get_event_bridge_rule_template_group(
    Identifier='string'
)

type Identifier:

string

param Identifier:

[REQUIRED] An eventbridge rule template group's identifier. Can be either be its id or current name.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'Id': 'string',
    'ModifiedAt': datetime(2015, 1, 1),
    'Name': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- GetEventBridgeRuleTemplateGroup 200 response
- Arn (string) -- An eventbridge rule template group's ARN (Amazon Resource Name)
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Description (string) -- A resource's optional description.
- Id (string) -- An eventbridge rule template group's id. AWS provided template groups have ids that start with aws-
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Name (string) -- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- Tags (dict) -- Represents the tags associated with a resource.
  - (string) -- Placeholder documentation for __string
    - (string) -- Placeholder documentation for __string

GetCloudWatchAlarmTemplateGroup (new)

Link ¶

Retrieves the specified cloudwatch alarm template group.

See also: AWS API Documentation

Request Syntax

client.get_cloud_watch_alarm_template_group(
    Identifier='string'
)

type Identifier:

string

param Identifier:

[REQUIRED] A cloudwatch alarm template group's identifier. Can be either be its id or current name.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'Id': 'string',
    'ModifiedAt': datetime(2015, 1, 1),
    'Name': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- GetCloudWatchAlarmTemplateGroup 200 response
- Arn (string) -- A cloudwatch alarm template group's ARN (Amazon Resource Name)
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Description (string) -- A resource's optional description.
- Id (string) -- A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Name (string) -- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- Tags (dict) -- Represents the tags associated with a resource.
  - (string) -- Placeholder documentation for __string
    - (string) -- Placeholder documentation for __string

GetCloudWatchAlarmTemplate (new)

Link ¶

Retrieves the specified cloudwatch alarm template.

See also: AWS API Documentation

Request Syntax

client.get_cloud_watch_alarm_template(
    Identifier='string'
)

type Identifier:

string

param Identifier:

[REQUIRED] A cloudwatch alarm template's identifier. Can be either be its id or current name.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
    'CreatedAt': datetime(2015, 1, 1),
    'DatapointsToAlarm': 123,
    'Description': 'string',
    'EvaluationPeriods': 123,
    'GroupId': 'string',
    'Id': 'string',
    'MetricName': 'string',
    'ModifiedAt': datetime(2015, 1, 1),
    'Name': 'string',
    'Period': 123,
    'Statistic': 'SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
    'Tags': {
        'string': 'string'
    },
    'TargetResourceType': 'CLOUDFRONT_DISTRIBUTION'|'MEDIALIVE_MULTIPLEX'|'MEDIALIVE_CHANNEL'|'MEDIALIVE_INPUT_DEVICE'|'MEDIAPACKAGE_CHANNEL'|'MEDIAPACKAGE_ORIGIN_ENDPOINT'|'MEDIACONNECT_FLOW'|'S3_BUCKET',
    'Threshold': 123.0,
    'TreatMissingData': 'notBreaching'|'breaching'|'ignore'|'missing'
}

Response Structure

(dict) -- GetCloudWatchAlarmTemplate 200 response
- Arn (string) -- A cloudwatch alarm template's ARN (Amazon Resource Name)
- ComparisonOperator (string) -- The comparison operator used to compare the specified statistic and the threshold.
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- DatapointsToAlarm (integer) -- The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
- Description (string) -- A resource's optional description.
- EvaluationPeriods (integer) -- The number of periods over which data is compared to the specified threshold.
- GroupId (string) -- A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
- Id (string) -- A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-
- MetricName (string) -- The name of the metric associated with the alarm. Must be compatible with targetResourceType.
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Name (string) -- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- Period (integer) -- The period, in seconds, over which the specified statistic is applied.
- Statistic (string) -- The statistic to apply to the alarm's metric data.
- Tags (dict) -- Represents the tags associated with a resource.
  - (string) -- Placeholder documentation for __string
    - (string) -- Placeholder documentation for __string
- TargetResourceType (string) -- The resource type this template should dynamically generate cloudwatch metric alarms for.
- Threshold (float) -- The threshold value to compare with the specified statistic.
- TreatMissingData (string) -- Specifies how missing data points are treated when evaluating the alarm's condition.

UpdateCloudWatchAlarmTemplateGroup (new)

Link ¶

Updates the specified cloudwatch alarm template group.

See also: AWS API Documentation

Request Syntax

client.update_cloud_watch_alarm_template_group(
    Description='string',
    Identifier='string'
)

type Description:

string

param Description:

A resource's optional description.

type Identifier:

string

param Identifier:

[REQUIRED] A cloudwatch alarm template group's identifier. Can be either be its id or current name.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'Id': 'string',
    'ModifiedAt': datetime(2015, 1, 1),
    'Name': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- UpdateCloudWatchAlarmTemplateGroup 200 response
- Arn (string) -- A cloudwatch alarm template group's ARN (Amazon Resource Name)
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Description (string) -- A resource's optional description.
- Id (string) -- A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Name (string) -- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- Tags (dict) -- Represents the tags associated with a resource.
  - (string) -- Placeholder documentation for __string
    - (string) -- Placeholder documentation for __string

ListCloudWatchAlarmTemplateGroups (new)

Link ¶

Lists cloudwatch alarm template groups.

See also: AWS API Documentation

Request Syntax

client.list_cloud_watch_alarm_template_groups(
    MaxResults=123,
    NextToken='string',
    Scope='string',
    SignalMapIdentifier='string'
)

type MaxResults:

integer

param MaxResults:

Placeholder documentation for MaxResults

type NextToken:

string

param NextToken:

A token used to retrieve the next set of results in paginated list responses.

type Scope:

string

param Scope:

Represents the scope of a resource, with options for all scopes, AWS provided resources, or local resources.

type SignalMapIdentifier:

string

param SignalMapIdentifier:

A signal map's identifier. Can be either be its id or current name.

rtype:

dict

returns:

Response Syntax

{
    'CloudWatchAlarmTemplateGroups': [
        {
            'Arn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'Description': 'string',
            'Id': 'string',
            'ModifiedAt': datetime(2015, 1, 1),
            'Name': 'string',
            'Tags': {
                'string': 'string'
            },
            'TemplateCount': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) -- ListCloudWatchAlarmTemplateGroups 200 response
- CloudWatchAlarmTemplateGroups (list) -- Placeholder documentation for __listOfCloudWatchAlarmTemplateGroupSummary
  - (dict) -- Placeholder documentation for CloudWatchAlarmTemplateGroupSummary
    - Arn (string) -- A cloudwatch alarm template group's ARN (Amazon Resource Name)
    - CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
    - Description (string) -- A resource's optional description.
    - Id (string) -- A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
    - ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
    - Name (string) -- A resource's name. Names must be unique within the scope of a resource type in a specific region.
    - Tags (dict) -- Represents the tags associated with a resource.
      - (string) -- Placeholder documentation for __string
        
        (string) -- Placeholder documentation for __string
    - TemplateCount (integer) -- The number of templates in a group.
- NextToken (string) -- A token used to retrieve the next set of results in paginated list responses.

CreateCloudWatchAlarmTemplateGroup (new)

Link ¶

Creates a cloudwatch alarm template group to group your cloudwatch alarm templates and to attach to signal maps for dynamically creating alarms.

See also: AWS API Documentation

Request Syntax

client.create_cloud_watch_alarm_template_group(
    Description='string',
    Name='string',
    Tags={
        'string': 'string'
    }
)

type Description:

string

param Description:

A resource's optional description.

type Name:

string

param Name:

[REQUIRED] A resource's name. Names must be unique within the scope of a resource type in a specific region.

type Tags:

dict

param Tags:

Represents the tags associated with a resource.

(string) -- Placeholder documentation for __string
- (string) -- Placeholder documentation for __string

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'Id': 'string',
    'ModifiedAt': datetime(2015, 1, 1),
    'Name': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- CreateCloudWatchAlarmTemplateGroup 201 response
- Arn (string) -- A cloudwatch alarm template group's ARN (Amazon Resource Name)
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Description (string) -- A resource's optional description.
- Id (string) -- A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Name (string) -- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- Tags (dict) -- Represents the tags associated with a resource.
  - (string) -- Placeholder documentation for __string
    - (string) -- Placeholder documentation for __string

StartUpdateSignalMap (new)

Link ¶

Initiates an update for the specified signal map. Will discover a new signal map if a changed discoveryEntryPointArn is provided.

See also: AWS API Documentation

Request Syntax

client.start_update_signal_map(
    CloudWatchAlarmTemplateGroupIdentifiers=[
        'string',
    ],
    Description='string',
    DiscoveryEntryPointArn='string',
    EventBridgeRuleTemplateGroupIdentifiers=[
        'string',
    ],
    ForceRediscovery=True|False,
    Identifier='string',
    Name='string'
)

type CloudWatchAlarmTemplateGroupIdentifiers:

list

param CloudWatchAlarmTemplateGroupIdentifiers:

Placeholder documentation for __listOf__stringPatternS

(string) -- Placeholder documentation for __stringPatternS

type Description:

string

param Description:

A resource's optional description.

type DiscoveryEntryPointArn:

string

param DiscoveryEntryPointArn:

A top-level supported AWS resource ARN to discovery a signal map from.

type EventBridgeRuleTemplateGroupIdentifiers:

list

param EventBridgeRuleTemplateGroupIdentifiers:

Placeholder documentation for __listOf__stringPatternS

(string) -- Placeholder documentation for __stringPatternS

type ForceRediscovery:

boolean

param ForceRediscovery:

If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided.

type Identifier:

string

param Identifier:

[REQUIRED] A signal map's identifier. Can be either be its id or current name.

type Name:

string

param Name:

A resource's name. Names must be unique within the scope of a resource type in a specific region.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'CloudWatchAlarmTemplateGroupIds': [
        'string',
    ],
    'CreatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'DiscoveryEntryPointArn': 'string',
    'ErrorMessage': 'string',
    'EventBridgeRuleTemplateGroupIds': [
        'string',
    ],
    'FailedMediaResourceMap': {
        'string': {
            'Destinations': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ],
            'Name': 'string',
            'Sources': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ]
        }
    },
    'Id': 'string',
    'LastDiscoveredAt': datetime(2015, 1, 1),
    'LastSuccessfulMonitorDeployment': {
        'DetailsUri': 'string',
        'Status': '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'
    },
    'MediaResourceMap': {
        'string': {
            'Destinations': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ],
            'Name': 'string',
            'Sources': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ]
        }
    },
    'ModifiedAt': datetime(2015, 1, 1),
    'MonitorChangesPendingDeployment': True|False,
    'MonitorDeployment': {
        'DetailsUri': 'string',
        'ErrorMessage': 'string',
        'Status': '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) -- StartUpdateSignalMap 202 response
- Arn (string) -- A signal map's ARN (Amazon Resource Name)
- CloudWatchAlarmTemplateGroupIds (list) -- Placeholder documentation for __listOf__stringMin7Max11PatternAws097
  - (string) -- Placeholder documentation for __stringMin7Max11PatternAws097
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Description (string) -- A resource's optional description.
- DiscoveryEntryPointArn (string) -- A top-level supported AWS resource ARN to discovery a signal map from.
- ErrorMessage (string) -- Error message associated with a failed creation or failed update attempt of a signal map.
- EventBridgeRuleTemplateGroupIds (list) -- Placeholder documentation for __listOf__stringMin7Max11PatternAws097
  - (string) -- Placeholder documentation for __stringMin7Max11PatternAws097
- FailedMediaResourceMap (dict) -- A map representing an incomplete AWS media workflow as a graph.
  - (string) -- Placeholder documentation for __string
    - (dict) -- An AWS resource used in media workflows.
      - Destinations (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
      - Name (string) -- The logical name of an AWS media resource.
      - Sources (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
- Id (string) -- A signal map's id.
- LastDiscoveredAt (datetime) -- Placeholder documentation for __timestampIso8601
- LastSuccessfulMonitorDeployment (dict) -- Represents the latest successful monitor deployment of a signal map.
  - DetailsUri (string) -- URI associated with a signal map's monitor deployment.
  - Status (string) -- A signal map's monitor deployment status.
- MediaResourceMap (dict) -- A map representing an AWS media workflow as a graph.
  - (string) -- Placeholder documentation for __string
    - (dict) -- An AWS resource used in media workflows.
      - Destinations (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
      - Name (string) -- The logical name of an AWS media resource.
      - Sources (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- MonitorChangesPendingDeployment (boolean) -- If true, there are pending monitor changes for this signal map that can be deployed.
- MonitorDeployment (dict) -- Represents the latest monitor deployment of a signal map.
  - DetailsUri (string) -- URI associated with a signal map's monitor deployment.
  - ErrorMessage (string) -- Error message associated with a failed monitor deployment of a signal map.
  - Status (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

ListCloudWatchAlarmTemplates (new)

Link ¶

Lists cloudwatch alarm templates.

See also: AWS API Documentation

Request Syntax

client.list_cloud_watch_alarm_templates(
    GroupIdentifier='string',
    MaxResults=123,
    NextToken='string',
    Scope='string',
    SignalMapIdentifier='string'
)

type GroupIdentifier:

string

param GroupIdentifier:

A cloudwatch alarm template group's identifier. Can be either be its id or current name.

type MaxResults:

integer

param MaxResults:

Placeholder documentation for MaxResults

type NextToken:

string

param NextToken:

A token used to retrieve the next set of results in paginated list responses.

type Scope:

string

param Scope:

Represents the scope of a resource, with options for all scopes, AWS provided resources, or local resources.

type SignalMapIdentifier:

string

param SignalMapIdentifier:

A signal map's identifier. Can be either be its id or current name.

rtype:

dict

returns:

Response Syntax

{
    'CloudWatchAlarmTemplates': [
        {
            'Arn': 'string',
            'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
            'CreatedAt': datetime(2015, 1, 1),
            'DatapointsToAlarm': 123,
            'Description': 'string',
            'EvaluationPeriods': 123,
            'GroupId': 'string',
            'Id': 'string',
            'MetricName': 'string',
            'ModifiedAt': datetime(2015, 1, 1),
            'Name': 'string',
            'Period': 123,
            'Statistic': 'SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
            'Tags': {
                'string': 'string'
            },
            'TargetResourceType': 'CLOUDFRONT_DISTRIBUTION'|'MEDIALIVE_MULTIPLEX'|'MEDIALIVE_CHANNEL'|'MEDIALIVE_INPUT_DEVICE'|'MEDIAPACKAGE_CHANNEL'|'MEDIAPACKAGE_ORIGIN_ENDPOINT'|'MEDIACONNECT_FLOW'|'S3_BUCKET',
            'Threshold': 123.0,
            'TreatMissingData': 'notBreaching'|'breaching'|'ignore'|'missing'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) -- ListCloudWatchAlarmTemplates 200 response
- CloudWatchAlarmTemplates (list) -- Placeholder documentation for __listOfCloudWatchAlarmTemplateSummary
  - (dict) -- Placeholder documentation for CloudWatchAlarmTemplateSummary
    - Arn (string) -- A cloudwatch alarm template's ARN (Amazon Resource Name)
    - ComparisonOperator (string) -- The comparison operator used to compare the specified statistic and the threshold.
    - CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
    - DatapointsToAlarm (integer) -- The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
    - Description (string) -- A resource's optional description.
    - EvaluationPeriods (integer) -- The number of periods over which data is compared to the specified threshold.
    - GroupId (string) -- A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
    - Id (string) -- A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-
    - MetricName (string) -- The name of the metric associated with the alarm. Must be compatible with targetResourceType.
    - ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
    - Name (string) -- A resource's name. Names must be unique within the scope of a resource type in a specific region.
    - Period (integer) -- The period, in seconds, over which the specified statistic is applied.
    - Statistic (string) -- The statistic to apply to the alarm's metric data.
    - Tags (dict) -- Represents the tags associated with a resource.
      - (string) -- Placeholder documentation for __string
        
        (string) -- Placeholder documentation for __string
    - TargetResourceType (string) -- The resource type this template should dynamically generate cloudwatch metric alarms for.
    - Threshold (float) -- The threshold value to compare with the specified statistic.
    - TreatMissingData (string) -- Specifies how missing data points are treated when evaluating the alarm's condition.
- NextToken (string) -- A token used to retrieve the next set of results in paginated list responses.

UpdateEventBridgeRuleTemplate (new)

Link ¶

Updates the specified eventbridge rule template.

See also: AWS API Documentation

Request Syntax

client.update_event_bridge_rule_template(
    Description='string',
    EventTargets=[
        {
            'Arn': 'string'
        },
    ],
    EventType='MEDIALIVE_MULTIPLEX_ALERT'|'MEDIALIVE_MULTIPLEX_STATE_CHANGE'|'MEDIALIVE_CHANNEL_ALERT'|'MEDIALIVE_CHANNEL_INPUT_CHANGE'|'MEDIALIVE_CHANNEL_STATE_CHANGE'|'MEDIAPACKAGE_INPUT_NOTIFICATION'|'MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION'|'MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION'|'SIGNAL_MAP_ACTIVE_ALARM'|'MEDIACONNECT_ALERT'|'MEDIACONNECT_SOURCE_HEALTH'|'MEDIACONNECT_OUTPUT_HEALTH'|'MEDIACONNECT_FLOW_STATUS_CHANGE',
    GroupIdentifier='string',
    Identifier='string',
    Name='string'
)

type Description:

string

param Description:

A resource's optional description.

type EventTargets:

list

param EventTargets:

Placeholder documentation for __listOfEventBridgeRuleTemplateTarget

(dict) -- The target to which to send matching events.
- Arn (string) -- [REQUIRED] Target ARNs must be either an SNS topic or CloudWatch log group.

type EventType:

string

param EventType:

The type of event to match with the rule.

type GroupIdentifier:

string

param GroupIdentifier:

An eventbridge rule template group's identifier. Can be either be its id or current name.

type Identifier:

string

param Identifier:

[REQUIRED] An eventbridge rule template's identifier. Can be either be its id or current name.

type Name:

string

param Name:

A resource's name. Names must be unique within the scope of a resource type in a specific region.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'EventTargets': [
        {
            'Arn': 'string'
        },
    ],
    'EventType': 'MEDIALIVE_MULTIPLEX_ALERT'|'MEDIALIVE_MULTIPLEX_STATE_CHANGE'|'MEDIALIVE_CHANNEL_ALERT'|'MEDIALIVE_CHANNEL_INPUT_CHANGE'|'MEDIALIVE_CHANNEL_STATE_CHANGE'|'MEDIAPACKAGE_INPUT_NOTIFICATION'|'MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION'|'MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION'|'SIGNAL_MAP_ACTIVE_ALARM'|'MEDIACONNECT_ALERT'|'MEDIACONNECT_SOURCE_HEALTH'|'MEDIACONNECT_OUTPUT_HEALTH'|'MEDIACONNECT_FLOW_STATUS_CHANGE',
    'GroupId': 'string',
    'Id': 'string',
    'ModifiedAt': datetime(2015, 1, 1),
    'Name': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) -- UpdateEventBridgeRuleTemplate 200 response
- Arn (string) -- An eventbridge rule template's ARN (Amazon Resource Name)
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Description (string) -- A resource's optional description.
- EventTargets (list) -- Placeholder documentation for __listOfEventBridgeRuleTemplateTarget
  - (dict) -- The target to which to send matching events.
    - Arn (string) -- Target ARNs must be either an SNS topic or CloudWatch log group.
- EventType (string) -- The type of event to match with the rule.
- GroupId (string) -- An eventbridge rule template group's id. AWS provided template groups have ids that start with aws-
- Id (string) -- An eventbridge rule template's id. AWS provided templates have ids that start with aws-
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Name (string) -- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- Tags (dict) -- Represents the tags associated with a resource.
  - (string) -- Placeholder documentation for __string
    - (string) -- Placeholder documentation for __string

DeleteCloudWatchAlarmTemplateGroup (new)

Link ¶

Deletes a cloudwatch alarm template group. You must detach this group from all signal maps and ensure its existing templates are moved to another group or deleted.

See also: AWS API Documentation

Request Syntax

client.delete_cloud_watch_alarm_template_group(
    Identifier='string'
)

type Identifier:: string
param Identifier:: [REQUIRED] A cloudwatch alarm template group's identifier. Can be either be its id or current name.
returns:: None

DeleteCloudWatchAlarmTemplate (new)

Link ¶

Deletes a cloudwatch alarm template.

See also: AWS API Documentation

Request Syntax

client.delete_cloud_watch_alarm_template(
    Identifier='string'
)

type Identifier:: string
param Identifier:: [REQUIRED] A cloudwatch alarm template's identifier. Can be either be its id or current name.
returns:: None

CreateSignalMap (new)

Link ¶

Initiates the creation of a new signal map. Will discover a new mediaResourceMap based on the provided discoveryEntryPointArn.

See also: AWS API Documentation

Request Syntax

client.create_signal_map(
    CloudWatchAlarmTemplateGroupIdentifiers=[
        'string',
    ],
    Description='string',
    DiscoveryEntryPointArn='string',
    EventBridgeRuleTemplateGroupIdentifiers=[
        'string',
    ],
    Name='string',
    Tags={
        'string': 'string'
    }
)

type CloudWatchAlarmTemplateGroupIdentifiers:

list

param CloudWatchAlarmTemplateGroupIdentifiers:

Placeholder documentation for __listOf__stringPatternS

(string) -- Placeholder documentation for __stringPatternS

type Description:

string

param Description:

A resource's optional description.

type DiscoveryEntryPointArn:

string

param DiscoveryEntryPointArn:

[REQUIRED] A top-level supported AWS resource ARN to discovery a signal map from.

type EventBridgeRuleTemplateGroupIdentifiers:

list

param EventBridgeRuleTemplateGroupIdentifiers:

Placeholder documentation for __listOf__stringPatternS

(string) -- Placeholder documentation for __stringPatternS

type Name:

string

param Name:

[REQUIRED] A resource's name. Names must be unique within the scope of a resource type in a specific region.

type Tags:

dict

param Tags:

Represents the tags associated with a resource.

(string) -- Placeholder documentation for __string
- (string) -- Placeholder documentation for __string

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'CloudWatchAlarmTemplateGroupIds': [
        'string',
    ],
    'CreatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'DiscoveryEntryPointArn': 'string',
    'ErrorMessage': 'string',
    'EventBridgeRuleTemplateGroupIds': [
        'string',
    ],
    'FailedMediaResourceMap': {
        'string': {
            'Destinations': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ],
            'Name': 'string',
            'Sources': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ]
        }
    },
    'Id': 'string',
    'LastDiscoveredAt': datetime(2015, 1, 1),
    'LastSuccessfulMonitorDeployment': {
        'DetailsUri': 'string',
        'Status': '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'
    },
    'MediaResourceMap': {
        'string': {
            'Destinations': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ],
            'Name': 'string',
            'Sources': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ]
        }
    },
    'ModifiedAt': datetime(2015, 1, 1),
    'MonitorChangesPendingDeployment': True|False,
    'MonitorDeployment': {
        'DetailsUri': 'string',
        'ErrorMessage': 'string',
        'Status': '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) -- CreateSignalMap 201 response
- Arn (string) -- A signal map's ARN (Amazon Resource Name)
- CloudWatchAlarmTemplateGroupIds (list) -- Placeholder documentation for __listOf__stringMin7Max11PatternAws097
  - (string) -- Placeholder documentation for __stringMin7Max11PatternAws097
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Description (string) -- A resource's optional description.
- DiscoveryEntryPointArn (string) -- A top-level supported AWS resource ARN to discovery a signal map from.
- ErrorMessage (string) -- Error message associated with a failed creation or failed update attempt of a signal map.
- EventBridgeRuleTemplateGroupIds (list) -- Placeholder documentation for __listOf__stringMin7Max11PatternAws097
  - (string) -- Placeholder documentation for __stringMin7Max11PatternAws097
- FailedMediaResourceMap (dict) -- A map representing an incomplete AWS media workflow as a graph.
  - (string) -- Placeholder documentation for __string
    - (dict) -- An AWS resource used in media workflows.
      - Destinations (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
      - Name (string) -- The logical name of an AWS media resource.
      - Sources (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
- Id (string) -- A signal map's id.
- LastDiscoveredAt (datetime) -- Placeholder documentation for __timestampIso8601
- LastSuccessfulMonitorDeployment (dict) -- Represents the latest successful monitor deployment of a signal map.
  - DetailsUri (string) -- URI associated with a signal map's monitor deployment.
  - Status (string) -- A signal map's monitor deployment status.
- MediaResourceMap (dict) -- A map representing an AWS media workflow as a graph.
  - (string) -- Placeholder documentation for __string
    - (dict) -- An AWS resource used in media workflows.
      - Destinations (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
      - Name (string) -- The logical name of an AWS media resource.
      - Sources (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- MonitorChangesPendingDeployment (boolean) -- If true, there are pending monitor changes for this signal map that can be deployed.
- MonitorDeployment (dict) -- Represents the latest monitor deployment of a signal map.
  - DetailsUri (string) -- URI associated with a signal map's monitor deployment.
  - ErrorMessage (string) -- Error message associated with a failed monitor deployment of a signal map.
  - Status (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

DeleteEventBridgeRuleTemplateGroup (new)

Link ¶

Deletes an eventbridge rule template group. You must detach this group from all signal maps and ensure its existing templates are moved to another group or deleted.

See also: AWS API Documentation

Request Syntax

client.delete_event_bridge_rule_template_group(
    Identifier='string'
)

type Identifier:: string
param Identifier:: [REQUIRED] An eventbridge rule template group's identifier. Can be either be its id or current name.
returns:: None

UpdateCloudWatchAlarmTemplate (new)

Link ¶

Updates the specified cloudwatch alarm template.

See also: AWS API Documentation

Request Syntax

client.update_cloud_watch_alarm_template(
    ComparisonOperator='GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
    DatapointsToAlarm=123,
    Description='string',
    EvaluationPeriods=123,
    GroupIdentifier='string',
    Identifier='string',
    MetricName='string',
    Name='string',
    Period=123,
    Statistic='SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
    TargetResourceType='CLOUDFRONT_DISTRIBUTION'|'MEDIALIVE_MULTIPLEX'|'MEDIALIVE_CHANNEL'|'MEDIALIVE_INPUT_DEVICE'|'MEDIAPACKAGE_CHANNEL'|'MEDIAPACKAGE_ORIGIN_ENDPOINT'|'MEDIACONNECT_FLOW'|'S3_BUCKET',
    Threshold=123.0,
    TreatMissingData='notBreaching'|'breaching'|'ignore'|'missing'
)

type ComparisonOperator:

string

param ComparisonOperator:

The comparison operator used to compare the specified statistic and the threshold.

type DatapointsToAlarm:

integer

param DatapointsToAlarm:

The number of datapoints within the evaluation period that must be breaching to trigger the alarm.

type Description:

string

param Description:

A resource's optional description.

type EvaluationPeriods:

integer

param EvaluationPeriods:

The number of periods over which data is compared to the specified threshold.

type GroupIdentifier:

string

param GroupIdentifier:

A cloudwatch alarm template group's identifier. Can be either be its id or current name.

type Identifier:

string

param Identifier:

[REQUIRED] A cloudwatch alarm template's identifier. Can be either be its id or current name.

type MetricName:

string

param MetricName:

The name of the metric associated with the alarm. Must be compatible with targetResourceType.

type Name:

string

param Name:

A resource's name. Names must be unique within the scope of a resource type in a specific region.

type Period:

integer

param Period:

The period, in seconds, over which the specified statistic is applied.

type Statistic:

string

param Statistic:

The statistic to apply to the alarm's metric data.

type TargetResourceType:

string

param TargetResourceType:

The resource type this template should dynamically generate cloudwatch metric alarms for.

type Threshold:

float

param Threshold:

The threshold value to compare with the specified statistic.

type TreatMissingData:

string

param TreatMissingData:

Specifies how missing data points are treated when evaluating the alarm's condition.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'ComparisonOperator': 'GreaterThanOrEqualToThreshold'|'GreaterThanThreshold'|'LessThanThreshold'|'LessThanOrEqualToThreshold',
    'CreatedAt': datetime(2015, 1, 1),
    'DatapointsToAlarm': 123,
    'Description': 'string',
    'EvaluationPeriods': 123,
    'GroupId': 'string',
    'Id': 'string',
    'MetricName': 'string',
    'ModifiedAt': datetime(2015, 1, 1),
    'Name': 'string',
    'Period': 123,
    'Statistic': 'SampleCount'|'Average'|'Sum'|'Minimum'|'Maximum',
    'Tags': {
        'string': 'string'
    },
    'TargetResourceType': 'CLOUDFRONT_DISTRIBUTION'|'MEDIALIVE_MULTIPLEX'|'MEDIALIVE_CHANNEL'|'MEDIALIVE_INPUT_DEVICE'|'MEDIAPACKAGE_CHANNEL'|'MEDIAPACKAGE_ORIGIN_ENDPOINT'|'MEDIACONNECT_FLOW'|'S3_BUCKET',
    'Threshold': 123.0,
    'TreatMissingData': 'notBreaching'|'breaching'|'ignore'|'missing'
}

Response Structure

(dict) -- UpdateCloudWatchAlarmTemplate 200 response
- Arn (string) -- A cloudwatch alarm template's ARN (Amazon Resource Name)
- ComparisonOperator (string) -- The comparison operator used to compare the specified statistic and the threshold.
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- DatapointsToAlarm (integer) -- The number of datapoints within the evaluation period that must be breaching to trigger the alarm.
- Description (string) -- A resource's optional description.
- EvaluationPeriods (integer) -- The number of periods over which data is compared to the specified threshold.
- GroupId (string) -- A cloudwatch alarm template group's id. AWS provided template groups have ids that start with aws-
- Id (string) -- A cloudwatch alarm template's id. AWS provided templates have ids that start with aws-
- MetricName (string) -- The name of the metric associated with the alarm. Must be compatible with targetResourceType.
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Name (string) -- A resource's name. Names must be unique within the scope of a resource type in a specific region.
- Period (integer) -- The period, in seconds, over which the specified statistic is applied.
- Statistic (string) -- The statistic to apply to the alarm's metric data.
- Tags (dict) -- Represents the tags associated with a resource.
  - (string) -- Placeholder documentation for __string
    - (string) -- Placeholder documentation for __string
- TargetResourceType (string) -- The resource type this template should dynamically generate cloudwatch metric alarms for.
- Threshold (float) -- The threshold value to compare with the specified statistic.
- TreatMissingData (string) -- Specifies how missing data points are treated when evaluating the alarm's condition.

ListEventBridgeRuleTemplates (new)

Link ¶

Lists eventbridge rule templates.

See also: AWS API Documentation

Request Syntax

client.list_event_bridge_rule_templates(
    GroupIdentifier='string',
    MaxResults=123,
    NextToken='string',
    SignalMapIdentifier='string'
)

type GroupIdentifier:

string

param GroupIdentifier:

An eventbridge rule template group's identifier. Can be either be its id or current name.

type MaxResults:

integer

param MaxResults:

Placeholder documentation for MaxResults

type NextToken:

string

param NextToken:

A token used to retrieve the next set of results in paginated list responses.

type SignalMapIdentifier:

string

param SignalMapIdentifier:

A signal map's identifier. Can be either be its id or current name.

rtype:

dict

returns:

Response Syntax

{
    'EventBridgeRuleTemplates': [
        {
            'Arn': 'string',
            'CreatedAt': datetime(2015, 1, 1),
            'Description': 'string',
            'EventTargetCount': 123,
            'EventType': 'MEDIALIVE_MULTIPLEX_ALERT'|'MEDIALIVE_MULTIPLEX_STATE_CHANGE'|'MEDIALIVE_CHANNEL_ALERT'|'MEDIALIVE_CHANNEL_INPUT_CHANGE'|'MEDIALIVE_CHANNEL_STATE_CHANGE'|'MEDIAPACKAGE_INPUT_NOTIFICATION'|'MEDIAPACKAGE_KEY_PROVIDER_NOTIFICATION'|'MEDIAPACKAGE_HARVEST_JOB_NOTIFICATION'|'SIGNAL_MAP_ACTIVE_ALARM'|'MEDIACONNECT_ALERT'|'MEDIACONNECT_SOURCE_HEALTH'|'MEDIACONNECT_OUTPUT_HEALTH'|'MEDIACONNECT_FLOW_STATUS_CHANGE',
            'GroupId': 'string',
            'Id': 'string',
            'ModifiedAt': datetime(2015, 1, 1),
            'Name': 'string',
            'Tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) -- ListEventBridgeRuleTemplates 200 response
- EventBridgeRuleTemplates (list) -- Placeholder documentation for __listOfEventBridgeRuleTemplateSummary
  - (dict) -- Placeholder documentation for EventBridgeRuleTemplateSummary
    - Arn (string) -- An eventbridge rule template's ARN (Amazon Resource Name)
    - CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
    - Description (string) -- A resource's optional description.
    - EventTargetCount (integer) -- The number of targets configured to send matching events.
    - EventType (string) -- The type of event to match with the rule.
    - GroupId (string) -- An eventbridge rule template group's id. AWS provided template groups have ids that start with aws-
    - Id (string) -- An eventbridge rule template's id. AWS provided templates have ids that start with aws-
    - ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
    - Name (string) -- A resource's name. Names must be unique within the scope of a resource type in a specific region.
    - Tags (dict) -- Represents the tags associated with a resource.
      - (string) -- Placeholder documentation for __string
        
        (string) -- Placeholder documentation for __string
- NextToken (string) -- A token used to retrieve the next set of results in paginated list responses.

StartMonitorDeployment (new)

Link ¶

Initiates a deployment to deploy the latest monitor of the specified signal map.

See also: AWS API Documentation

Request Syntax

client.start_monitor_deployment(
    DryRun=True|False,
    Identifier='string'
)

type DryRun:

boolean

param DryRun:

Placeholder documentation for __boolean

type Identifier:

string

param Identifier:

[REQUIRED] A signal map's identifier. Can be either be its id or current name.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'CloudWatchAlarmTemplateGroupIds': [
        'string',
    ],
    'CreatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'DiscoveryEntryPointArn': 'string',
    'ErrorMessage': 'string',
    'EventBridgeRuleTemplateGroupIds': [
        'string',
    ],
    'FailedMediaResourceMap': {
        'string': {
            'Destinations': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ],
            'Name': 'string',
            'Sources': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ]
        }
    },
    'Id': 'string',
    'LastDiscoveredAt': datetime(2015, 1, 1),
    'LastSuccessfulMonitorDeployment': {
        'DetailsUri': 'string',
        'Status': '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'
    },
    'MediaResourceMap': {
        'string': {
            'Destinations': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ],
            'Name': 'string',
            'Sources': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ]
        }
    },
    'ModifiedAt': datetime(2015, 1, 1),
    'MonitorChangesPendingDeployment': True|False,
    'MonitorDeployment': {
        'DetailsUri': 'string',
        'ErrorMessage': 'string',
        'Status': '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) -- StartMonitorDeployment 202 response
- Arn (string) -- A signal map's ARN (Amazon Resource Name)
- CloudWatchAlarmTemplateGroupIds (list) -- Placeholder documentation for __listOf__stringMin7Max11PatternAws097
  - (string) -- Placeholder documentation for __stringMin7Max11PatternAws097
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Description (string) -- A resource's optional description.
- DiscoveryEntryPointArn (string) -- A top-level supported AWS resource ARN to discovery a signal map from.
- ErrorMessage (string) -- Error message associated with a failed creation or failed update attempt of a signal map.
- EventBridgeRuleTemplateGroupIds (list) -- Placeholder documentation for __listOf__stringMin7Max11PatternAws097
  - (string) -- Placeholder documentation for __stringMin7Max11PatternAws097
- FailedMediaResourceMap (dict) -- A map representing an incomplete AWS media workflow as a graph.
  - (string) -- Placeholder documentation for __string
    - (dict) -- An AWS resource used in media workflows.
      - Destinations (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
      - Name (string) -- The logical name of an AWS media resource.
      - Sources (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
- Id (string) -- A signal map's id.
- LastDiscoveredAt (datetime) -- Placeholder documentation for __timestampIso8601
- LastSuccessfulMonitorDeployment (dict) -- Represents the latest successful monitor deployment of a signal map.
  - DetailsUri (string) -- URI associated with a signal map's monitor deployment.
  - Status (string) -- A signal map's monitor deployment status.
- MediaResourceMap (dict) -- A map representing an AWS media workflow as a graph.
  - (string) -- Placeholder documentation for __string
    - (dict) -- An AWS resource used in media workflows.
      - Destinations (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
      - Name (string) -- The logical name of an AWS media resource.
      - Sources (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- MonitorChangesPendingDeployment (boolean) -- If true, there are pending monitor changes for this signal map that can be deployed.
- MonitorDeployment (dict) -- Represents the latest monitor deployment of a signal map.
  - DetailsUri (string) -- URI associated with a signal map's monitor deployment.
  - ErrorMessage (string) -- Error message associated with a failed monitor deployment of a signal map.
  - Status (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

DeleteEventBridgeRuleTemplate (new)

Link ¶

Deletes an eventbridge rule template.

See also: AWS API Documentation

Request Syntax

client.delete_event_bridge_rule_template(
    Identifier='string'
)

type Identifier:: string
param Identifier:: [REQUIRED] An eventbridge rule template's identifier. Can be either be its id or current name.
returns:: None

StartDeleteMonitorDeployment (new)

Link ¶

Initiates a deployment to delete the monitor of the specified signal map.

See also: AWS API Documentation

Request Syntax

client.start_delete_monitor_deployment(
    Identifier='string'
)

type Identifier:

string

param Identifier:

[REQUIRED] A signal map's identifier. Can be either be its id or current name.

rtype:

dict

returns:

Response Syntax

{
    'Arn': 'string',
    'CloudWatchAlarmTemplateGroupIds': [
        'string',
    ],
    'CreatedAt': datetime(2015, 1, 1),
    'Description': 'string',
    'DiscoveryEntryPointArn': 'string',
    'ErrorMessage': 'string',
    'EventBridgeRuleTemplateGroupIds': [
        'string',
    ],
    'FailedMediaResourceMap': {
        'string': {
            'Destinations': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ],
            'Name': 'string',
            'Sources': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ]
        }
    },
    'Id': 'string',
    'LastDiscoveredAt': datetime(2015, 1, 1),
    'LastSuccessfulMonitorDeployment': {
        'DetailsUri': 'string',
        'Status': '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'
    },
    'MediaResourceMap': {
        'string': {
            'Destinations': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ],
            'Name': 'string',
            'Sources': [
                {
                    'Arn': 'string',
                    'Name': 'string'
                },
            ]
        }
    },
    'ModifiedAt': datetime(2015, 1, 1),
    'MonitorChangesPendingDeployment': True|False,
    'MonitorDeployment': {
        'DetailsUri': 'string',
        'ErrorMessage': 'string',
        'Status': '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) -- StartDeleteMonitorDeployment 202 response
- Arn (string) -- A signal map's ARN (Amazon Resource Name)
- CloudWatchAlarmTemplateGroupIds (list) -- Placeholder documentation for __listOf__stringMin7Max11PatternAws097
  - (string) -- Placeholder documentation for __stringMin7Max11PatternAws097
- CreatedAt (datetime) -- Placeholder documentation for __timestampIso8601
- Description (string) -- A resource's optional description.
- DiscoveryEntryPointArn (string) -- A top-level supported AWS resource ARN to discovery a signal map from.
- ErrorMessage (string) -- Error message associated with a failed creation or failed update attempt of a signal map.
- EventBridgeRuleTemplateGroupIds (list) -- Placeholder documentation for __listOf__stringMin7Max11PatternAws097
  - (string) -- Placeholder documentation for __stringMin7Max11PatternAws097
- FailedMediaResourceMap (dict) -- A map representing an incomplete AWS media workflow as a graph.
  - (string) -- Placeholder documentation for __string
    - (dict) -- An AWS resource used in media workflows.
      - Destinations (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
      - Name (string) -- The logical name of an AWS media resource.
      - Sources (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
- Id (string) -- A signal map's id.
- LastDiscoveredAt (datetime) -- Placeholder documentation for __timestampIso8601
- LastSuccessfulMonitorDeployment (dict) -- Represents the latest successful monitor deployment of a signal map.
  - DetailsUri (string) -- URI associated with a signal map's monitor deployment.
  - Status (string) -- A signal map's monitor deployment status.
- MediaResourceMap (dict) -- A map representing an AWS media workflow as a graph.
  - (string) -- Placeholder documentation for __string
    - (dict) -- An AWS resource used in media workflows.
      - Destinations (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
      - Name (string) -- The logical name of an AWS media resource.
      - Sources (list) -- Placeholder documentation for __listOfMediaResourceNeighbor
        
        (dict) -- A direct source or destination neighbor to an AWS media resource.
        
        Arn (string) -- The ARN of a resource used in AWS media workflows.
        
        Name (string) -- The logical name of an AWS media resource.
- ModifiedAt (datetime) -- Placeholder documentation for __timestampIso8601
- MonitorChangesPendingDeployment (boolean) -- If true, there are pending monitor changes for this signal map that can be deployed.
- MonitorDeployment (dict) -- Represents the latest monitor deployment of a signal map.
  - DetailsUri (string) -- URI associated with a signal map's monitor deployment.
  - ErrorMessage (string) -- Error message associated with a failed monitor deployment of a signal map.
  - Status (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