CreateUserProfileCommand

Creates a user profile in Amazon DataZone.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DataZoneClient, CreateUserProfileCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, CreateUserProfileCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // CreateUserProfileInput
  domainIdentifier: "STRING_VALUE", // required
  userIdentifier: "STRING_VALUE", // required
  userType: "IAM_USER" || "IAM_ROLE" || "SSO_USER",
  clientToken: "STRING_VALUE",
};
const command = new CreateUserProfileCommand(input);
const response = await client.send(command);
// { // CreateUserProfileOutput
//   domainId: "STRING_VALUE",
//   id: "STRING_VALUE",
//   type: "IAM" || "SSO",
//   status: "ASSIGNED" || "NOT_ASSIGNED" || "ACTIVATED" || "DEACTIVATED",
//   details: { // UserProfileDetails Union: only one key present
//     iam: { // IamUserProfileDetails
//       arn: "STRING_VALUE",
//     },
//     sso: { // SsoUserProfileDetails
//       username: "STRING_VALUE",
//       firstName: "STRING_VALUE",
//       lastName: "STRING_VALUE",
//     },
//   },
// };

CreateUserProfileCommand Input

See CreateUserProfileCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

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

userIdentifier
Required
string | undefined

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

clientToken
string | undefined

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

userType
UserType | undefined

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

CreateUserProfileCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
details
UserProfileDetails | undefined

The details of the user profile in Amazon DataZone.

domainId
string | undefined

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

id
string | undefined

The identifier of the user profile.

status
UserProfileStatus | undefined

The status of the user profile.

type
UserProfileType | undefined

The type of the user profile.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

InternalServerException
server

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

ResourceNotFoundException
client

The specified resource cannot be found.

ValidationException
client

The input fails to satisfy the constraints specified by the Amazon Web Services service.

ThrottlingException
client

The request was denied due to request throttling.

UnauthorizedException
client

You do not have permission to perform this action.

DataZoneServiceException
Base exception class for all service exceptions from DataZone service.