delete_connector `async` ¶

delete_connector(
    connector_arn: ConnectorArn,
    *,
    config_overrides: Optional[AsyncPcaConnectorAdClientConfig] = None,
) -> None

Deletes a connector for Active Directory. You must provide the Amazon Resource Name (ARN) of the connector that you want to delete. You can find the ARN by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors action. Deleting a connector does not deregister your directory with Amazon Web Services Private CA. You can deregister your directory by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration action.

Parameters:

connector_arn (ConnectorArn) –

The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

Raises:

AccessDeniedException –

You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account.
ConflictException –

This request cannot be completed for one of the following reasons because the requested resource was being concurrently modified by another request.
InternalServerException –

The request processing has failed because of an unknown error, exception or failure with an internal server.
ResourceNotFoundException –

The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.
ThrottlingException –

The limit on the number of requests per second was exceeded.
ValidationException –

An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid.
UnknownServiceError –

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

Source code in docs_src/capo_pca_connector_ad/_services/async_pca_connector_ad.py

async def delete_connector(
    self,
    connector_arn: "capo_pca_connector_ad.types.connector_arn.ConnectorArn",
    *,
    config_overrides: Optional[AsyncPcaConnectorAdClientConfig] = None,
) -> None:
    """<p>Deletes a connector for Active Directory. You must provide the Amazon Resource Name (ARN) of the connector that you want to delete. You can find the ARN by calling the <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors">https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors</a> action. Deleting a connector does not deregister your directory with Amazon Web Services Private CA. You can deregister your directory by calling the <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration">https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration</a> action.</p>

    Args:
        connector_arn: <p> The Amazon Resource Name (ARN) that was returned when you called <a href="https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector.html">CreateConnector</a>.</p>

    Raises:
        capo_pca_connector_ad.errors.access_denied_exception.AccessDeniedException: <p>You can receive this error if you attempt to create a resource share when you don't have the required permissions. This can be caused by insufficient permissions in policies attached to your Amazon Web Services Identity and Access Management (IAM) principal. It can also happen because of restrictions in place from an Amazon Web Services Organizations service control policy (SCP) that affects your Amazon Web Services account. </p>
        capo_pca_connector_ad.errors.conflict_exception.ConflictException: <p>This request cannot be completed for one of the following reasons because the requested resource was being concurrently modified by another request.</p>
        capo_pca_connector_ad.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure with an internal server. </p>
        capo_pca_connector_ad.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access a nonexistent resource. The resource might not be specified correctly, or its status might not be ACTIVE.</p>
        capo_pca_connector_ad.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded. </p>
        capo_pca_connector_ad.errors.validation_exception.ValidationException: <p>An input validation error occurred. For example, invalid characters in a template name, or if a pagination token is invalid. </p>
        capo_pca_connector_ad.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_pca_connector_ad.types.delete_connector_request.DeleteConnectorRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_pca_connector_ad._operations.pca_connector_ad.delete_connector

        (
            output,
            http_response,
        ) = await capo_pca_connector_ad._operations.pca_connector_ad.delete_connector.async_delete_connector(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteConnector")
    )
    input_: capo_pca_connector_ad.types.delete_connector_request.DeleteConnectorRequest = {
        "connector_arn": connector_arn
    }

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

delete_connector async ¶

delete_connector `async` ¶