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

CreateAttributeGroup

Creates a new attribute group as a container for user-defined attributes. This feature enables users to have full control over their cloud application's metadata in a rich machine-readable format to facilitate integration with automated workflows and third-party tools.

Request Syntax


POST /attribute-groups HTTP/1.1
Content-type: application/json

{
   "attributes": "string",
   "clientToken": "string",
   "description": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

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]+

Required: Yes

clientToken

A unique identifier that you provide to ensure idempotency. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails.

Type: String

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

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: Yes

description

The description of the attribute group that the user provides.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

name

The name of the attribute group.

Type: String

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

Pattern: [-.\w]+

Required: Yes

tags

Key-value pairs you can use to associate 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: ^([\p{L}\p{Z}\p{N}_.:\/=+\-@]*)$

Value Length Constraints: Maximum length of 256.

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

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "attributeGroup": { 
      "arn": "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 201 response.

The following data is returned in JSON format by the service.

attributeGroup

Information about the attribute group.

Type: AttributeGroup object

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

ServiceQuotaExceededException

The maximum number of resources per account has been reached.

HTTP Status Code: 402

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400