GetGroupProfileCommand

Gets 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, GetGroupProfileCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, GetGroupProfileCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // GetGroupProfileInput
  domainIdentifier: "STRING_VALUE", // required
  groupIdentifier: "STRING_VALUE", // required
};
const command = new GetGroupProfileCommand(input);
const response = await client.send(command);
// { // GetGroupProfileOutput
//   domainId: "STRING_VALUE",
//   id: "STRING_VALUE",
//   status: "ASSIGNED" || "NOT_ASSIGNED",
//   groupName: "STRING_VALUE",
// };

GetGroupProfileCommand Input

See GetGroupProfileCommandInput for more details

Parameter
Type
Description
domainIdentifier
Required
string | undefined

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

groupIdentifier
Required
string | undefined

The identifier of the group profile.

GetGroupProfileCommand 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 exists.

groupName
string | undefined

The name of the group for which the specified group profile exists.

id
string | undefined

The identifier of the group profile.

status
GroupProfileStatus | undefined

The identifier 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.