AWS aws-sdk-php documentation change
Summary
Added documentation for new consumable resource management features in AWS Batch, including CreateConsumableResource, DeleteConsumableResource, DescribeConsumableResource, ListConsumableResources, ListJobsByConsumableResource, and UpdateConsumableResource operations. Also updated fair-share scheduling terminology to 'fair share scheduling' and added consumable resource properties to job definitions and job submissions.
Security assessment
The changes introduce new features for managing consumable resources in AWS Batch and update terminology related to scheduling policies. There is no indication of security vulnerabilities being addressed or new security features being documented.
Diff
diff --git a/aws-sdk-php/v3/api/api-batch-2016-08-10.md index ef82cc810..0c149a92e 100644 --- a/aws-sdk-php/v3/api/api-batch-2016-08-10.md +++ b/aws-sdk-php/v3/api/api-batch-2016-08-10.md @@ -472,0 +473 @@ You can also create and send a command immediately using the magic methods avail +**CreateConsumableResource** ( array $params = [] ) Creates an Batch consumable resource. @@ -475,0 +477 @@ You can also create and send a command immediately using the magic methods avail +**DeleteConsumableResource** ( array $params = [] ) Deletes the specified consumable resource. @@ -479,0 +482 @@ You can also create and send a command immediately using the magic methods avail +**DescribeConsumableResource** ( array $params = [] ) Returns a description of the specified consumable resource. @@ -484,0 +488 @@ You can also create and send a command immediately using the magic methods avail +**ListConsumableResources** ( array $params = [] ) Returns a list of Batch consumable resources. @@ -485,0 +490 @@ You can also create and send a command immediately using the magic methods avail +**ListJobsByConsumableResource** ( array $params = [] ) Returns a list of Batch jobs that require a specific consumable resource. @@ -493,0 +499 @@ You can also create and send a command immediately using the magic methods avail +**UpdateConsumableResource** ( array $params = [] ) Updates a consumable resource. @@ -503,0 +510 @@ Paginators handle automatically iterating over paginated API results. Paginators +**ListConsumableResources** @@ -504,0 +512 @@ Paginators handle automatically iterating over paginated API results. Paginators +**ListJobsByConsumableResource** @@ -777 +785 @@ The type of the compute environment: `MANAGED` or `UNMANAGED`. For more informat -The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair-share job queue, no vCPU capacity is reserved. +The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved. @@ -908,0 +917,123 @@ Result syntax: +### CreateConsumableResource + + + $result = $client->createConsumableResource([/* ... */]); + $promise = $client->createConsumableResourceAsync([/* ... */]); + + +Creates an Batch consumable resource. + +#### Parameter Syntax + + + $result = $client->createConsumableResource([ + 'consumableResourceName' => '<string>', // REQUIRED + 'resourceType' => '<string>', + 'tags' => ['<string>', ...], + 'totalQuantity' => <integer>, + ]); + + +#### Parameter Details + +##### Members + +**consumableResourceName** + + + **Required** : _Yes_ + **Type:** _string_ + +The name of the consumable resource. Must be unique. + +**resourceType** + + + **Type:** _string_ + +Indicates whether the resource is available to be re-used after a job completes. Can be one of: + + * `REPLENISHABLE` (default) + + * `NON_REPLENISHABLE` + + + + +**tags** + + + **Type:** _Associative array of custom strings keys (TagKey) to strings_ + +The tags that you apply to the consumable resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see [Tagging your Batch resources](https://docs.aws.amazon.com/batch/latest/userguide/using-tags.html). + +**totalQuantity** + + + **Type:** _long (int|float)_ + +The total amount of the consumable resource that is available. Must be non-negative. + +#### Result Syntax + + + [ + 'consumableResourceArn' => '<string>', + 'consumableResourceName' => '<string>', + ] + +#### Result Details + +##### Members + +**consumableResourceArn** + + + **Required** : _Yes_ + **Type:** _string_ + +The Amazon Resource Name (ARN) of the consumable resource. + +**consumableResourceName** + + + **Required** : _Yes_ + **Type:** _string_ + +The name of the consumable resource. + +#### Errors + +[**ClientException:**](class-Aws.Batch.Exception.BatchException.html#shape-clientexception) + +These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid. + +[**ServerException:**](class-Aws.Batch.Exception.BatchException.html#shape-serverexception) + +These errors are usually caused by a server issue. + +#### Examples + +##### Example 1: To create a consumable resource + +Creates a Batch consumable resource. + + + $result = $client->createConsumableResource([ + 'consumableResourceName' => 'myConsumableResource', + 'resourceType' => 'REPLENISHABLE', + 'tags' => [ + 'Department' => 'Engineering', + 'User' => 'JaneDoe', + ], + 'totalQuantity' => 123, + ]); + +Result syntax: + + + [ + 'consumableResourceArn' => 'arn:aws:batch:us-east-1:012345678910:consumable-resource/myConsumableResource', + 'consumableResourceName' => 'myConsumableResource', + ] + @@ -990 +1121 @@ The priority of the job queue. Job queues with a higher priority (or a higher in -The Amazon Resource Name (ARN) of the fair-share scheduling policy. Job queues that don't have a fair-share scheduling policy are scheduled in a first-in, first-out (FIFO) model. After a job queue has a fair-share scheduling policy, it can be replaced but can't be removed. +The Amazon Resource Name (ARN) of the fair share scheduling policy. Job queues that don't have a scheduling policy are scheduled in a first-in, first-out (FIFO) model. After a job queue has a scheduling policy, it can be replaced but can't be removed. @@ -996 +1127 @@ An example is `aws:aws:batch:us-west-2:123456789012:scheduling-policy/MyScheduli -A job queue without a fair-share scheduling policy is scheduled as a FIFO job queue and can't have a fair-share scheduling policy added. Jobs queues with a fair-share scheduling policy can have a maximum of 500 active share identifiers. When the limit has been reached, submissions of any jobs that add a new share identifier fail. +A job queue without a scheduling policy is scheduled as a FIFO job queue and can't have a scheduling policy added. Jobs queues with a scheduling policy can have a maximum of 500 active fair share identifiers. When the limit has been reached, submissions of any jobs that add a new fair share identifier fail. @@ -1144 +1275 @@ Creates an Batch scheduling policy. -The fair-share scheduling policy details. +The fair share policy of the scheduling policy. @@ -1152 +1283 @@ The fair-share scheduling policy details. -The name of the fair-share scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). +The name of the scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). @@ -1264,0 +1396,65 @@ Result syntax: + [ + ] + +### DeleteConsumableResource + + + $result = $client->deleteConsumableResource([/* ... */]); + $promise = $client->deleteConsumableResourceAsync([/* ... */]); + + +Deletes the specified consumable resource. + +#### Parameter Syntax + + + $result = $client->deleteConsumableResource([ + 'consumableResource' => '<string>', // REQUIRED + ]); + + +#### Parameter Details + +##### Members + +**consumableResource** + + + **Required** : _Yes_ + **Type:** _string_ + +The name or ARN of the consumable resource that will be deleted. + +#### Result Syntax + + + [] + +#### Result Details + +The results for this operation are always empty.