- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateGroupProfileCommand
Updates the specified group profile in Amazon DataZone.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { DataZoneClient, UpdateGroupProfileCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, UpdateGroupProfileCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // UpdateGroupProfileInput
domainIdentifier: "STRING_VALUE", // required
groupIdentifier: "STRING_VALUE", // required
status: "ASSIGNED" || "NOT_ASSIGNED", // required
};
const command = new UpdateGroupProfileCommand(input);
const response = await client.send(command);
// { // UpdateGroupProfileOutput
// domainId: "STRING_VALUE",
// id: "STRING_VALUE",
// status: "ASSIGNED" || "NOT_ASSIGNED",
// groupName: "STRING_VALUE",
// };
UpdateGroupProfileCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
domainIdentifier Required | string | undefined | The identifier of the Amazon DataZone domain in which a group profile is updated. |
groupIdentifier Required | string | undefined | The identifier of the group profile that is updated. |
status Required | GroupProfileStatus | undefined | The status of the group profile that is updated. |
UpdateGroupProfileCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
domainId | string | undefined | The identifier of the Amazon DataZone domain in which a group profile is updated. |
groupName | string | undefined | The name of the group profile that is updated. |
id | string | undefined | The identifier of the group profile that is updated. |
status | GroupProfileStatus | undefined | The status of the group profile that is updated. |
Throws
Name | Fault | Details |
---|
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. |