Struct aws_sdk_rds::client::fluent_builders::DescribeDBInstances

pub struct DescribeDBInstances { /* private fields */ }

Fluent builder constructing a request to DescribeDBInstances.

Returns information about provisioned RDS instances. This API supports pagination.

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

Implementations

impl DescribeDBInstances

pub async fn customize(
    self
) -> Result<CustomizableOperation<DescribeDBInstances, AwsResponseRetryClassifier>, SdkError<DescribeDBInstancesError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<DescribeDbInstancesOutput, SdkError<DescribeDBInstancesError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribeDbInstancesPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn db_instance_identifier(self, input: impl Into<String>) -> Self

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DBInstance.

pub fn set_db_instance_identifier(self, input: Option<String>) -> Self

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DBInstance.

pub fn filters(self, input: Filter) -> Self

Appends an item to Filters.

To override the contents of this collection use set_filters.

A filter that specifies one or more DB instances to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.

• dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

• domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.

• engine - Accepts engine names. The results list only includes information about the DB instances for these engines.

pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self

A filter that specifies one or more DB instances to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB instances associated with the DB clusters identified by these ARNs.

• db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list only includes information about the DB instances identified by these ARNs.

• dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

• domain - Accepts Active Directory directory IDs. The results list only includes information about the DB instances associated with these domains.

• engine - Accepts engine names. The results list only includes information about the DB instances for these engines.

pub fn max_records(self, input: i32) -> Self

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

pub fn set_max_records(self, input: Option<i32>) -> Self

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

pub fn marker(self, input: impl Into<String>) -> Self

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

pub fn set_marker(self, input: Option<String>) -> Self

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Trait Implementations

impl Clone for DescribeDBInstances

fn clone(&self) -> DescribeDBInstances

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeDBInstances

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.