| Class | Description |
|---|---|
| Attachment |
An object representing a container instance or task attachment.
|
| AttachmentStateChange |
An object representing a change in state for a task attachment.
|
| Attribute |
An attribute is a name-value pair associated with an Amazon ECS object.
|
| AutoScalingGroupProvider |
The details of the Auto Scaling group for the capacity provider.
|
| AutoScalingGroupProviderUpdate |
The details of the Auto Scaling group capacity provider to update.
|
| AwsVpcConfiguration |
An object representing the networking details for a task or service.
|
| CapacityProvider |
The details of a capacity provider.
|
| CapacityProviderStrategyItem |
The details of a capacity provider strategy.
|
| Cluster |
A regional grouping of one or more container instances on which you can run task requests.
|
| ClusterConfiguration |
The execute command configuration for the cluster.
|
| ClusterSetting |
The settings to use when creating a cluster.
|
| Container |
A Docker container that is part of a task.
|
| ContainerDefinition |
Container definitions are used in task definitions to describe the different containers that are launched as part of
a task.
|
| ContainerDependency |
The dependencies defined for container startup and shutdown.
|
| ContainerInstance |
An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
|
| ContainerOverride |
The overrides that should be sent to a container.
|
| ContainerStateChange |
An object representing a change in state for a container.
|
| CreateCapacityProviderRequest | |
| CreateCapacityProviderResult | |
| CreateClusterRequest | |
| CreateClusterResult | |
| CreateServiceRequest | |
| CreateServiceResult | |
| CreateTaskSetRequest | |
| CreateTaskSetResult | |
| DeleteAccountSettingRequest | |
| DeleteAccountSettingResult | |
| DeleteAttributesRequest | |
| DeleteAttributesResult | |
| DeleteCapacityProviderRequest | |
| DeleteCapacityProviderResult | |
| DeleteClusterRequest | |
| DeleteClusterResult | |
| DeleteServiceRequest | |
| DeleteServiceResult | |
| DeleteTaskSetRequest | |
| DeleteTaskSetResult | |
| Deployment |
The details of an Amazon ECS service deployment.
|
| DeploymentCircuitBreaker |
|
| DeploymentConfiguration |
Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and
starting tasks.
|
| DeploymentController |
The deployment controller to use for the service.
|
| DeregisterContainerInstanceRequest | |
| DeregisterContainerInstanceResult | |
| DeregisterTaskDefinitionRequest | |
| DeregisterTaskDefinitionResult | |
| DescribeCapacityProvidersRequest | |
| DescribeCapacityProvidersResult | |
| DescribeClustersRequest | |
| DescribeClustersResult | |
| DescribeContainerInstancesRequest | |
| DescribeContainerInstancesResult | |
| DescribeServicesRequest | |
| DescribeServicesResult | |
| DescribeTaskDefinitionRequest | |
| DescribeTaskDefinitionResult | |
| DescribeTaskSetsRequest | |
| DescribeTaskSetsResult | |
| DescribeTasksRequest | |
| DescribeTasksResult | |
| Device |
An object representing a container instance host device.
|
| DiscoverPollEndpointRequest | |
| DiscoverPollEndpointResult | |
| DockerVolumeConfiguration |
This parameter is specified when you are using Docker volumes.
|
| EFSAuthorizationConfig |
The authorization configuration details for the Amazon EFS file system.
|
| EFSVolumeConfiguration |
This parameter is specified when you are using an Amazon Elastic File System file system for task storage.
|
| EnvironmentFile |
A list of files containing the environment variables to pass to a container.
|
| EphemeralStorage |
The amount of ephemeral storage to allocate for the task.
|
| ExecuteCommandConfiguration |
The details of the execute command configuration.
|
| ExecuteCommandLogConfiguration |
The log configuration for the results of the execute command actions.
|
| ExecuteCommandRequest | |
| ExecuteCommandResult | |
| Failure |
A failed resource.
|
| FirelensConfiguration |
The FireLens configuration for the container.
|
| FSxWindowsFileServerAuthorizationConfig |
The authorization configuration details for Amazon FSx for Windows File Server file system.
|
| FSxWindowsFileServerVolumeConfiguration |
This parameter is specified when you are using Amazon FSx for Windows File Server file
system for task storage.
|
| HealthCheck |
An object representing a container health check.
|
| HostEntry |
Hostnames and IP address entries that are added to the
/etc/hosts file of a container via the
extraHosts parameter of its ContainerDefinition. |
| HostVolumeProperties |
Details on a container instance bind mount host volume.
|
| InferenceAccelerator |
Details on a Elastic Inference accelerator.
|
| InferenceAcceleratorOverride |
Details on an Elastic Inference accelerator task override.
|
| KernelCapabilities |
The Linux capabilities for the container that are added to or dropped from the default configuration provided by
Docker.
|
| KeyValuePair |
A key-value pair object.
|
| LinuxParameters |
Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
|
| ListAccountSettingsRequest | |
| ListAccountSettingsResult | |
| ListAttributesRequest | |
| ListAttributesResult | |
| ListClustersRequest | |
| ListClustersResult | |
| ListContainerInstancesRequest | |
| ListContainerInstancesResult | |
| ListServicesRequest | |
| ListServicesResult | |
| ListTagsForResourceRequest | |
| ListTagsForResourceResult | |
| ListTaskDefinitionFamiliesRequest | |
| ListTaskDefinitionFamiliesResult | |
| ListTaskDefinitionsRequest | |
| ListTaskDefinitionsResult | |
| ListTasksRequest | |
| ListTasksResult | |
| LoadBalancer |
The load balancer configuration to use with a service or task set.
|
| LogConfiguration |
The log configuration for the container.
|
| ManagedAgent |
Details about the managed agent status for the container.
|
| ManagedAgentStateChange |
An object representing a change in state for a managed agent.
|
| ManagedScaling |
The managed scaling settings for the Auto Scaling group capacity provider.
|
| MountPoint |
Details on a volume mount point that is used in a container definition.
|
| NetworkBinding |
Details on the network bindings between a container and its host container instance.
|
| NetworkConfiguration |
An object representing the network configuration for a task or service.
|
| NetworkInterface |
An object representing the elastic network interface for tasks that use the
awsvpc network mode. |
| PlacementConstraint |
An object representing a constraint on task placement.
|
| PlacementStrategy |
The task placement strategy for a task or service.
|
| PlatformDevice |
The devices that are available on the container instance.
|
| PortMapping |
Port mappings allow containers to access ports on the host container instance to send or receive traffic.
|
| ProxyConfiguration |
The configuration details for the App Mesh proxy.
|
| PutAccountSettingDefaultRequest | |
| PutAccountSettingDefaultResult | |
| PutAccountSettingRequest | |
| PutAccountSettingResult | |
| PutAttributesRequest | |
| PutAttributesResult | |
| PutClusterCapacityProvidersRequest | |
| PutClusterCapacityProvidersResult | |
| RegisterContainerInstanceRequest | |
| RegisterContainerInstanceResult | |
| RegisterTaskDefinitionRequest | |
| RegisterTaskDefinitionResult | |
| RepositoryCredentials |
The repository credentials for private registry authentication.
|
| Resource |
Describes the resources available for a container instance.
|
| ResourceRequirement |
The type and amount of a resource to assign to a container.
|
| RunTaskRequest | |
| RunTaskResult | |
| Scale |
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
|
| Secret |
An object representing the secret to expose to your container.
|
| Service |
Details on a service within a cluster
|
| ServiceEvent |
Details on an event associated with a service.
|
| ServiceRegistry |
Details of the service registry.
|
| Session |
The details of the execute command session.
|
| Setting |
The current account setting for a resource.
|
| StartTaskRequest | |
| StartTaskResult | |
| StopTaskRequest | |
| StopTaskResult | |
| SubmitAttachmentStateChangesRequest | |
| SubmitAttachmentStateChangesResult | |
| SubmitContainerStateChangeRequest | |
| SubmitContainerStateChangeResult | |
| SubmitTaskStateChangeRequest | |
| SubmitTaskStateChangeResult | |
| SystemControl |
A list of namespaced kernel parameters to set in the container.
|
| Tag |
The metadata that you apply to a resource to help you categorize and organize them.
|
| TagResourceRequest | |
| TagResourceResult | |
| Task |
Details on a task in a cluster.
|
| TaskDefinition |
The details of a task definition which describes the container and volume definitions of an Amazon Elastic Container
Service task.
|
| TaskDefinitionPlacementConstraint |
An object representing a constraint on task placement in the task definition.
|
| TaskOverride |
The overrides associated with a task.
|
| TaskSet |
Information about a set of Amazon ECS tasks in either an CodeDeploy or an
EXTERNAL deployment. |
| Tmpfs |
The container path, mount options, and size of the tmpfs mount.
|
| Ulimit |
The
ulimit settings to pass to the container. |
| UntagResourceRequest | |
| UntagResourceResult | |
| UpdateCapacityProviderRequest | |
| UpdateCapacityProviderResult | |
| UpdateClusterRequest | |
| UpdateClusterResult | |
| UpdateClusterSettingsRequest | |
| UpdateClusterSettingsResult | |
| UpdateContainerAgentRequest | |
| UpdateContainerAgentResult | |
| UpdateContainerInstancesStateRequest | |
| UpdateContainerInstancesStateResult | |
| UpdateServicePrimaryTaskSetRequest | |
| UpdateServicePrimaryTaskSetResult | |
| UpdateServiceRequest | |
| UpdateServiceResult | |
| UpdateTaskSetRequest | |
| UpdateTaskSetResult | |
| VersionInfo |
The Docker and Amazon ECS container agent version information about a container instance.
|
| Volume |
A data volume used in a task definition.
|
| VolumeFrom |
Details on a data volume from another container in the same task definition.
|
| Exception | Description |
|---|---|
| AccessDeniedException |
You do not have authorization to perform the requested action.
|
| AmazonECSException |
Base exception for all service exceptions thrown by Amazon EC2 Container Service
|
| AttributeLimitExceededException |
You can apply up to 10 custom attributes per resource.
|
| BlockedException |
Your Amazon Web Services account has been blocked.
|
| ClientException |
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that
doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
|
| ClusterContainsContainerInstancesException |
You cannot delete a cluster that has registered container instances.
|
| ClusterContainsServicesException |
You cannot delete a cluster that contains services.
|
| ClusterContainsTasksException |
You cannot delete a cluster that has active tasks.
|
| ClusterNotFoundException |
The specified cluster could not be found.
|
| InvalidParameterException |
The specified parameter is invalid.
|
| LimitExceededException |
The limit for the resource has been exceeded.
|
| MissingVersionException |
Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and
does not have enough information to proceed with an update.
|
| NoUpdateAvailableException |
There is no update available for this Amazon ECS container agent.
|
| PlatformTaskDefinitionIncompatibilityException |
The specified platform version does not satisfy the task definition's required capabilities.
|
| PlatformUnknownException |
The specified platform version does not exist.
|
| ResourceInUseException |
The specified resource is in-use and cannot be removed.
|
| ResourceNotFoundException |
The specified resource could not be found.
|
| ServerException |
These errors are usually caused by a server issue.
|
| ServiceNotActiveException |
The specified service is not active.
|
| ServiceNotFoundException |
The specified service could not be found.
|
| TargetNotConnectedException |
The target container is not properly configured with the execute command agent or the container is no longer active
or running.
|
| TargetNotFoundException |
The specified target could not be found.
|
| TaskSetNotFoundException |
The specified task set could not be found.
|
| UnsupportedFeatureException |
The specified task is not supported in this Region.
|
| UpdateInProgressException |
There is already a current Amazon ECS container agent update in progress on the specified container instance.
|