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

CreateUserProfile

Creates a user profile in Amazon DataZone.

Request Syntax


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

{
   "clientToken": "string",
   "userIdentifier": "string",
   "userType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The identifier of the Amazon DataZone domain in which a user 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

userIdentifier

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

Type: String

Pattern: (^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$|^[a-zA-Z_0-9+=,.@-]+$|^arn:aws:iam::\d{12}:.+$)

Required: Yes

userType

The user type of the user for which the user profile is created.

Type: String

Valid Values: IAM_USER | IAM_ROLE | SSO_USER

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

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

details

The details of the user profile in Amazon DataZone.

Type: UserProfileDetails object

Note: This object is a Union. Only one member of this object can be specified or returned.

domainId

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

Type: String

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

id

The identifier of the user profile.

Type: String

Pattern: ^([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$

status

The status of the user profile.

Type: String

Valid Values: ASSIGNED | NOT_ASSIGNED | ACTIVATED | DEACTIVATED

type

The type of the user profile.

Type: String

Valid Values: IAM | SSO

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