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

GetAttributeGroup

Retrieves an attribute group by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name.

Request Syntax


GET /attribute-groups/attributeGroup HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

attributeGroup

The name, ID, or ARN of the attribute group that holds the attributes to describe the application.

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

Pattern: ([-.\w]+)|(arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[-.\w]+)

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "attributes": "string",
   "createdBy": "string",
   "creationTime": "string",
   "description": "string",
   "id": "string",
   "lastUpdateTime": "string",
   "name": "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.

arn

The Amazon resource name (ARN) that specifies the attribute group across services.

Type: String

Pattern: arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/attribute-groups/[-.\w]+

attributes

A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.

Type: String

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

Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

createdBy

The service principal that created the attribute group.

Type: String

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

Pattern: ^(?!-)([a-z0-9-]+\.)+(aws\.internal|amazonaws\.com(\.cn)?)$

creationTime

The ISO-8601 formatted timestamp of the moment the attribute group was created.

Type: Timestamp

description

The description of the attribute group that the user provides.

Type: String

Length Constraints: Maximum length of 1024.

id

The identifier of the attribute group.

Type: String

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

Pattern: [-.\w]+

lastUpdateTime

The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.

Type: Timestamp

name

The name of the attribute group.

Type: String

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

Pattern: [-.\w]+

tags

Key-value pairs associated with the attribute group.

Type: String to string map

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

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

Key Pattern: [a-zA-Z+-=._:/]+

Value Length Constraints: Maximum length of 256.

Value Pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]*

Errors

ConflictException

There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

HTTP Status Code: 409

InternalServerException

The service is experiencing internal problems.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400