delete_access `async` ¶

delete_access(
    server_id: ServerId,
    external_id: ExternalId,
    *,
    config_overrides: Optional[AsyncTransferClientConfig] = None,
) -> None

Allows you to delete the access specified in the ServerID and ExternalID parameters.

Parameters:

server_id (ServerId) –

A system-assigned unique identifier for a server that has this user assigned.
external_id (ExternalId) –

A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

In that command, replace YourGroupName with the name of your Active Directory group.

The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

Raises:

InternalServiceError –

This exception is thrown when an error occurs in the Transfer Family service.
InvalidRequestException –

This exception is thrown when the client submits a malformed request.
ResourceNotFoundException –

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.
ServiceUnavailableException –

The request has failed because the Amazon Web ServicesTransfer Family service is not available.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_transfer/_services/async_transfer.py

async def delete_access(
    self,
    server_id: "capo_transfer.types.server_id.ServerId",
    external_id: "capo_transfer.types.external_id.ExternalId",
    *,
    config_overrides: Optional[AsyncTransferClientConfig] = None,
) -> None:
    """<p>Allows you to delete the access specified in the <code>ServerID</code> and <code>ExternalID</code> parameters.</p>

    Args:
        server_id: <p>A system-assigned unique identifier for a server that has this user assigned.</p>
        external_id: <p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p> <p> <code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code> </p> <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p> <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p>

    Raises:
        capo_transfer.errors.internal_service_error.InternalServiceError: <p>This exception is thrown when an error occurs in the Transfer Family service.</p>
        capo_transfer.errors.invalid_request_exception.InvalidRequestException: <p>This exception is thrown when the client submits a malformed request.</p>
        capo_transfer.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.</p>
        capo_transfer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed because the Amazon Web ServicesTransfer Family service is not available.</p>
        capo_transfer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_transfer.types.delete_access_request.DeleteAccessRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_transfer._operations.transfer_service.delete_access

        (
            output,
            http_response,
        ) = await capo_transfer._operations.transfer_service.delete_access.async_delete_access(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteAccess")
    )
    input_: capo_transfer.types.delete_access_request.DeleteAccessRequest = {
        "server_id": server_id,
        "external_id": external_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_access async ¶

delete_access `async` ¶