GetOpsMetadata - AWS Systems Manager

GetOpsMetadata

View operational metadata related to an application in Application Manager.

Request Syntax

{ "MaxResults": number, "NextToken": "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.

MaxResults

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10.

Required: No

NextToken

A token to start the list. Use this token to get the next set of results.

Type: String

Required: No

OpsMetadataArn

The Amazon Resource Name (ARN) of an OpsMetadata Object to view.

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

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

Metadata

OpsMetadata for an 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*$).+

NextToken

The token for the next set of items to return. Use this token to get the next set of results.

Type: String

ResourceId

The resource ID of the Application Manager application.

Type: String

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

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

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

OpsMetadataNotFoundException

The OpsMetadata object does not exist.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: