Struct aws_sdk_identitystore::operation::list_groups::ListGroupsInput

#[non_exhaustive]
pub struct ListGroupsInput {
    pub identity_store_id: Option<String>,
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
    pub filters: Option<Vec<Filter>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

identity_store_id: Option<String>

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

max_results: Option<i32>

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

next_token: Option<String>

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

filters: Option<Vec<Filter>>

👎Deprecated: Using filters with ListGroups API is deprecated, please use GetGroupId API instead.

A list of Filter objects, which is used in the ListUsers and ListGroups requests.

Implementations

impl ListGroupsInput

pub fn identity_store_id(&self) -> Option<&str>

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

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

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

pub fn next_token(&self) -> Option<&str>

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

pub fn filters(&self) -> &[Filter]

👎Deprecated: Using filters with ListGroups API is deprecated, please use GetGroupId API instead.

A list of Filter objects, which is used in the ListUsers and ListGroups requests.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .filters.is_none().

impl ListGroupsInput

pub fn builder() -> ListGroupsInputBuilder

Creates a new builder-style object to manufacture ListGroupsInput.

Trait Implementations

impl Clone for ListGroupsInput

fn clone(&self) -> ListGroupsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListGroupsInput

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

Formats the value using the given formatter.

impl PartialEq for ListGroupsInput

fn eq(&self, other: &ListGroupsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ListGroupsInput