Workflow monitor: Signal maps
URI
/prod/signal-maps
HTTP methods
GET
Operation ID: ListSignalMaps
Query parameters | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
eventBridgeRuleTemplateGroupIdentifier | String | False | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextToken | String | False | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cloudWatchAlarmTemplateGroupIdentifier | String | False | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxResults | String | False |
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | ListSignalMapsResponseContent | 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_maps
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
200 | None | 200 response |
POST
Operation ID: CreateSignalMap
Responses | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Status code | Response model | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
201 | CreateSignalMapResponseContent | 201 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
{ "cloudWatchAlarmTemplateGroupIdentifiers": [ "string" ], "description": "string", "discoveryEntryPointArn": "string", "eventBridgeRuleTemplateGroupIdentifiers": [ "string" ], "name": "string" }
Response bodies
{ "nextToken": "string", "signalMaps": [ { "arn": "string", "createdAt": "string", "description": "string", "id": "string", "modifiedAt": "string", "monitorDeploymentStatus": enum, "name": "string", "status": enum } ] }
{ "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 }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "message": "string" }
{ "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. |
CreateSignalMapRequestContent
Property | Type | Required | Description |
---|---|---|---|
cloudWatchAlarmTemplateGroupIdentifiers | Array of type string Pattern: | 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 | True | A top-level supported Amazon Web Services resource ARN to discover a signal map from. |
eventBridgeRuleTemplateGroupIdentifiers | Array of type string Pattern: | False | An eventbridge rule template group's identifier. Can be either be its id or current name. |
name | string Pattern: MinLength: 1 MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. |
CreateSignalMapResponseContent
Property | Type | Required | Description |
---|---|---|---|
arn | string Pattern: | True | A signal map's ARN (Amazon Resource Name) |
cloudWatchAlarmTemplateGroupIds | Array of type string Pattern: 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: MinLength: 7 MaxLength: 11 | False | An eventbridge rule template group's id. Amazon Web Services provided template groups have ids that start with `aws-`. |
failedMediaResourceMap | False | A map representing an incomplete Amazon Web Services media workflow as a graph. | |
id | string Pattern: MinLength: 7 MaxLength: 11 | True | A signal map's id. |
lastDiscoveredAt | string Format: date-time | False | The date and time of latest discovery. |
lastSuccessfulMonitorDeployment | False | The date and time of latest successful deployment. | |
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 | False | Represents the latest monitor deployment of a signal map. | |
name | string Pattern: 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 | True | A signal map's current status, which is dependent on its lifecycle actions or associated jobs. |
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. |
InternalServerErrorExceptionResponseContent
Unexpected error during processing of request.
Property | Type | Required | Description |
---|---|---|---|
message | string | False | Exception error message. |
ListSignalMapsResponseContent
Property | Type | Required | Description |
---|---|---|---|
nextToken | string MinLength: 1 MaxLength: 2048 | False | A token used to retrieve the next set of results in paginated list responses. |
signalMaps | Array of type SignalMapSummary | True | Details of the signal map |
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: 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 | 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
SignalMapSummary
Details of the signal map
Property | Type | Required | Description |
---|---|---|---|
arn | string Pattern: | True | A signal map's ARN (Amazon Resource Name) |
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. |
id | string Pattern: MinLength: 7 MaxLength: 11 | True | A signal map's id. |
modifiedAt | string Format: date-time | False | The date and time of latest resource modification. |
monitorDeploymentStatus | True | A signal map's monitor deployment status. | |
name | string Pattern: 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 | 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 | 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: