Skip to content

update_share_invitation

update_share_invitation(
    share_invitation_id: ShareInvitationId,
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    share_invitation_action: Optional[ShareInvitationAction] = None,
) -> UpdateShareInvitationOutput

Update a workload or custom lens share invitation.

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

Parameters:

  • share_invitation_id (ShareInvitationId) –

    The ID assigned to the share invitation.

Raises:

Source code in docs_src/capo_wellarchitected/_services/well_architected.py
def update_share_invitation(
    self,
    share_invitation_id: "capo_wellarchitected.types.share_invitation_id.ShareInvitationId",
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    share_invitation_action: Optional[
        "capo_wellarchitected.types.share_invitation_action.ShareInvitationAction"
    ] = None,
) -> "capo_wellarchitected.types.update_share_invitation_output.UpdateShareInvitationOutput":
    """<p>Update a workload or custom lens share invitation.</p> <note> <p>This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.</p> </note>

    Args:
        share_invitation_id: <p>The ID assigned to the share invitation.</p>

    Raises:
        capo_wellarchitected.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_wellarchitected.errors.conflict_exception.ConflictException: <p>The resource has already been processed, was deleted, or is too large.</p>
        capo_wellarchitected.errors.internal_server_exception.InternalServerException: <p>There is a problem with the Well-Architected Tool API service.</p>
        capo_wellarchitected.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource was not found.</p>
        capo_wellarchitected.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_wellarchitected.errors.validation_exception.ValidationException: <p>The user input is not valid.</p>
        capo_wellarchitected.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_wellarchitected.types.update_share_invitation_input.UpdateShareInvitationInput]",
    ) -> OperationResponse[
        "capo_wellarchitected.types.update_share_invitation_output.UpdateShareInvitationOutput"
    ]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.update_share_invitation

        output, http_response = (
            capo_wellarchitected._operations.well_architected_api_service_lambda.update_share_invitation.update_share_invitation(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateShareInvitation")
    )
    input_: capo_wellarchitected.types.update_share_invitation_input.UpdateShareInvitationInput = {
        "share_invitation_id": share_invitation_id
    }
    if share_invitation_action is not None:
        input_["share_invitation_action"] = share_invitation_action

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output