Workflow monitor: Signal maps ID

URI

/prod/signal-maps/identifier

HTTP methods

DELETE

Operation ID: DeleteSignalMap

Path parameters

Name	Type	Required	Description
identifier	String	True

Responses

Status code	Response model	Description
204	None	204 response
400	BadRequestExceptionResponseContent	400 response
403	ForbiddenExceptionResponseContent	403 response
404	NotFoundExceptionResponseContent	404 response
409	ConflictExceptionResponseContent	409 response
429	TooManyRequestsExceptionResponseContent	429 response
500	InternalServerErrorExceptionResponseContent	500 response

GET

Operation ID: GetSignalMap

Path parameters

Name	Type	Required	Description
identifier	String	True

Responses

Status code	Response model	Description
200	GetSignalMapResponseContent	200 response
400	BadRequestExceptionResponseContent	400 response
403	ForbiddenExceptionResponseContent	403 response
404	NotFoundExceptionResponseContent	404 response
429	TooManyRequestsExceptionResponseContent	429 response
500	InternalServerErrorExceptionResponseContent	500 response

OPTIONS

Operation ID: CorsSignal_mapsIdentifier

Path parameters

Name	Type	Required	Description
identifier	String	True

Responses

Status code	Response model	Description
200	None	200 response

PATCH

Operation ID: StartUpdateSignalMap

Path parameters

Name	Type	Required	Description
identifier	String	True

Responses

Status code	Response model	Description
202	StartUpdateSignalMapResponseContent	202 response
400	BadRequestExceptionResponseContent	400 response
403	ForbiddenExceptionResponseContent	403 response
404	NotFoundExceptionResponseContent	404 response
409	ConflictExceptionResponseContent	409 response
429	TooManyRequestsExceptionResponseContent	429 response
500	InternalServerErrorExceptionResponseContent	500 response

Schemas

Request bodies

PATCH schema

{
  "cloudWatchAlarmTemplateGroupIdentifiers": [
    "string"
  ],
  "description": "string",
  "discoveryEntryPointArn": "string",
  "eventBridgeRuleTemplateGroupIdentifiers": [
    "string"
  ],
  "forceRediscovery": boolean,
  "name": "string"
}

Response bodies

GetSignalMapResponseContent schema

{
  "arn": "string",
  "cloudWatchAlarmTemplateGroupIds": [
    "string"
  ],
  "createdAt": "string",
  "description": "string",
  "discoveryEntryPointArn": "string",
  "errorMessage": "string",
  "eventBridgeRuleTemplateGroupIds": [
    "string"
  ],
  "failedMediaResourceMap": {
  },
  "id": "string",
  "lastDiscoveredAt": "string",
  "lastSuccessfulMonitorDeployment": {
    "detailsUri": "string",
    "status": enum
  },
  "mediaResourceMap": {
  },
  "modifiedAt": "string",
  "monitorChangesPendingDeployment": boolean,
  "monitorDeployment": {
    "detailsUri": "string",
    "errorMessage": "string",
    "status": enum
  },
  "name": "string",
  "status": enum
}

StartUpdateSignalMapResponseContent schema

{
  "arn": "string",
  "cloudWatchAlarmTemplateGroupIds": [
    "string"
  ],
  "createdAt": "string",
  "description": "string",
  "discoveryEntryPointArn": "string",
  "errorMessage": "string",
  "eventBridgeRuleTemplateGroupIds": [
    "string"
  ],
  "failedMediaResourceMap": {
  },
  "id": "string",
  "lastDiscoveredAt": "string",
  "lastSuccessfulMonitorDeployment": {
    "detailsUri": "string",
    "status": enum
  },
  "mediaResourceMap": {
  },
  "modifiedAt": "string",
  "monitorChangesPendingDeployment": boolean,
  "monitorDeployment": {
    "detailsUri": "string",
    "errorMessage": "string",
    "status": enum
  },
  "name": "string",
  "status": enum
}

BadRequestExceptionResponseContent schema

{
  "message": "string"
}

ForbiddenExceptionResponseContent schema

{
  "message": "string"
}

NotFoundExceptionResponseContent schema

{
  "message": "string"
}

ConflictExceptionResponseContent schema

{
  "message": "string"
}

TooManyRequestsExceptionResponseContent schema

{
  "message": "string"
}

InternalServerErrorExceptionResponseContent schema

