Skip to content

list_snapshot_copy_configurations async

list_snapshot_copy_configurations(
    *,
    config_overrides: Optional[AsyncRedshiftServerlessClientConfig] = None,
    namespace_name: Optional[NamespaceName] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[int] = None,
) -> ListSnapshotCopyConfigurationsResponse

Returns a list of snapshot copy configurations.

Parameters:

  • namespace_name (Optional[NamespaceName], default: None ) –

    The namespace from which to list all snapshot copy configurations.

  • next_token (Optional[PaginationToken], default: None ) –

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

  • max_results (Optional[int], default: None ) –

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

Raises:

Source code in docs_src/capo_redshift_serverless/_services/async_redshift_serverless.py
async def list_snapshot_copy_configurations(
    self,
    *,
    config_overrides: Optional[AsyncRedshiftServerlessClientConfig] = None,
    namespace_name: Optional[
        "capo_redshift_serverless.types.namespace_name.NamespaceName"
    ] = None,
    next_token: Optional[
        "capo_redshift_serverless.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[int] = None,
) -> "capo_redshift_serverless.types.list_snapshot_copy_configurations_response.ListSnapshotCopyConfigurationsResponse":
    """<p>Returns a list of snapshot copy configurations.</p>

    Args:
        namespace_name: <p>The namespace from which to list all snapshot copy configurations.</p>
        next_token: <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>
        max_results: <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to display the next page of results.</p>

    Raises:
        capo_redshift_serverless.errors.conflict_exception.ConflictException: <p>The submitted action has conflicts.</p>
        capo_redshift_serverless.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_redshift_serverless.errors.invalid_pagination_exception.InvalidPaginationException: <p>The provided pagination token is invalid.</p>
        capo_redshift_serverless.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_redshift_serverless.errors.validation_exception.ValidationException: <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_redshift_serverless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_redshift_serverless.types.list_snapshot_copy_configurations_request.ListSnapshotCopyConfigurationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_redshift_serverless.types.list_snapshot_copy_configurations_response.ListSnapshotCopyConfigurationsResponse"
    ]:
        import capo_redshift_serverless._operations.redshift_serverless.list_snapshot_copy_configurations

        (
            output,
            http_response,
        ) = await capo_redshift_serverless._operations.redshift_serverless.list_snapshot_copy_configurations.async_list_snapshot_copy_configurations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSnapshotCopyConfigurations")
    )
    input_: capo_redshift_serverless.types.list_snapshot_copy_configurations_request.ListSnapshotCopyConfigurationsRequest = {}
    if namespace_name is not None:
        input_["namespace_name"] = namespace_name
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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