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

CreateGroupProfile

Creates a group profile in Amazon DataZone.

Request Syntax


POST /v2/domains/domainIdentifier/group-profiles HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "groupIdentifier": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The identifier of the Amazon DataZone domain in which the group profile is created.

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

Type: String

Required: No

groupIdentifier

The identifier of the group for which the group profile is created.

Type: String

Pattern: (^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$|[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+)

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "domainId": "string",
   "groupName": "string",
   "id": "string",
   "status": "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.

domainId

The identifier of the Amazon DataZone domain in which the group profile is created.

Type: String

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

groupName

The name of the group for which group profile is created.

Type: String

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

Pattern: ^[a-zA-Z_0-9+=,.@-]+$

id

The identifier of the group profile.

Type: String

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

status

The status of the group profile.

Type: String

Valid Values: ASSIGNED | NOT_ASSIGNED

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400