CreateGroupProfileCommand

Creates a group profile in Amazon DataZone.

Example Syntax

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

import { DataZoneClient, CreateGroupProfileCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, CreateGroupProfileCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // CreateGroupProfileInput
  domainIdentifier: "STRING_VALUE", // required
  groupIdentifier: "STRING_VALUE", // required
  clientToken: "STRING_VALUE",
};
const command = new CreateGroupProfileCommand(input);
const response = await client.send(command);
// { // CreateGroupProfileOutput
//   domainId: "STRING_VALUE",
//   id: "STRING_VALUE",
//   status: "ASSIGNED" || "NOT_ASSIGNED",
//   groupName: "STRING_VALUE",
// };

CreateGroupProfileCommand Input

See CreateGroupProfileCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

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

groupIdentifier
Required
string | undefined

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

clientToken
string | undefined

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

CreateGroupProfileCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
domainId
string | undefined

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

groupName
string | undefined

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

id
string | undefined

The identifier of the group profile.

status
GroupProfileStatus | undefined

The status of the group 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.