Skip to content

Retrieves a list that describes one or more specified stacks, if the stack names are provided

Description

Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.

Usage

appstream_describe_stacks(Names, NextToken)

Arguments

  • Names

    The names of the stacks to describe.

  • NextToken

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Value

A list with the following syntax:

list(
  Stacks = list(
    list(
      Arn = "string",
      Name = "string",
      Description = "string",
      DisplayName = "string",
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      StorageConnectors = list(
        list(
          ConnectorType = "HOMEFOLDERS"|"GOOGLE_DRIVE"|"ONE_DRIVE",
          ResourceIdentifier = "string",
          Domains = list(
            "string"
          ),
          DomainsRequireAdminConsent = list(
            "string"
          )
        )
      ),
      RedirectURL = "string",
      FeedbackURL = "string",
      StackErrors = list(
        list(
          ErrorCode = "STORAGE_CONNECTOR_ERROR"|"INTERNAL_SERVICE_ERROR",
          ErrorMessage = "string"
        )
      ),
      UserSettings = list(
        list(
          Action = "CLIPBOARD_COPY_FROM_LOCAL_DEVICE"|"CLIPBOARD_COPY_TO_LOCAL_DEVICE"|"FILE_UPLOAD"|"FILE_DOWNLOAD"|"PRINTING_TO_LOCAL_DEVICE"|"DOMAIN_PASSWORD_SIGNIN"|"DOMAIN_SMART_CARD_SIGNIN"|"AUTO_TIME_ZONE_REDIRECTION",
          Permission = "ENABLED"|"DISABLED",
          MaximumLength = 123
        )
      ),
      ApplicationSettings = list(
        Enabled = TRUE|FALSE,
        SettingsGroup = "string",
        S3BucketName = "string"
      ),
      AccessEndpoints = list(
        list(
          EndpointType = "STREAMING",
          VpceId = "string"
        )
      ),
      EmbedHostDomains = list(
        "string"
      ),
      StreamingExperienceSettings = list(
        PreferredProtocol = "TCP"|"UDP"
      ),
      ContentRedirection = list(
        HostToClient = list(
          Enabled = TRUE|FALSE,
          AllowedUrls = list(
            "string"
          ),
          DeniedUrls = list(
            "string"
          )
        )
      ),
      AgentAccessConfig = list(
        Settings = list(
          list(
            AgentAction = "COMPUTER_VISION"|"COMPUTER_INPUT"|"FORWARD_MCP_TOOLS",
            Permission = "ENABLED"|"DISABLED"
          )
        ),
        S3BucketArn = "string",
        ScreenshotsUploadEnabled = TRUE|FALSE,
        ScreenResolution = "W_1280xH_720",
        ScreenImageFormat = "PNG"|"JPEG",
        UserControlMode = "VIEW_ONLY"|"VIEW_STOP"|"DISABLED"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_stacks(
  Names = list(
    "string"
  ),
  NextToken = "string"
)