get_deployment `async` ¶

get_deployment(
    deployment_identifier: DeploymentIdentifier,
    *,
    config_overrides: Optional[AsyncNetworkSecurityManagerClientConfig] = None,
) -> GetDeploymentOutput

Retrieves the details of the specified deployment, including coverage information and any warnings.

Parameters:

deployment_identifier (DeploymentIdentifier) –

The identifier of the deployment. This is the deployment's Amazon Resource Name (ARN).

Raises:

AccessDeniedException –

You do not have sufficient permissions to perform this action.
InternalServerException –

The request processing failed because of an internal error in the service. This is a retryable error.
ResourceNotFoundException –

The specified resource was not found. Verify that the resource identifier is correct and that the resource exists, then try your request again.
ThrottlingException –

The request was denied because of request throttling. Reduce your request rate and try again.
ValidationException –

The request failed validation. For details, see the reason and fieldList members of the response.
UnknownServiceError –

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

Examples:

Get a deployment Retrieves the current published version of a deployment by its base ARN, including per-firewall-type coverage showing which in-scope resource types each policy protects.

>>> await client.get_deployment(deployment_identifier='arn:aws:network-security-manager:us-east-1:123456789012:deployment:def456')

Source code in docs_src/capo_network_security_manager/_services/async_network_security_manager.py

async def get_deployment(
    self,
    deployment_identifier: "capo_network_security_manager.types.deployment_identifier.DeploymentIdentifier",
    *,
    config_overrides: Optional[AsyncNetworkSecurityManagerClientConfig] = None,
) -> (
    "capo_network_security_manager.types.get_deployment_output.GetDeploymentOutput"
):
    """<p>Retrieves the details of the specified deployment, including coverage information and any warnings.</p>

    Args:
        deployment_identifier: <p>The identifier of the deployment. This is the deployment's Amazon Resource Name (ARN).</p>

    Raises:
        capo_network_security_manager.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient permissions to perform this action.</p>
        capo_network_security_manager.errors.internal_server_exception.InternalServerException: <p>The request processing failed because of an internal error in the service. This is a retryable error.</p>
        capo_network_security_manager.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found. Verify that the resource identifier is correct and that the resource exists, then try your request again.</p>
        capo_network_security_manager.errors.throttling_exception.ThrottlingException: <p>The request was denied because of request throttling. Reduce your request rate and try again.</p>
        capo_network_security_manager.errors.validation_exception.ValidationException: <p>The request failed validation. For details, see the <code>reason</code> and <code>fieldList</code> members of the response.</p>
        capo_network_security_manager.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Get a deployment
        Retrieves the current published version of a deployment by its base ARN, including per-firewall-type coverage showing which in-scope resource types each policy protects.

        >>> await client.get_deployment(deployment_identifier='arn:aws:network-security-manager:us-east-1:123456789012:deployment:def456')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_network_security_manager.types.get_deployment_input.GetDeploymentInput]",
    ) -> AsyncOperationResponse[
        "capo_network_security_manager.types.get_deployment_output.GetDeploymentOutput"
    ]:
        import capo_network_security_manager._operations.piccolo_customer_api_service.get_deployment

        (
            output,
            http_response,
        ) = await capo_network_security_manager._operations.piccolo_customer_api_service.get_deployment.async_get_deployment(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetDeployment")
    )
    input_: capo_network_security_manager.types.get_deployment_input.GetDeploymentInput = {
        "deployment_identifier": deployment_identifier
    }

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

get_deployment async ¶

get_deployment `async` ¶