Describe Service Environments

batch_describe_service_environments

R Documentation

Describes one or more of your service environments

Description

Describes one or more of your service environments.

Usage

batch_describe_service_environments(serviceEnvironments, maxResults,
  nextToken)

Arguments

serviceEnvironments	An array of service environment names or ARN entries.
maxResults	The maximum number of results returned by describe_service_environments in paginated output. When this parameter is used, describe_service_environments only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another describe_service_environments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then describe_service_environments returns up to 100 results and a nextToken value if applicable.
nextToken	The nextToken value returned from a previous paginated describe_service_environments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Value

A list with the following syntax:

list(
  serviceEnvironments = list(
    list(
      serviceEnvironmentName = "string",
      serviceEnvironmentArn = "string",
      serviceEnvironmentType = "SAGEMAKER_TRAINING",
      state = "ENABLED"|"DISABLED",
      status = "CREATING"|"UPDATING"|"DELETING"|"DELETED"|"VALID"|"INVALID",
      capacityLimits = list(
        list(
          maxCapacity = 123,
          capacityUnit = "string"
        )
      ),
      tags = list(
        "string"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$describe_service_environments(
  serviceEnvironments = list(
    "string"
  ),
  maxResults = 123,
  nextToken = "string"
)