{
  "message": "string"
}

Properties

BadRequestExceptionResponseContent

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Property	Type	Required	Description
message	string	False	Exception error message.

ConflictExceptionResponseContent

Updating or deleting a resource can cause an inconsistent state.

Property	Type	Required	Description
message	string	False	Exception error message.

FailedMediaResourceMap

A map representing an incomplete Amazon Web Services media workflow as a graph.

Property	Type	Required	Description
*	object	False

ForbiddenExceptionResponseContent

User does not have sufficient access to perform this action.

Property	Type	Required	Description
message	string	False	Exception error message.

GetSignalMapResponseContent

Property	Type	Required	Description
arn	string Pattern: ^arn:.+:medialive:.+:signal-map:.+$	True	A signal map's ARN (Amazon Resource Name)
cloudWatchAlarmTemplateGroupIds	Array of type string Pattern: ^(aws-)?[0-9]{7}$ MinLength: 7 MaxLength: 11	False	An alarm template group's id.
createdAt	string Format: date-time	True	The date and time of resource creation.
description	string MinLength: 0 MaxLength: 1024	False	A resource's optional description.
discoveryEntryPointArn	string MinLength: 1 MaxLength: 2048	True	A top-level supported Amazon Web Services resource ARN to discover a signal map from.
errorMessage	string MinLength: 1 MaxLength: 2048	False	Error message associated with a failed creation or failed update attempt of a signal map.
eventBridgeRuleTemplateGroupIds	Array of type string Pattern: ^(aws-)?[0-9]{7}$ MinLength: 7 MaxLength: 11	False	An eventbridge rule template group's id.
failedMediaResourceMap	FailedMediaResourceMap	False	A map representing an incomplete Amazon Web Services media workflow as a graph.
id	string Pattern: ^(aws-)?[0-9]{7}$ MinLength: 7 MaxLength: 11	True	A signal map's id.
lastDiscoveredAt	string Format: date-time	False	The date and time of latest discovery.
lastSuccessfulMonitorDeployment	SuccessfulMonitorDeployment	False	The date and time of latest successful deployment.
mediaResourceMap	MediaResourceMap	False	A map representing an Amazon Web Services media workflow as a graph.
modifiedAt	string Format: date-time	False	The date and time of latest resource modification.
monitorChangesPendingDeployment	boolean	True	If true, there are pending monitor changes for this signal map that can be deployed.
monitorDeployment	MonitorDeployment	False	Represents the latest monitor deployment of a signal map.
name	string Pattern: ^[^\s]+$ MinLength: 1 MaxLength: 255	True	A resource's name. Names must be unique within the scope of a resource type in a specific region.
status	SignalMapStatus	True	A signal map's current status, which is dependent on its lifecycle actions or associated jobs.

InternalServerErrorExceptionResponseContent

Unexpected error during processing of request.

Property	Type	Required	Description
message	string	False	Exception error message.

MediaResource

An Amazon Web Services resource used in media workflows.

Property	Type	Required	Description
destinations	Array of type MediaResourceNeighbor	False	A direct destination neighbor to an Amazon Web Services media resource.
name	string MinLength: 1 MaxLength: 256	False	The logical name of an Amazon Web Services media resource.
sources	Array of type MediaResourceNeighbor	False	A direct source neighbor to an Amazon Web Services media resource.

MediaResourceMap

A map representing an Amazon Web Services media workflow as a graph.

Property	Type	Required	Description
*	object	False

MediaResourceNeighbor

A direct source or destination neighbor to an Amazon Web Services media resource.

Property	Type	Required	Description
arn	string Pattern: ^arn.+$ MinLength: 1 MaxLength: 2048	True	The ARN of a resource used in Amazon Web Services media workflows.
name	string MinLength: 1 MaxLength: 256	False	The logical name of an Amazon Web Services media resource.

MonitorDeployment

Represents the latest monitor deployment of a signal map.

Property	Type	Required	Description
detailsUri	string MinLength: 1 MaxLength: 2048	False	URI associated with a signal map's monitor deployment.
errorMessage	string MinLength: 1 MaxLength: 2048	False	Error message associated with a failed monitor deployment of a signal map.
status	SignalMapMonitorDeploymentStatus	True	The signal map monitor deployment status.

NotFoundExceptionResponseContent

Request references a resource which does not exist.

