Skip to content

Commit

Permalink
docs(client-batch): Documentation-only update: clarified the descript…
Browse files Browse the repository at this point in the history 
…ion of the shareDecaySeconds parameter of the FairsharePolicy data type, clarified the description of the priority parameter of the JobQueueDetail data type.
  • Loading branch information
awstools committed Jan 21, 2025
1 parent 516e383 commit 0a9cbdd
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 10 deletions.
35 changes: 29 additions & 6 deletions clients/client-batch/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,7 @@ export interface LaunchTemplateSpecificationOverride {
version?: string | undefined;

/**
* <p>The instance type or family that this this override launch template should be applied to.</p>
* <p>The instance type or family that this override launch template should be applied to.</p>
* <p>This parameter is required when defining a launch template override.</p>
* <p>Information included in this parameter must meet the following requirements:</p>
* <ul>
Expand Down Expand Up @@ -1323,9 +1323,12 @@ export interface ShareAttributes {
export interface FairsharePolicy {
/**
* <p>The amount of time (in seconds) to use to calculate a fair share percentage for each fair
* share identifier in use. A value of zero (0) indicates that only current usage is measured. The
* decay allows for more recently run jobs to have more weight than jobs that ran earlier. The
* maximum supported value is 604800 (1 week).</p>
* share identifier in use. A value of zero (0) indicates the default minimum time window (600 seconds).
* The maximum supported value is 604800 (1 week).</p>
* <p>The decay allows for more recently run jobs to have more weight than jobs that ran earlier.
* Consider adjusting this number if you have jobs that (on average) run longer than ten minutes,
* or a large difference in job count or job run times between share identifiers, and the allocation
* of resources doesn’t meet your needs.</p>
* @public
*/
shareDecaySeconds?: number | undefined;
Expand Down Expand Up @@ -3018,7 +3021,7 @@ export interface TaskContainerProperties {
dependsOn?: TaskContainerDependency[] | undefined;

/**
* <p>The environment variables to pass to a container. This parameter maps to Env inthe <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a>
* <p>The environment variables to pass to a container. This parameter maps to Env in the <a href="https://docs.docker.com/engine/api/v1.23/#create-a-container">Create a container</a>
* section of the <a href="https://docs.docker.com/engine/api/v1.23/">Docker Remote API</a>
* and the <code>--env</code> parameter to <a href="https://docs.docker.com/engine/reference/run/">docker run</a>. </p>
* <important>
Expand Down Expand Up @@ -4462,7 +4465,27 @@ export interface JobQueueDetail {
statusReason?: string | undefined;

/**
* <p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>. All of the compute environments must be either Amazon EC2 (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>). Amazon EC2 and Fargate compute environments can't be mixed.</p>
* <p>The priority of the job queue. Job queue priority determines the order
* that job queues are evaluated when multiple queues dispatch jobs within a
* shared compute environment. A higher value for <code>priority</code> indicates
* a higher priority. Queues are evaluated in cycles, in descending order by
* priority. For example, a job queue with a priority value of <code>10</code> is
* evaluated before a queue with a priority value of <code>1</code>. All of the
* compute environments must be either Amazon EC2 (<code>EC2</code> or <code>SPOT</code>)
* or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>). Amazon EC2 and
* Fargate compute environments can't be mixed.</p>
* <note>
* <p>Job queue priority doesn't guarantee that a particular job executes before
* a job in a lower priority queue. Jobs added to higher priority queues during the
* queue evaluation cycle might not be evaluated until the next cycle. A job is
* dispatched from a queue only if resources are available when the queue is evaluated.
* If there are insufficient resources available at that time, the cycle proceeds to the
* next queue. This means that jobs added to higher priority queues might have to wait
* for jobs in multiple lower priority queues to complete before they are dispatched.
* You can use job dependencies to control the order for jobs from queues with different
* priorities. For more information, see <a href="https://docs.aws.amazon.com/batch/latest/userguide/job_dependencies.html">Job Dependencies</a>
* in the <i>Batch User Guide</i>.</p>
* </note>
* @public
*/
priority: number | undefined;
Expand Down
8 changes: 4 additions & 4 deletions codegen/sdk-codegen/aws-models/batch.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4867,7 +4867,7 @@
"shareDecaySeconds": {
"target": "com.amazonaws.batch#Integer",
"traits": {
"smithy.api#documentation": "<p>The amount of time (in seconds) to use to calculate a fair share percentage for each fair\n share identifier in use. A value of zero (0) indicates that only current usage is measured. The\n decay allows for more recently run jobs to have more weight than jobs that ran earlier. The\n maximum supported value is 604800 (1 week).</p>"
"smithy.api#documentation": "<p>The amount of time (in seconds) to use to calculate a fair share percentage for each fair\n share identifier in use. A value of zero (0) indicates the default minimum time window (600 seconds).\n The maximum supported value is 604800 (1 week).</p>\n <p>The decay allows for more recently run jobs to have more weight than jobs that ran earlier. \n Consider adjusting this number if you have jobs that (on average) run longer than ten minutes, \n or a large difference in job count or job run times between share identifiers, and the allocation\n of resources doesn’t meet your needs.</p>"
}
},
"computeReservation": {
Expand Down Expand Up @@ -5545,7 +5545,7 @@
"target": "com.amazonaws.batch#Integer",
"traits": {
"smithy.api#clientOptional": {},
"smithy.api#documentation": "<p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>. All of the compute environments must be either Amazon EC2 (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>). Amazon EC2 and Fargate compute environments can't be mixed.</p>",
"smithy.api#documentation": "<p>The priority of the job queue. Job queue priority determines the order \n that job queues are evaluated when multiple queues dispatch jobs within a \n shared compute environment. A higher value for <code>priority</code> indicates\n a higher priority. Queues are evaluated in cycles, in descending order by\n priority. For example, a job queue with a priority value of <code>10</code> is \n evaluated before a queue with a priority value of <code>1</code>. All of the \n compute environments must be either Amazon EC2 (<code>EC2</code> or <code>SPOT</code>)\n or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>). Amazon EC2 and \n Fargate compute environments can't be mixed.</p>\n <note>\n <p>Job queue priority doesn't guarantee that a particular job executes before \n a job in a lower priority queue. Jobs added to higher priority queues during the \n queue evaluation cycle might not be evaluated until the next cycle. A job is \n dispatched from a queue only if resources are available when the queue is evaluated. \n If there are insufficient resources available at that time, the cycle proceeds to the \n next queue. This means that jobs added to higher priority queues might have to wait \n for jobs in multiple lower priority queues to complete before they are dispatched. \n You can use job dependencies to control the order for jobs from queues with different \n priorities. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/job_dependencies.html\">Job Dependencies</a>\n in the <i>Batch User Guide</i>.</p>\n </note>",
"smithy.api#required": {}
}
},
Expand Down Expand Up @@ -5904,7 +5904,7 @@
"targetInstanceTypes": {
"target": "com.amazonaws.batch#StringList",
"traits": {
"smithy.api#documentation": "<p>The instance type or family that this this override launch template should be applied to.</p>\n <p>This parameter is required when defining a launch template override.</p>\n <p>Information included in this parameter must meet the following requirements:</p>\n <ul>\n <li>\n <p>Must be a valid Amazon EC2 instance type or family.</p>\n </li>\n <li>\n <p>\n <code>optimal</code> isn't allowed.</p>\n </li>\n <li>\n <p>\n <code>targetInstanceTypes</code> can target only instance types and families that are included within the <a href=\"https://docs.aws.amazon.com/batch/latest/APIReference/API_ComputeResource.html#Batch-Type-ComputeResource-instanceTypes\">\n <code>ComputeResource.instanceTypes</code>\n </a> set. <code>targetInstanceTypes</code> doesn't need to include all of the instances from the <code>instanceType</code> set, but at least a subset. For example, if <code>ComputeResource.instanceTypes</code> includes <code>[m5, g5]</code>, <code>targetInstanceTypes</code> can include <code>[m5.2xlarge]</code> and <code>[m5.large]</code> but not <code>[c5.large]</code>.</p>\n </li>\n <li>\n <p>\n <code>targetInstanceTypes</code> included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.</p>\n </li>\n </ul>"
"smithy.api#documentation": "<p>The instance type or family that this override launch template should be applied to.</p>\n <p>This parameter is required when defining a launch template override.</p>\n <p>Information included in this parameter must meet the following requirements:</p>\n <ul>\n <li>\n <p>Must be a valid Amazon EC2 instance type or family.</p>\n </li>\n <li>\n <p>\n <code>optimal</code> isn't allowed.</p>\n </li>\n <li>\n <p>\n <code>targetInstanceTypes</code> can target only instance types and families that are included within the <a href=\"https://docs.aws.amazon.com/batch/latest/APIReference/API_ComputeResource.html#Batch-Type-ComputeResource-instanceTypes\">\n <code>ComputeResource.instanceTypes</code>\n </a> set. <code>targetInstanceTypes</code> doesn't need to include all of the instances from the <code>instanceType</code> set, but at least a subset. For example, if <code>ComputeResource.instanceTypes</code> includes <code>[m5, g5]</code>, <code>targetInstanceTypes</code> can include <code>[m5.2xlarge]</code> and <code>[m5.large]</code> but not <code>[c5.large]</code>.</p>\n </li>\n <li>\n <p>\n <code>targetInstanceTypes</code> included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.</p>\n </li>\n </ul>"
}
}
},
Expand Down Expand Up @@ -7697,7 +7697,7 @@
"environment": {
"target": "com.amazonaws.batch#EnvironmentVariables",
"traits": {
"smithy.api#documentation": "<p>The environment variables to pass to a container. This parameter maps to Env inthe <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a>\n section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a>\n and the <code>--env</code> parameter to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. </p>\n <important>\n <p>We don't recommend using plaintext environment variables for sensitive information, such as\n credential data.</p>\n </important>\n <note>\n <p>Environment variables cannot start with <code>AWS_BATCH</code>. This naming convention is\n reserved for variables that Batch sets.</p>\n </note>"
"smithy.api#documentation": "<p>The environment variables to pass to a container. This parameter maps to Env in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a>\n section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a>\n and the <code>--env</code> parameter to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. </p>\n <important>\n <p>We don't recommend using plaintext environment variables for sensitive information, such as\n credential data.</p>\n </important>\n <note>\n <p>Environment variables cannot start with <code>AWS_BATCH</code>. This naming convention is\n reserved for variables that Batch sets.</p>\n </note>"
}
},
"essential": {
Expand Down

0 comments on commit 0a9cbdd

Please sign in to comment.