Class ListWorkloadSharesCommandProtected

List the workload shares associated with the workload.

Example

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

import { WellArchitectedClient, ListWorkloadSharesCommand } from "@aws-sdk/client-wellarchitected"; // ES Modules import
// const { WellArchitectedClient, ListWorkloadSharesCommand } = require("@aws-sdk/client-wellarchitected"); // CommonJS import
const client = new WellArchitectedClient(config);
const input = { // ListWorkloadSharesInput
  WorkloadId: "STRING_VALUE", // required
  SharedWithPrefix: "STRING_VALUE",
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  Status: "ACCEPTED" || "REJECTED" || "PENDING" || "REVOKED" || "EXPIRED" || "ASSOCIATING" || "ASSOCIATED" || "FAILED",
};
const command = new ListWorkloadSharesCommand(input);
const response = await client.send(command);
// { // ListWorkloadSharesOutput
//   WorkloadId: "STRING_VALUE",
//   WorkloadShareSummaries: [ // WorkloadShareSummaries
//     { // WorkloadShareSummary
//       ShareId: "STRING_VALUE",
//       SharedWith: "STRING_VALUE",
//       PermissionType: "READONLY" || "CONTRIBUTOR",
//       Status: "ACCEPTED" || "REJECTED" || "PENDING" || "REVOKED" || "EXPIRED" || "ASSOCIATING" || "ASSOCIATED" || "FAILED",
//       StatusMessage: "STRING_VALUE",
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

Param

ListWorkloadSharesCommandInput

Returns

ListWorkloadSharesCommandOutput

See

• ListWorkloadSharesCommandInput for command's input shape.
• ListWorkloadSharesCommandOutput for command's response shape.
• config for WellArchitectedClient's config shape.

Throws

AccessDeniedException (client fault)

User does not have sufficient access to perform this action.

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.