|
595 | 595 | "UpdateContainerInstancesStateResponse$failures": "<p>Any failures associated with the call.</p>" |
596 | 596 | } |
597 | 597 | }, |
| 598 | + "GpuIds": { |
| 599 | + "base": null, |
| 600 | + "refs": { |
| 601 | + "Container$gpuIds": "<p>The IDs of each GPU assigned to the container.</p>" |
| 602 | + } |
| 603 | + }, |
598 | 604 | "HealthCheck": { |
599 | 605 | "base": "<p>An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).</p> <p>The following are notes about container health check support:</p> <ul> <li> <p>Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html\">Updating the Amazon ECS Container Agent</a>.</p> </li> <li> <p>Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform Versions</a>.</p> </li> <li> <p>Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.</p> </li> </ul>", |
600 | 606 | "refs": { |
|
942 | 948 | "PlacementStrategy$type": "<p>The type of placement strategy. The <code>random</code> placement strategy randomly places tasks on available candidates. The <code>spread</code> placement strategy spreads placement across available candidates evenly based on the <code>field</code> parameter. The <code>binpack</code> strategy places tasks on available candidates that have the least available amount of the resource that is specified with the <code>field</code> parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).</p>" |
943 | 949 | } |
944 | 950 | }, |
| 951 | + "PlatformDevice": { |
| 952 | + "base": "<p>The devices that are available on the container instance. The only supported device type is a GPU.</p>", |
| 953 | + "refs": { |
| 954 | + "PlatformDevices$member": null |
| 955 | + } |
| 956 | + }, |
| 957 | + "PlatformDeviceType": { |
| 958 | + "base": null, |
| 959 | + "refs": { |
| 960 | + "PlatformDevice$type": "<p>The type of device that is available on the container instance. The only supported value is <code>GPU</code>.</p>" |
| 961 | + } |
| 962 | + }, |
| 963 | + "PlatformDevices": { |
| 964 | + "base": null, |
| 965 | + "refs": { |
| 966 | + "RegisterContainerInstanceRequest$platformDevices": "<p>The devices that are available on the container instance. The only supported device type is a GPU.</p>" |
| 967 | + } |
| 968 | + }, |
945 | 969 | "PlatformTaskDefinitionIncompatibilityException": { |
946 | 970 | "base": "<p>The specified platform version does not satisfy the task definition's required capabilities.</p>", |
947 | 971 | "refs": { |
|
967 | 991 | "PropagateTags": { |
968 | 992 | "base": null, |
969 | 993 | "refs": { |
970 | | - "CreateServiceRequest$propagateTags": "<p>Specifies whether to propagate the tags from the task definition or the service to the tasks. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the <a>TagResource</a> API action.</p>", |
971 | | - "RunTaskRequest$propagateTags": "<p>Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.</p>", |
| 994 | + "CreateServiceRequest$propagateTags": "<p>Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the <a>TagResource</a> API action.</p>", |
| 995 | + "RunTaskRequest$propagateTags": "<p>Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the <a>TagResource</a> API action.</p> <note> <p>An error will be received if you specify the <code>SERVICE</code> option when running a task.</p> </note>", |
972 | 996 | "Service$propagateTags": "<p>Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.</p>", |
973 | 997 | "StartTaskRequest$propagateTags": "<p>Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.</p>" |
974 | 998 | } |
|
1036 | 1060 | "refs": { |
1037 | 1061 | } |
1038 | 1062 | }, |
| 1063 | + "ResourceRequirement": { |
| 1064 | + "base": "<p>The type and amount of a resource to assign to a container. The only supported resource is a GPU.</p>", |
| 1065 | + "refs": { |
| 1066 | + "ResourceRequirements$member": null |
| 1067 | + } |
| 1068 | + }, |
| 1069 | + "ResourceRequirements": { |
| 1070 | + "base": null, |
| 1071 | + "refs": { |
| 1072 | + "ContainerDefinition$resourceRequirements": "<p>The type and amount of a resource to assign to a container. The only supported resource is a GPU.</p>", |
| 1073 | + "ContainerOverride$resourceRequirements": "<p>The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.</p>" |
| 1074 | + } |
| 1075 | + }, |
| 1076 | + "ResourceType": { |
| 1077 | + "base": null, |
| 1078 | + "refs": { |
| 1079 | + "ResourceRequirement$type": "<p>The type of resource a container desires. The only supported value is <code>GPU</code>.</p>" |
| 1080 | + } |
| 1081 | + }, |
1039 | 1082 | "Resources": { |
1040 | 1083 | "base": null, |
1041 | 1084 | "refs": { |
|
1240 | 1283 | "Container$name": "<p>The name of the container.</p>", |
1241 | 1284 | "Container$lastStatus": "<p>The last known status of the container.</p>", |
1242 | 1285 | "Container$reason": "<p>A short (255 max characters) human-readable string to provide additional details about a running or stopped container.</p>", |
| 1286 | + "Container$cpu": "<p>The number of CPU units set for the container. The value will be <code>0</code> if no value was specified in the container definition when the task definition was registered.</p>", |
| 1287 | + "Container$memory": "<p>The hard limit (in MiB) of memory set for the container.</p>", |
| 1288 | + "Container$memoryReservation": "<p>The soft limit (in MiB) of memory set for the container.</p>", |
1243 | 1289 | "ContainerDefinition$name": "<p>The name of a container. If you are linking multiple containers together in a task definition, the <code>name</code> of one container can be entered in the <code>links</code> of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to <code>name</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--name</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. </p>", |
1244 | 1290 | "ContainerDefinition$image": "<p>The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code> or <code> <i>repository-url</i>/<i>image</i>@<i>digest</i> </code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>IMAGE</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <ul> <li> <p>When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.</p> </li> <li> <p>Images in Amazon ECR repositories can be specified by either using the full <code>registry/repository:tag</code> or <code>registry/repository@digest</code>. For example, <code>012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest</code> or <code>012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE</code>. </p> </li> <li> <p>Images in official repositories on Docker Hub use a single name (for example, <code>ubuntu</code> or <code>mongo</code>).</p> </li> <li> <p>Images in other repositories on Docker Hub are qualified with an organization name (for example, <code>amazon/amazon-ecs-agent</code>).</p> </li> <li> <p>Images in other online repositories are qualified further by a domain name (for example, <code>quay.io/assemblyline/ubuntu</code>).</p> </li> </ul>", |
1245 | 1291 | "ContainerDefinition$hostname": "<p>The hostname to use for your container. This parameter maps to <code>Hostname</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--hostname</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>The <code>hostname</code> parameter is not supported if you are using the <code>awsvpc</code> network mode.</p> </note>", |
|
1286 | 1332 | "DockerVolumeConfiguration$driver": "<p>The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use <code>docker plugin ls</code> to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see <a href=\"https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery\">Docker plugin discovery</a>. This parameter maps to <code>Driver</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate\">Create a volume</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>xxdriver</code> option to <a href=\"https://docs.docker.com/engine/reference/commandline/volume_create/\"> <code>docker volume create</code> </a>.</p>", |
1287 | 1333 | "Failure$arn": "<p>The Amazon Resource Name (ARN) of the failed resource.</p>", |
1288 | 1334 | "Failure$reason": "<p>The reason for the failure.</p>", |
| 1335 | + "GpuIds$member": null, |
1289 | 1336 | "HostEntry$hostname": "<p>The hostname to use in the <code>/etc/hosts</code> entry.</p>", |
1290 | 1337 | "HostEntry$ipAddress": "<p>The IP address to use in the <code>/etc/hosts</code> entry.</p>", |
1291 | 1338 | "HostVolumeProperties$sourcePath": "<p>When the <code>host</code> parameter is used, specify a <code>sourcePath</code> to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the <code>host</code> parameter contains a <code>sourcePath</code> file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the <code>sourcePath</code> value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.</p> <p>If you are using the Fargate launch type, the <code>sourcePath</code> parameter is not supported.</p>", |
|
1336 | 1383 | "NetworkInterface$ipv6Address": "<p>The private IPv6 address for the network interface.</p>", |
1337 | 1384 | "PlacementConstraint$expression": "<p>A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is <code>distinctInstance</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>", |
1338 | 1385 | "PlacementStrategy$field": "<p>The field to apply the placement strategy against. For the <code>spread</code> placement strategy, valid values are <code>instanceId</code> (or <code>host</code>, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as <code>attribute:ecs.availability-zone</code>. For the <code>binpack</code> placement strategy, valid values are <code>cpu</code> and <code>memory</code>. For the <code>random</code> placement strategy, this field is not used.</p>", |
| 1386 | + "PlatformDevice$id": "<p>The ID for the GPU(s) on the container instance. The available GPU IDs can also be obtained on the container instance in the <code>/var/lib/ecs/gpu/nvidia_gpu_info.json</code> file.</p>", |
1339 | 1387 | "PutAccountSettingRequest$value": "<p>The account setting value for the specified principal ARN. Accepted values are <code>enabled</code> and <code>disabled</code>.</p>", |
1340 | 1388 | "PutAccountSettingRequest$principalArn": "<p>The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the ARN and resource ID format for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings for themselves. If this field is omitted, the setting are changed only for the authenticated user.</p>", |
1341 | 1389 | "PutAttributesRequest$cluster": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.</p>", |
|
1351 | 1399 | "RepositoryCredentials$credentialsParameter": "<p>The Amazon Resource Name (ARN) of the secret containing the private repository credentials.</p> <note> <p>When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS Management Console, you must specify the full ARN of the secret.</p> </note>", |
1352 | 1400 | "Resource$name": "<p>The name of the resource, such as <code>CPU</code>, <code>MEMORY</code>, <code>PORTS</code>, <code>PORTS_UDP</code>, or a user-defined resource.</p>", |
1353 | 1401 | "Resource$type": "<p>The type of the resource, such as <code>INTEGER</code>, <code>DOUBLE</code>, <code>LONG</code>, or <code>STRINGSET</code>.</p>", |
| 1402 | + "ResourceRequirement$value": "<p>The number of GPUs to assign to a container.</p>", |
1354 | 1403 | "RunTaskRequest$cluster": "<p>The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.</p>", |
1355 | 1404 | "RunTaskRequest$taskDefinition": "<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full ARN of the task definition to run. If a <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision is used.</p>", |
1356 | 1405 | "RunTaskRequest$startedBy": "<p>An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the <code>startedBy</code> parameter. You can then identify which tasks belong to that job by filtering the results of a <a>ListTasks</a> call with the <code>startedBy</code> value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.</p> <p>If a task is started by an Amazon ECS service, then the <code>startedBy</code> parameter contains the deployment ID of the service that starts it.</p>", |
|
0 commit comments