Skip to content

describe_resource_scan

describe_resource_scan(
    *,
    config_overrides: Optional[CloudFormationClientConfig] = None,
    resource_scan_id: Optional[ResourceScanId] = None,
) -> DescribeResourceScanOutput

Describes details of a resource scan.

Parameters:

  • resource_scan_id (Optional[ResourceScanId], default: None ) –

    The Amazon Resource Name (ARN) of the resource scan.

Raises:

Source code in docs_src/capo_cloudformation/_services/cloud_formation.py
def describe_resource_scan(
    self,
    *,
    config_overrides: Optional[CloudFormationClientConfig] = None,
    resource_scan_id: Optional[
        "capo_cloudformation.types.resource_scan_id.ResourceScanId"
    ] = None,
) -> "capo_cloudformation.types.describe_resource_scan_output.DescribeResourceScanOutput":
    """<p>Describes details of a resource scan.</p>

    Args:
        resource_scan_id: <p>The Amazon Resource Name (ARN) of the resource scan.</p>

    Raises:
        capo_cloudformation.errors.resource_scan_not_found_exception.ResourceScanNotFoundException: <p>The resource scan was not found.</p>
        capo_cloudformation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudformation.types.describe_resource_scan_input.DescribeResourceScanInput]",
    ) -> OperationResponse[
        "capo_cloudformation.types.describe_resource_scan_output.DescribeResourceScanOutput"
    ]:
        import capo_cloudformation._operations.cloud_formation.describe_resource_scan

        output, http_response = (
            capo_cloudformation._operations.cloud_formation.describe_resource_scan.describe_resource_scan(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeResourceScan")
    )
    input_: capo_cloudformation.types.describe_resource_scan_input.DescribeResourceScanInput = {}
    if resource_scan_id is not None:
        input_["resource_scan_id"] = resource_scan_id

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