CreateProjectMembershipCommand

Creates a project membership in Amazon DataZone.

Example Syntax

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

import { DataZoneClient, CreateProjectMembershipCommand } from "@aws-sdk/client-datazone"; // ES Modules import
// const { DataZoneClient, CreateProjectMembershipCommand } = require("@aws-sdk/client-datazone"); // CommonJS import
const client = new DataZoneClient(config);
const input = { // CreateProjectMembershipInput
  domainIdentifier: "STRING_VALUE", // required
  projectIdentifier: "STRING_VALUE", // required
  member: { // Member Union: only one key present
    userIdentifier: "STRING_VALUE",
    groupIdentifier: "STRING_VALUE",
  },
  designation: "PROJECT_OWNER" || "PROJECT_CONTRIBUTOR" || "PROJECT_CATALOG_VIEWER" || "PROJECT_CATALOG_CONSUMER" || "PROJECT_CATALOG_STEWARD", // required
};
const command = new CreateProjectMembershipCommand(input);
const response = await client.send(command);
// {};

CreateProjectMembershipCommand Input

Parameter
Type
Description
designation
Required
UserDesignation | undefined

The designation of the project membership.

domainIdentifier
Required
string | undefined

The ID of the Amazon DataZone domain in which project membership is created.

member
Required
Member | undefined

The project member whose project membership was created.

projectIdentifier
Required
string | undefined

The ID of the project for which this project membership was created.

CreateProjectMembershipCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

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.