Struct aws_sdk_secretsmanager::operation::batch_get_secret_value::builders::BatchGetSecretValueFluentBuilder

pub struct BatchGetSecretValueFluentBuilder { /* private fields */ }

Fluent builder constructing a request to BatchGetSecretValue.

Retrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets. To retrieve a single secret, call GetSecretValue.

To choose which secrets to retrieve, you can specify a list of secrets by name or ARN, or you can use filters. If Secrets Manager encounters errors such as AccessDeniedException while attempting to retrieve any of the secrets, you can see the errors in Errors in the response.

Secrets Manager generates CloudTrail GetSecretValue log entries for each secret you request when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

Required permissions: secretsmanager:BatchGetSecretValue, and you must have secretsmanager:GetSecretValue for each secret. If you use filters, you must also have secretsmanager:ListSecrets. If the secrets are encrypted using customer-managed keys instead of the Amazon Web Services managed key aws/secretsmanager, then you also need kms:Decrypt permissions for the keys. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Implementations

impl BatchGetSecretValueFluentBuilder

pub fn as_input(&self) -> &BatchGetSecretValueInputBuilder

Access the BatchGetSecretValue as a reference.

pub async fn send( self, ) -> Result<BatchGetSecretValueOutput, SdkError<BatchGetSecretValueError, HttpResponse>>

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 customize( self, ) -> CustomizableOperation<BatchGetSecretValueOutput, BatchGetSecretValueError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn into_paginator(self) -> BatchGetSecretValuePaginator

Create a paginator for this request

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

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

Appends an item to SecretIdList.

To override the contents of this collection use set_secret_id_list.

The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.

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

The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.

pub fn get_secret_id_list(&self) -> &Option<Vec<String>>

The ARN or names of the secrets to retrieve. You must include Filters or SecretIdList, but not both.

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

Appends an item to Filters.

To override the contents of this collection use set_filters.

The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

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

The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

pub fn get_filters(&self) -> &Option<Vec<Filter>>

The filters to choose which secrets to retrieve. You must include Filters or SecretIdList, but not both.

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

The number of results to include in the response.

If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.

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

The number of results to include in the response.

If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.

pub fn get_max_results(&self) -> &Option<i32>

The number of results to include in the response.

If there are more results available, in the response, Secrets Manager includes NextToken. To get the next results, call BatchGetSecretValue again with the value from NextToken. To use this parameter, you must also use the Filters parameter.

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

A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call BatchGetSecretValue again with this value.

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

A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call BatchGetSecretValue again with this value.

pub fn get_next_token(&self) -> &Option<String>

A token that indicates where the output should continue from, if a previous call did not show all results. To get the next results, call BatchGetSecretValue again with this value.

Trait Implementations

impl Clone for BatchGetSecretValueFluentBuilder

fn clone(&self) -> BatchGetSecretValueFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BatchGetSecretValueFluentBuilder

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

Formats the value using the given formatter.