Property	Type	Required	Description
message	string	False	Exception error message.

SignalMapMonitorDeploymentStatus

A signal map's monitor deployment 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

SignalMapStatus

A signal map's current status which is dependent on its lifecycle actions or associated jobs.

• CREATE_IN_PROGRESS

• CREATE_COMPLETE

• CREATE_FAILED

• UPDATE_IN_PROGRESS

• UPDATE_COMPLETE

• UPDATE_REVERTED

• UPDATE_FAILED

• READY

• NOT_READY

StartUpdateSignalMapRequestContent

Property	Type	Required	Description
cloudWatchAlarmTemplateGroupIdentifiers	Array of type string Pattern: ^[^\s]+$	False	A cloudwatch alarm template group's identifier. Can be either be its id or current name.
description	string MinLength: 0 MaxLength: 1024	False	A resource's optional description.
discoveryEntryPointArn	string MinLength: 1 MaxLength: 2048	False	A top-level supported Amazon Web Services resource ARN to discover a signal map from.
eventBridgeRuleTemplateGroupIdentifiers	Array of type string Pattern: ^[^\s]+$	False	An eventbridge rule template group's identifier. Can be either be its id or current name.
forceRediscovery	boolean	False	If true, will force a rediscovery of a signal map if an unchanged discoveryEntryPointArn is provided.
name	string Pattern: ^[^\s]+$ MinLength: 1 MaxLength: 255	False	A resource's name. Names must be unique within the scope of a resource type in a specific region.

StartUpdateSignalMapResponseContent

Property	Type	Required	Description
arn	string Pattern: ^arn:.+:medialive:.+:signal-map:.+$	True	A signal map's ARN (Amazon Resource Name)
cloudWatchAlarmTemplateGroupIds	Array of type string Pattern: ^(aws-)?[0-9]{7}$ MinLength: 7 MaxLength: 11	False	An alarm template group's id.
createdAt	string Format: date-time	True	The date and time of resource creation.
description	string MinLength: 0 MaxLength: 1024	False	A resource's optional description.
discoveryEntryPointArn	string MinLength: 1 MaxLength: 2048	True	A top-level supported Amazon Web Services resource ARN to discover a signal map from.
errorMessage	string MinLength: 1 MaxLength: 2048	False	Error message associated with a failed creation or failed update attempt of a signal map.
eventBridgeRuleTemplateGroupIds	Array of type string Pattern: ^(aws-)?[0-9]{7}$ MinLength: 7 MaxLength: 11	False	An eventbridge rule template group's id. Amazon Web Services provided template groups have ids that start with <code>`aws-`</code>.
failedMediaResourceMap	FailedMediaResourceMap	False	A map representing an incomplete Amazon Web Services media workflow as a graph.
id	string Pattern: ^(aws-)?[0-9]{7}$ MinLength: 7 MaxLength: 11	True	A signal map's id.
lastDiscoveredAt	string Format: date-time	False	The date and time of latest discovery.
lastSuccessfulMonitorDeployment	SuccessfulMonitorDeployment	False	The date and time of latest successful deployment.
mediaResourceMap	MediaResourceMap	False	A map representing an Amazon Web Services media workflow as a graph.
modifiedAt	string Format: date-time	False	The date and time of latest resource modification.
monitorChangesPendingDeployment	boolean	True	If true, there are pending monitor changes for this signal map that can be deployed.
monitorDeployment	MonitorDeployment	False	Represents the latest monitor deployment of a signal map.
name	string Pattern: ^[^\s]+$ MinLength: 1 MaxLength: 255	True	A resource's name. Names must be unique within the scope of a resource type in a specific region.
status	SignalMapStatus	True	A signal map's current status, which is dependent on its lifecycle actions or associated jobs.

SuccessfulMonitorDeployment

Represents the latest successful monitor deployment of a signal map.

Property	Type	Required	Description
detailsUri	string MinLength: 1 MaxLength: 2048	True	URI associated with a signal map's monitor deployment.
status	SignalMapMonitorDeploymentStatus	True	A signal map's monitor deployment status.

TooManyRequestsExceptionResponseContent

Request was denied due to request throttling.

Property	Type	Required	Description
message	string	False	Exception error message.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DeleteSignalMap

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

GetSignalMap

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

CorsSignal_mapsIdentifier

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

StartUpdateSignalMap

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3