Struct aws_sdk_workspaces::operation::describe_workspaces::DescribeWorkspacesInput

#[non_exhaustive]
pub struct DescribeWorkspacesInput {
    pub workspace_ids: Option<Vec<String>>,
    pub directory_id: Option<String>,
    pub user_name: Option<String>,
    pub bundle_id: Option<String>,
    pub limit: Option<i32>,
    pub next_token: Option<String>,
    pub workspace_name: Option<String>,
}

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.

workspace_ids: Option<Vec<String>>

The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.

Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

directory_id: Option<String>

The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter.

user_name: Option<String>

The name of the directory user. You must specify this parameter with DirectoryId.

bundle_id: Option<String>

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

limit: Option<i32>

The maximum number of items to return.

next_token: Option<String>

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

workspace_name: Option<String>

The name of the user-decoupled WorkSpace.

Implementations

impl DescribeWorkspacesInput

pub fn workspace_ids(&self) -> &[String]

The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.

Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

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

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

The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter.

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

The name of the directory user. You must specify this parameter with DirectoryId.

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

The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

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

The maximum number of items to return.

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

If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

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

The name of the user-decoupled WorkSpace.

impl DescribeWorkspacesInput

pub fn builder() -> DescribeWorkspacesInputBuilder

Creates a new builder-style object to manufacture DescribeWorkspacesInput.

Trait Implementations

impl Clone for DescribeWorkspacesInput

fn clone(&self) -> DescribeWorkspacesInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeWorkspacesInput

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

Formats the value using the given formatter.

impl PartialEq for DescribeWorkspacesInput

fn eq(&self, other: &DescribeWorkspacesInput) -> 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 DescribeWorkspacesInput