Struct aws_sdk_ssm::client::fluent_builders::GetCalendarState

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

Fluent builder constructing a request to GetCalendarState.

Gets the state of a Amazon Web Services Systems Manager change calendar at the current time or a specified time. If you specify a time, GetCalendarState returns the state of the calendar at that specific time, and returns the next time that the change calendar state will transition. If you don't specify a time, GetCalendarState uses the current time. Change Calendar entries have two possible states: OPEN or CLOSED.

If you specify more than one calendar in a request, the command returns the status of OPEN only if all calendars in the request are open. If one or more calendars in the request are closed, the status returned is CLOSED.

For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see Amazon Web Services Systems Manager Change Calendar in the Amazon Web Services Systems Manager User Guide.

Implementations

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

pub async fn send(
    self
) -> Result<GetCalendarStateOutput, SdkError<GetCalendarStateError>> where
    R::Policy: SmithyRetryPolicy<GetCalendarStateInputOperationOutputAlias, GetCalendarStateOutput, GetCalendarStateError, GetCalendarStateInputOperationRetryAlias>, 

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 calendar_names(self, input: impl Into<String>) -> Self

Appends an item to CalendarNames.

To override the contents of this collection use set_calendar_names.

The names or Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that represent the calendar entries for which you want to get the state.

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

The names or Amazon Resource Names (ARNs) of the Systems Manager documents (SSM documents) that represent the calendar entries for which you want to get the state.

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

(Optional) The specific time for which you want to get calendar state information, in ISO 8601 format. If you don't specify a value or AtTime, the current time is used.

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

(Optional) The specific time for which you want to get calendar state information, in ISO 8601 format. If you don't specify a value or AtTime, the current time is used.

Trait Implementations

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

fn clone(&self) -> GetCalendarState<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 GetCalendarState<C, M, R>

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

Formats the value using the given formatter.