Describe Compute Environments
batch_describe_compute_environments | R Documentation |
Describes one or more of your compute environments¶
Description¶
Describes one or more of your compute environments.
If you're using an unmanaged compute environment, you can use the
DescribeComputeEnvironment
operation to determine the ecsClusterArn
that you launch your Amazon ECS container instances into.
Usage¶
Arguments¶
computeEnvironments
A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.
maxResults
The maximum number of cluster results returned by
describe_compute_environments
in paginated output. When this parameter is used,describe_compute_environments
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherdescribe_compute_environments
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter isn't used, thendescribe_compute_environments
returns up to 100 results and anextToken
value if applicable.nextToken
The
nextToken
value returned from a previous paginateddescribe_compute_environments
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value. This value isnull
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(
computeEnvironments = list(
list(
computeEnvironmentName = "string",
computeEnvironmentArn = "string",
unmanagedvCpus = 123,
ecsClusterArn = "string",
tags = list(
"string"
),
type = "MANAGED"|"UNMANAGED",
state = "ENABLED"|"DISABLED",
status = "CREATING"|"UPDATING"|"DELETING"|"DELETED"|"VALID"|"INVALID",
statusReason = "string",
computeResources = list(
type = "EC2"|"SPOT"|"FARGATE"|"FARGATE_SPOT",
allocationStrategy = "BEST_FIT"|"BEST_FIT_PROGRESSIVE"|"SPOT_CAPACITY_OPTIMIZED"|"SPOT_PRICE_CAPACITY_OPTIMIZED",
minvCpus = 123,
maxvCpus = 123,
desiredvCpus = 123,
instanceTypes = list(
"string"
),
imageId = "string",
subnets = list(
"string"
),
securityGroupIds = list(
"string"
),
ec2KeyPair = "string",
instanceRole = "string",
tags = list(
"string"
),
placementGroup = "string",
bidPercentage = 123,
spotIamFleetRole = "string",
launchTemplate = list(
launchTemplateId = "string",
launchTemplateName = "string",
version = "string"
),
ec2Configuration = list(
list(
imageType = "string",
imageIdOverride = "string",
imageKubernetesVersion = "string"
)
)
),
serviceRole = "string",
updatePolicy = list(
terminateJobsOnUpdate = TRUE|FALSE,
jobExecutionTimeoutMinutes = 123
),
eksConfiguration = list(
eksClusterArn = "string",
kubernetesNamespace = "string"
),
containerOrchestrationType = "ECS"|"EKS",
uuid = "string",
context = "string"
)
),
nextToken = "string"
)
Request syntax¶
svc$describe_compute_environments(
computeEnvironments = list(
"string"
),
maxResults = 123,
nextToken = "string"
)