create_workload_share ¶

def create_workload_share(
    self,
    workload_id: "capo_wellarchitected.types.workload_id.WorkloadId",
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    shared_with: Optional[
        "capo_wellarchitected.types.shared_with.SharedWith"
    ] = None,
    permission_type: Optional[
        "capo_wellarchitected.types.permission_type.PermissionType"
    ] = None,
    client_request_token: Optional[
        "capo_wellarchitected.types.client_request_token.ClientRequestToken"
    ] = None,
) -> "capo_wellarchitected.types.create_workload_share_output.CreateWorkloadShareOutput":
    """<p>Create a workload share.</p> <p>The owner of a workload can share it with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.</p> <p>If you share a workload with an organization or OU, all accounts in the organization or OU are granted access to the workload.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html">Sharing a workload</a> in the <i>Well-Architected Tool User Guide</i>.</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.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The user has reached their resource quota.</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.create_workload_share_input.CreateWorkloadShareInput]",
    ) -> OperationResponse[
        "capo_wellarchitected.types.create_workload_share_output.CreateWorkloadShareOutput"
    ]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.create_workload_share

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateWorkloadShare")
    )
    input_: capo_wellarchitected.types.create_workload_share_input.CreateWorkloadShareInput = {
        "workload_id": workload_id
    }
    if shared_with is not None:
        input_["shared_with"] = shared_with
    if permission_type is not None:
        input_["permission_type"] = permission_type
    if client_request_token is None:
        client_request_token = str(uuid.uuid4())
    input_["client_request_token"] = client_request_token

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