Own AWS? Customize your docs with AI search, analytics, and more.

GET

/workloads/{WorkloadId}/shares

http://wellarchitected.{region}.amazonaws.com/workloads/{WorkloadId}/shares

List the workload shares associated with the workload.

Access Token Required: API Key

Path Parameters

WorkloadIdstringrequired

Query Params

SharedWithPrefixstring

The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.

NextTokenstring

MaxResultsinteger

The maximum number of results to return for this request.

Statusstring

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://wellarchitected.{region}.amazonaws.com/workloads/{WorkloadId}/shares' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/workloads/{WorkloadId}/shares

http://wellarchitected.{region}.amazonaws.com/workloads/{WorkloadId}/shares

List the workload shares associated with the workload.

Access Token Required: API Key

Path Parameters

WorkloadIdstringrequired

Query Params

SharedWithPrefixstring

The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.

NextTokenstring

MaxResultsinteger

The maximum number of results to return for this request.

Statusstring

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://wellarchitected.{region}.amazonaws.com/workloads/{WorkloadId}/shares' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/workloads/{WorkloadId}/shares

http://wellarchitected.{region}.amazonaws.com/workloads/{WorkloadId}/shares

List the workload shares associated with the workload.

Access Token Required: API Key

Path Parameters

WorkloadIdstringrequired

Query Params

SharedWithPrefixstring

The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.

NextTokenstring

MaxResultsinteger

The maximum number of results to return for this request.

Statusstring

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://wellarchitected.{region}.amazonaws.com/workloads/{WorkloadId}/shares' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

/workloads/{WorkloadId}/shares

http://wellarchitected.{region}.amazonaws.com/workloads/{WorkloadId}/shares

List the workload shares associated with the workload.

Access Token Required: API Key

Path Parameters

WorkloadIdstringrequired

Query Params

SharedWithPrefixstring

The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.

NextTokenstring

MaxResultsinteger

The maximum number of results to return for this request.

Statusstring

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://wellarchitected.{region}.amazonaws.com/workloads/{WorkloadId}/shares' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}