Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateShareInvitation

Update a workload or custom lens share invitation.

Note

This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.

Request Syntax


PATCH /shareInvitations/ShareInvitationId HTTP/1.1
Content-type: application/json

{
   "ShareInvitationAction": "string"
}

URI Request Parameters

The request uses the following URI parameters.

ShareInvitationId

The ID assigned to the share invitation.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

ShareInvitationAction

Share invitation action taken by contributor.

Type: String

Valid Values: ACCEPT | REJECT

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ShareInvitation": { 
      "LensAlias": "string",
      "LensArn": "string",
      "ProfileArn": "string",
      "ShareInvitationId": "string",
      "ShareResourceType": "string",
      "TemplateArn": "string",
      "WorkloadId": "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.

ShareInvitation

The updated workload or custom lens share invitation.

Type: ShareInvitation object

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.

Message: Description of the error.

HTTP Status Code: 403

ConflictException

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

Message: Description of the error.
ResourceId: Identifier of the resource affected.
ResourceType: Type of the resource affected.

HTTP Status Code: 409

InternalServerException

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

Message: Description of the error.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource was not found.

Message: Description of the error.
ResourceId: Identifier of the resource affected.
ResourceType: Type of the resource affected.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

Message: Description of the error.
QuotaCode: Service Quotas requirement to identify originating quota.
ServiceCode: Service Quotas requirement to identify originating service.

HTTP Status Code: 429

ValidationException

The user input is not valid.

Fields: The fields that caused the error, if applicable.
Message: Description of the error.
Reason: The reason why the request failed validation.

HTTP Status Code: 400