Struct aws_sdk_organizations::operation::list_handshakes_for_organization::builders::ListHandshakesForOrganizationFluentBuilder
source · pub struct ListHandshakesForOrganizationFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to ListHandshakesForOrganization
.
Lists the handshakes that are associated with the organization that the requesting user is part of. The ListHandshakesForOrganization
operation returns a list of handshake structures. Each structure contains details and status about a handshake.
Handshakes that are ACCEPTED
, DECLINED
, CANCELED
, or EXPIRED
appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.
Always check the NextToken
response parameter for a null
value when calling a List*
operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken
response parameter value is null
only when there are no more results to display.
This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.
Implementations§
source§impl ListHandshakesForOrganizationFluentBuilder
impl ListHandshakesForOrganizationFluentBuilder
sourcepub fn as_input(&self) -> &ListHandshakesForOrganizationInputBuilder
pub fn as_input(&self) -> &ListHandshakesForOrganizationInputBuilder
Access the ListHandshakesForOrganization as a reference.
sourcepub async fn send(
self
) -> Result<ListHandshakesForOrganizationOutput, SdkError<ListHandshakesForOrganizationError, HttpResponse>>
pub async fn send( self ) -> Result<ListHandshakesForOrganizationOutput, SdkError<ListHandshakesForOrganizationError, 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.
sourcepub fn customize(
self
) -> CustomizableOperation<ListHandshakesForOrganizationOutput, ListHandshakesForOrganizationError, Self>
pub fn customize( self ) -> CustomizableOperation<ListHandshakesForOrganizationOutput, ListHandshakesForOrganizationError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> ListHandshakesForOrganizationPaginator
pub fn into_paginator(self) -> ListHandshakesForOrganizationPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
sourcepub fn filter(self, input: HandshakeFilter) -> Self
pub fn filter(self, input: HandshakeFilter) -> Self
A filter of the handshakes that you want included in the response. The default is all types. Use the ActionType
element to limit the output to only a specified type, such as INVITE
, ENABLE-ALL-FEATURES
, or APPROVE-ALL-FEATURES
. Alternatively, for the ENABLE-ALL-FEATURES
handshake that generates a separate child handshake for each member account, you can specify the ParentHandshakeId
to see only the handshakes that were generated by that parent request.
sourcepub fn set_filter(self, input: Option<HandshakeFilter>) -> Self
pub fn set_filter(self, input: Option<HandshakeFilter>) -> Self
A filter of the handshakes that you want included in the response. The default is all types. Use the ActionType
element to limit the output to only a specified type, such as INVITE
, ENABLE-ALL-FEATURES
, or APPROVE-ALL-FEATURES
. Alternatively, for the ENABLE-ALL-FEATURES
handshake that generates a separate child handshake for each member account, you can specify the ParentHandshakeId
to see only the handshakes that were generated by that parent request.
sourcepub fn get_filter(&self) -> &Option<HandshakeFilter>
pub fn get_filter(&self) -> &Option<HandshakeFilter>
A filter of the handshakes that you want included in the response. The default is all types. Use the ActionType
element to limit the output to only a specified type, such as INVITE
, ENABLE-ALL-FEATURES
, or APPROVE-ALL-FEATURES
. Alternatively, for the ENABLE-ALL-FEATURES
handshake that generates a separate child handshake for each member account, you can specify the ParentHandshakeId
to see only the handshakes that were generated by that parent request.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken
response indicates that more output is available. Set this parameter to the value of the previous call's NextToken
response to indicate where the output should continue from.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken
response indicates that more output is available. Set this parameter to the value of the previous call's NextToken
response to indicate where the output should continue from.
sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
The parameter for receiving additional results if you receive a NextToken
response in a previous request. A NextToken
response indicates that more output is available. Set this parameter to the value of the previous call's NextToken
response to indicate where the output should continue from.
sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken
response element is present and has a value (is not null). Include that value as the NextToken
request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken
after every operation to ensure that you receive all of the results.
Trait Implementations§
source§impl Clone for ListHandshakesForOrganizationFluentBuilder
impl Clone for ListHandshakesForOrganizationFluentBuilder
source§fn clone(&self) -> ListHandshakesForOrganizationFluentBuilder
fn clone(&self) -> ListHandshakesForOrganizationFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for ListHandshakesForOrganizationFluentBuilder
impl !RefUnwindSafe for ListHandshakesForOrganizationFluentBuilder
impl Send for ListHandshakesForOrganizationFluentBuilder
impl Sync for ListHandshakesForOrganizationFluentBuilder
impl Unpin for ListHandshakesForOrganizationFluentBuilder
impl !UnwindSafe for ListHandshakesForOrganizationFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more