MediaLive / Client / start_update_signal_map

start_update_signal_map#

MediaLive.Client.start_update_signal_map(**kwargs)#

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

Request Syntax

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

Parameters:

CloudWatchAlarmTemplateGroupIdentifiers (list) –
Placeholder documentation for __listOf__stringPatternS
- (string) – Placeholder documentation for __stringPatternS
Description (string) – A resource’s optional description.
DiscoveryEntryPointArn (string) – A top-level supported AWS resource ARN to discovery a signal map from.
EventBridgeRuleTemplateGroupIdentifiers (list) –
Placeholder documentation for __listOf__stringPatternS
- (string) – Placeholder documentation for __stringPatternS
ForceRediscovery (boolean) – If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided.
Identifier (string) – [REQUIRED] A signal map’s identifier. Can be either be its id or current name.
Name (string) – A resource’s name. Names must be unique within the scope of a resource type in a specific region.

Return type:

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

Exceptions

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