ListWorkloadShares - AWS Well-Architected Tool

ListWorkloadShares

List the workload shares associated with the workload.

Request Syntax

GET /workloads/WorkloadId/shares?MaxResults=MaxResults&NextToken=NextToken&SharedWithPrefix=SharedWithPrefix HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results to return for this request.

Valid Range: Minimum value of 1. Maximum value of 50.

NextToken

The token to use to retrieve the next set of results.

SharedWithPrefix

The AWS account ID or IAM role with which the workload is shared.

Length Constraints: Maximum length of 100.

WorkloadId

The ID assigned to the workload. This ID is unique within an AWS Region.

Pattern: [0-9a-f]{32}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "WorkloadId": "string", "WorkloadShareSummaries": [ { "PermissionType": "string", "SharedWith": "string", "ShareId": "string", "Status": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

The token to use to retrieve the next set of results.

Type: String

WorkloadId

The ID assigned to the workload. This ID is unique within an AWS Region.

Type: String

Pattern: [0-9a-f]{32}

WorkloadShareSummaries

A list of workload share summaries.

Type: Array of WorkloadShareSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The user input is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: