Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListTagsForResource

Returns a list of tags that are applied to the specified AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise servers or backups.

Request Syntax


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

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call ListTagsForResource again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: No

ResourceArn

The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server for which you want to show applied tags. For example, arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

Type: String

Pattern: arn:aws.*:opsworks-cm:.*:[0-9]{12}:.*

Required: Yes

Response Syntax


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

NextToken

A token that you can use as the value of NextToken in subsequent calls to the API to show more results.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Tags

Tags that have been applied to the resource.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Errors

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

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 400

ValidationException

One or more of the provided request parameters are not valid.

HTTP Status Code: 400