Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class UpdateWorkloadShareCommandProtected

Update a workload share.

Example

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

import { WellArchitectedClient, UpdateWorkloadShareCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
// const { WellArchitectedClient, UpdateWorkloadShareCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
const client = new WellArchitectedClient(config);
const input = { // UpdateWorkloadShareInput
ShareId: "STRING_VALUE", // required
WorkloadId: "STRING_VALUE", // required
PermissionType: "READONLY" || "CONTRIBUTOR", // required
};
const command = new UpdateWorkloadShareCommand(input);
const response = await client.send(command);
// { // UpdateWorkloadShareOutput
// WorkloadId: "STRING_VALUE",
// WorkloadShare: { // WorkloadShare
// ShareId: "STRING_VALUE",
// SharedBy: "STRING_VALUE",
// SharedWith: "STRING_VALUE",
// PermissionType: "READONLY" || "CONTRIBUTOR",
// Status: "ACCEPTED" || "REJECTED" || "PENDING" || "REVOKED" || "EXPIRED" || "ASSOCIATING" || "ASSOCIATED" || "FAILED",
// WorkloadName: "STRING_VALUE",
// WorkloadId: "STRING_VALUE",
// },
// };

Param

UpdateWorkloadShareCommandInput

Returns

UpdateWorkloadShareCommandOutput

See

Throws

AccessDeniedException (client fault)

User does not have sufficient access to perform this action.

Throws

ConflictException (client fault)

The resource has already been processed, was deleted, or is too large.

Throws

InternalServerException (server fault)

There is a problem with the Well-Architected Tool API service.

Throws

ResourceNotFoundException (client fault)

The requested resource was not found.

Throws

ThrottlingException (client fault)

Request was denied due to request throttling.

Throws

ValidationException (client fault)

The user input is not valid.

Throws

WellArchitectedServiceException

Base exception class for all service exceptions from WellArchitected service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods