CreateOpsMetadata - Amazon Systems Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

CreateOpsMetadata

If you create a new application in Application Manager, Amazon Systems Manager calls this API operation to specify information about the new application, including the application type.

Request Syntax

{ "Metadata": { "string" : { "Value": "string" } }, "ResourceId": "string", "Tags": [ { "Key": "string", "Value": "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.

Metadata

Metadata for a new Application Manager application.

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

ResourceId

A resource ID for a new Application Manager application.

Type: String

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

Pattern: ^(?!\s*$).+

Required: Yes

Tags

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an OpsMetadata object. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an OpsMetadata object to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs:

  • Key=Environment,Value=Production

  • Key=Region,Value=us-east-2

Type: Array of Tag objects

Array Members: Maximum number of 1000 items.

Required: No

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 or blob created by the call.

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

OpsMetadataAlreadyExistsException

An OpsMetadata object already exists for the selected resource.

HTTP Status Code: 400

OpsMetadataInvalidArgumentException

One of the arguments passed is invalid.

HTTP Status Code: 400

OpsMetadataLimitExceededException

Your account reached the maximum number of OpsMetadata objects allowed by Application Manager. The maximum is 200 OpsMetadata objects. Delete one or more OpsMetadata object and try again.

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 Amazon SDKs, see the following: