update_archive ¶

def update_archive(
    self,
    archive_name: "capo_cloudwatch_events.types.archive_name.ArchiveName",
    *,
    config_overrides: Optional[CloudWatchEventsClientConfig] = None,
    description: Optional[
        "capo_cloudwatch_events.types.archive_description.ArchiveDescription"
    ] = None,
    event_pattern: Optional[
        "capo_cloudwatch_events.types.event_pattern.EventPattern"
    ] = None,
    retention_days: Optional[
        "capo_cloudwatch_events.types.retention_days.RetentionDays"
    ] = None,
) -> "capo_cloudwatch_events.types.update_archive_response.UpdateArchiveResponse":
    """<p>Updates the specified archive.</p>

    Args:
        archive_name: <p>The name of the archive to update.</p>
        description: <p>The description for the archive.</p>
        event_pattern: <p>The event pattern to use to filter events sent to the archive.</p>
        retention_days: <p>The number of days to retain events in the archive.</p>

    Raises:
        capo_cloudwatch_events.errors.concurrent_modification_exception.ConcurrentModificationException: <p>There is concurrent modification on a rule, target, archive, or replay.</p>
        capo_cloudwatch_events.errors.internal_exception.InternalException: <p>This exception occurs due to unexpected causes.</p>
        capo_cloudwatch_events.errors.invalid_event_pattern_exception.InvalidEventPatternException: <p>The event pattern is not valid.</p>
        capo_cloudwatch_events.errors.limit_exceeded_exception.LimitExceededException: <p>The request failed because it attempted to create resource beyond the allowed service quota.</p>
        capo_cloudwatch_events.errors.resource_not_found_exception.ResourceNotFoundException: <p>An entity that you specified does not exist.</p>
        capo_cloudwatch_events.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cloudwatch_events.types.update_archive_request.UpdateArchiveRequest]",
    ) -> OperationResponse[
        "capo_cloudwatch_events.types.update_archive_response.UpdateArchiveResponse"
    ]:
        import capo_cloudwatch_events._operations.aws_events.update_archive

        output, http_response = (
            capo_cloudwatch_events._operations.aws_events.update_archive.update_archive(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateArchive")
    )
    input_: capo_cloudwatch_events.types.update_archive_request.UpdateArchiveRequest = {
        "archive_name": archive_name
    }
    if description is not None:
        input_["description"] = description
    if event_pattern is not None:
        input_["event_pattern"] = event_pattern
    if retention_days is not None:
        input_["retention_days"] = retention_days

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