

# Workflow monitor: Signal map monitor deployment


## URI


`/prod/signal-maps/identifier/monitor-deployment`

## HTTP methods


### DELETE


**Operation ID:** `StartDeleteMonitorDeployment`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 202 | StartDeleteMonitorDeploymentResponseContent | 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 | 

### OPTIONS


**Operation ID:** `CorsSignal_mapsIdentifierMonitor_deployment`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 200 | None | 200 response | 

### POST


**Operation ID:** `StartMonitorDeployment`


**Path parameters**  

| Name | Type | Required | Description | 
| --- |--- |--- |--- |
| identifier | String | True |  | 


**Responses**  

| Status code | Response model | Description | 
| --- |--- |--- |
| 202 | StartMonitorDeploymentResponseContent | 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


#### POST schema
POST

```
{
  "dryRun": boolean
}
```

### Response bodies


#### StartDeleteMonitorDeploymentResponseContent schema
StartDeleteMonitorDeploymentResponseContent

```
{
  "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
}
```

#### StartMonitorDeploymentResponseContent schema
StartMonitorDeploymentResponseContent

```
{
  "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
BadRequestExceptionResponseContent

```
{
  "message": "string"
}
```

#### ForbiddenExceptionResponseContent schema
ForbiddenExceptionResponseContent

```
{
  "message": "string"
}
```

#### NotFoundExceptionResponseContent schema
NotFoundExceptionResponseContent

```
{
  "message": "string"
}
```

#### ConflictExceptionResponseContent schema
ConflictExceptionResponseContent

```
{
  "message": "string"
}
```

#### TooManyRequestsExceptionResponseContent schema
TooManyRequestsExceptionResponseContent

```
{
  "message": "string"
}
```

#### InternalServerErrorExceptionResponseContent schema
InternalServerErrorExceptionResponseContent

```
{
  "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. | 

### 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](#signal-maps-identifier-monitor-deployment-model-mediaresourceneighbor) | False | A direct destination neighbor to an Amazon Web Services media resource. | 
| name | stringMinLength: 1MaxLength: 256 | False | The logical name of an Amazon Web Services media resource. | 
| sources | Array of type [MediaResourceNeighbor](#signal-maps-identifier-monitor-deployment-model-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 | stringPattern: `^arn.+$`MinLength: 1MaxLength: 2048 | True | The ARN of a resource used in Amazon Web Services media workflows. | 
| name | stringMinLength: 1MaxLength: 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 | stringMinLength: 1MaxLength: 2048 | False | URI associated with a signal map's monitor deployment. | 
| errorMessage | stringMinLength: 1MaxLength: 2048 | False | Error message associated with a failed monitor deployment of a signal map. | 
| status | [SignalMapMonitorDeploymentStatus](#signal-maps-identifier-monitor-deployment-model-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`

### StartDeleteMonitorDeploymentResponseContent



| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:signal-map:.+$` | True | A signal map's ARN (Amazon Resource Name) | 
| cloudWatchAlarmTemplateGroupIds | Array of type stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | False | An alarm template group's id. | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| discoveryEntryPointArn | stringMinLength: 1MaxLength: 2048 | True | A top-level supported Amazon Web Services resource ARN to discover a signal map from. | 
| errorMessage | stringMinLength: 1MaxLength: 2048 | False | Error message associated with a failed creation or failed update attempt of a signal map. | 
| eventBridgeRuleTemplateGroupIds | Array of type stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | False | An eventbridge rule template group's id. | 
| failedMediaResourceMap | [FailedMediaResourceMap](#signal-maps-identifier-monitor-deployment-model-failedmediaresourcemap) | False | A map representing an incomplete Amazon Web Services media workflow as a graph. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A signal map's id. | 
| lastDiscoveredAt | stringFormat: date-time | False | The date and time of latest discovery. | 
| lastSuccessfulMonitorDeployment | [SuccessfulMonitorDeployment](#signal-maps-identifier-monitor-deployment-model-successfulmonitordeployment) | False | The date and time of latest successful deployment. | 
| mediaResourceMap | [MediaResourceMap](#signal-maps-identifier-monitor-deployment-model-mediaresourcemap) | False | A map representing an Amazon Web Services media workflow as a graph. | 
| modifiedAt | stringFormat: 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](#signal-maps-identifier-monitor-deployment-model-monitordeployment) | False | Represents the latest monitor deployment of a signal map. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 
| status | [SignalMapStatus](#signal-maps-identifier-monitor-deployment-model-signalmapstatus) | True | A signal map's current status, which is dependent on its lifecycle actions or associated jobs. | 

### StartMonitorDeploymentRequestContent



| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| dryRun | boolean | False |  | 

### StartMonitorDeploymentResponseContent



| Property | Type | Required | Description | 
| --- |--- |--- |--- |
| arn | stringPattern: `^arn:.+:medialive:.+:signal-map:.+$` | True | A signal map's ARN (Amazon Resource Name) | 
| cloudWatchAlarmTemplateGroupIds | Array of type stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | False | An alarm template group's id. | 
| createdAt | stringFormat: date-time | True | The date and time of resource creation. | 
| description | stringMinLength: 0MaxLength: 1024 | False | A resource's optional description. | 
| discoveryEntryPointArn | stringMinLength: 1MaxLength: 2048 | True | A top-level supported Amazon Web Services resource ARN to discover a signal map from. | 
| errorMessage | stringMinLength: 1MaxLength: 2048 | False | Error message associated with a failed creation or failed update attempt of a signal map. | 
| eventBridgeRuleTemplateGroupIds | Array of type stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | False | An eventbridge rule template group's id. | 
| failedMediaResourceMap | [FailedMediaResourceMap](#signal-maps-identifier-monitor-deployment-model-failedmediaresourcemap) | False | A map representing an incomplete Amazon Web Services media workflow as a graph. | 
| id | stringPattern: `^(aws-)?[0-9]{7}$`MinLength: 7MaxLength: 11 | True | A signal map's id. | 
| lastDiscoveredAt | stringFormat: date-time | False | The date and time of latest discovery. | 
| lastSuccessfulMonitorDeployment | [SuccessfulMonitorDeployment](#signal-maps-identifier-monitor-deployment-model-successfulmonitordeployment) | False | The date and time of latest successful deployment. | 
| mediaResourceMap | [MediaResourceMap](#signal-maps-identifier-monitor-deployment-model-mediaresourcemap) | False | A map representing an Amazon Web Services media workflow as a graph. | 
| modifiedAt | stringFormat: 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](#signal-maps-identifier-monitor-deployment-model-monitordeployment) | False | Represents the latest monitor deployment of a signal map. | 
| name | stringPattern: `^[^\s]+$`MinLength: 1MaxLength: 255 | True | A resource's name. Names must be unique within the scope of a resource type in a specific region. | 
| status | [SignalMapStatus](#signal-maps-identifier-monitor-deployment-model-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 | stringMinLength: 1MaxLength: 2048 | True | URI associated with a signal map's monitor deployment. | 
| status | [SignalMapMonitorDeploymentStatus](#signal-maps-identifier-monitor-deployment-model-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:

### StartDeleteMonitorDeployment

+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/StartDeleteMonitorDeployment)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/StartDeleteMonitorDeployment)

### CorsSignal\$1mapsIdentifierMonitor\$1deployment

+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/CorsSignal_mapsIdentifierMonitor_deployment)

### StartMonitorDeployment

+ [AWS Command Line Interface V2](/goto/cli2/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for .NET V4](/goto/DotNetSDKV4/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for C\$1\$1](/goto/SdkForCpp/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for Go v2](/goto/SdkForGoV2/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for Java V2](/goto/SdkForJavaV2/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for JavaScript V3](/goto/SdkForJavaScriptV3/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for Kotlin](/goto/SdkForKotlin/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for PHP V3](/goto/SdkForPHPV3/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for Python](/goto/boto3/medialive-2017-10-14/StartMonitorDeployment)
+ [AWS SDK for Ruby V3](/goto/SdkForRubyV3/medialive-2017-10-14/StartMonitorDeployment)