Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateMonitor

Update a monitor to add or remove local or remote resources.

Request Syntax


PATCH /monitors/monitorName HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "localResourcesToAdd": [ 
      { 
         "identifier": "string",
         "type": "string"
      }
   ],
   "localResourcesToRemove": [ 
      { 
         "identifier": "string",
         "type": "string"
      }
   ],
   "remoteResourcesToAdd": [ 
      { 
         "identifier": "string",
         "type": "string"
      }
   ],
   "remoteResourcesToRemove": [ 
      { 
         "identifier": "string",
         "type": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

monitorName

The name of the monitor.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: No

localResourcesToAdd

The local resources to add, as an array of resources with identifiers and types.

Type: Array of MonitorLocalResource objects

Required: No

localResourcesToRemove

The local resources to remove, as an array of resources with identifiers and types.

Type: Array of MonitorLocalResource objects

Required: No

remoteResourcesToAdd

The remove resources to add, as an array of resources with identifiers and types.

Type: Array of MonitorRemoteResource objects

Required: No

remoteResourcesToRemove

The remove resources to remove, as an array of resources with identifiers and types.

Type: Array of MonitorRemoteResource objects

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": number,
   "localResources": [ 
      { 
         "identifier": "string",
         "type": "string"
      }
   ],
   "modifiedAt": number,
   "monitorArn": "string",
   "monitorName": "string",
   "monitorStatus": "string",
   "remoteResources": [ 
      { 
         "identifier": "string",
         "type": "string"
      }
   ],
   "tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

createdAt

The date and time when the monitor was created.

Type: Timestamp

localResources

The local resources updated for a monitor, as an array of resources with identifiers and types.

Type: Array of MonitorLocalResource objects

modifiedAt

The last date and time that the monitor was modified.

Type: Timestamp

monitorArn

The Amazon Resource Name (ARN) of the monitor.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 512.

Pattern: arn:.*

monitorName

The name of the monitor.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z0-9_.-]+

monitorStatus

The status of a monitor. The status can be one of the following

PENDING: The monitor is in the process of being created.
ACTIVE: The monitor is active.
INACTIVE: The monitor is inactive.
ERROR: Monitor creation failed due to an error.
DELETING: The monitor is in the process of being deleted.

Type: String

Valid Values: PENDING | ACTIVE | INACTIVE | ERROR | DELETING

remoteResources

The remote resources updated for a monitor, as an array of resources with identifiers and types.

Type: Array of MonitorRemoteResource objects

tags

The tags for a monitor.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient permission to perform this action.

HTTP Status Code: 403

InternalServerException

An internal error occurred.

HTTP Status Code: 500

ResourceNotFoundException

The request specifies a resource that doesn't exist.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

Invalid request.

HTTP Status Code: 400