UpdateOpsMetadata
AWS Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
Request Syntax
{
"KeysToDelete": [ "string" ],
"MetadataToUpdate": {
"string" : {
"Value": "string"
}
},
"OpsMetadataArn": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- KeysToDelete
-
The metadata keys to delete from the OpsMetadata object.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^(?!\s*$).+Required: No
- MetadataToUpdate
-
Metadata to add to an OpsMetadata object.
Type: String to MetadataValue object map
Map Entries: Maximum number of 5 items.
Key Length Constraints: Minimum length of 1. Maximum length of 256.
Key Pattern:
^(?!\s*$).+Required: No
- OpsMetadataArn
-
The Amazon Resource Name (ARN) of the OpsMetadata Object to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern:
arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:opsmetadata\/([a-zA-Z0-9-_\.\/]*)Required: Yes
Response Syntax
{
"OpsMetadataArn": "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.
- OpsMetadataArn
-
The Amazon Resource Name (ARN) of the OpsMetadata Object that was updated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1011.
Pattern:
arn:(aws[a-zA-Z-]*)?:ssm:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:opsmetadata\/([a-zA-Z0-9-_\.\/]*)
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
- OpsMetadataInvalidArgumentException
-
One of the arguments passed is invalid.
HTTP Status Code: 400
- OpsMetadataKeyLimitExceededException
-
The OpsMetadata object exceeds the maximum number of OpsMetadata keys that you can assign to an application in Application Manager.
HTTP Status Code: 400
- OpsMetadataNotFoundException
-
The OpsMetadata object doesn't exist.
HTTP Status Code: 400
- OpsMetadataTooManyUpdatesException
-
The system is processing too many concurrent updates. Wait a few moments and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
