Struct aws_sdk_ssm::client::fluent_builders::DescribeSessions

pub struct DescribeSessions<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to DescribeSessions.

Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.

Implementations

impl<C, M, R> DescribeSessions<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeSessionsOutput, SdkError<DescribeSessionsError>> where
    R::Policy: SmithyRetryPolicy<DescribeSessionsInputOperationOutputAlias, DescribeSessionsOutput, DescribeSessionsError, DescribeSessionsInputOperationRetryAlias>, 

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) -> DescribeSessionsPaginator<C, M, R>

Create a paginator for this request

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

pub fn state(self, input: SessionState) -> Self

The session status to retrieve a list of sessions for. For example, "Active".

pub fn set_state(self, input: Option<SessionState>) -> Self

The session status to retrieve a list of sessions for. For example, "Active".

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

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

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

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

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

The token for the next set of items to return. (You received this token from a previous call.)

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

The token for the next set of items to return. (You received this token from a previous call.)

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

Appends an item to Filters.

To override the contents of this collection use set_filters.

One or more filters to limit the type of sessions returned by the request.

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

One or more filters to limit the type of sessions returned by the request.

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for DescribeSessions<C, M, R>

fn clone(&self) -> DescribeSessions<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeSessions<C, M, R>

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

Formats the value using the given formatter.