Describe Connection Aliases

workspaces_describe_connection_aliases

R Documentation

Retrieves a list that describes the connection aliases used for cross-Region redirection¶

Description¶

Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.

Usage¶

workspaces_describe_connection_aliases(AliasIds, ResourceId, Limit,
  NextToken)

Arguments¶

AliasIds: The identifiers of the connection aliases to describe.
ResourceId: The identifier of the directory associated with the connection alias.
Limit: The maximum number of connection aliases to return.
NextToken: If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

Value¶

A list with the following syntax:

list(
  ConnectionAliases = list(
    list(
      ConnectionString = "string",
      AliasId = "string",
      State = "CREATING"|"CREATED"|"DELETING",
      OwnerAccountId = "string",
      Associations = list(
        list(
          AssociationStatus = "NOT_ASSOCIATED"|"ASSOCIATED_WITH_OWNER_ACCOUNT"|"ASSOCIATED_WITH_SHARED_ACCOUNT"|"PENDING_ASSOCIATION"|"PENDING_DISASSOCIATION",
          AssociatedAccountId = "string",
          ResourceId = "string",
          ConnectionIdentifier = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_connection_aliases(
  AliasIds = list(
    "string"
  ),
  ResourceId = "string",
  Limit = 123,
  NextToken = "string"
)