Skip to content

describe_archive

describe_archive(
    archive_name: ArchiveName,
    *,
    config_overrides: Optional[EventBridgeClientConfig] = None,
) -> DescribeArchiveResponse

Retrieves details about an archive.

Parameters:

  • archive_name (ArchiveName) –

    The name of the archive to retrieve.

Raises:

Source code in docs_src/capo_eventbridge/_services/event_bridge.py
def describe_archive(
    self,
    archive_name: "capo_eventbridge.types.archive_name.ArchiveName",
    *,
    config_overrides: Optional[EventBridgeClientConfig] = None,
) -> "capo_eventbridge.types.describe_archive_response.DescribeArchiveResponse":
    """<p>Retrieves details about an archive.</p>

    Args:
        archive_name: <p>The name of the archive to retrieve.</p>

    Raises:
        capo_eventbridge.errors.internal_exception.InternalException: <p>This exception occurs due to unexpected causes.</p>
        capo_eventbridge.errors.resource_already_exists_exception.ResourceAlreadyExistsException: <p>The resource you are trying to create already exists.</p>
        capo_eventbridge.errors.resource_not_found_exception.ResourceNotFoundException: <p>An entity that you specified does not exist.</p>
        capo_eventbridge.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_eventbridge.types.describe_archive_request.DescribeArchiveRequest]",
    ) -> OperationResponse[
        "capo_eventbridge.types.describe_archive_response.DescribeArchiveResponse"
    ]:
        import capo_eventbridge._operations.aws_events.describe_archive

        output, http_response = (
            capo_eventbridge._operations.aws_events.describe_archive.describe_archive(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeArchive")
    )
    input_: capo_eventbridge.types.describe_archive_request.DescribeArchiveRequest = {
        "archive_name": archive_name
    }

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