aws-sdk 2.1384.0 → 2.1385.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +9 -1
- package/README.md +1 -1
- package/apis/codepipeline-2015-07-09.min.json +3 -0
- package/apis/gamelift-2015-10-01.min.json +213 -204
- package/apis/glue-2017-03-31.min.json +615 -557
- package/apis/migration-hub-refactor-spaces-2021-10-26.min.json +9 -0
- package/apis/sagemaker-2017-07-24.min.json +627 -598
- package/clients/applicationautoscaling.d.ts +6 -6
- package/clients/codepipeline.d.ts +69 -65
- package/clients/gamelift.d.ts +22 -10
- package/clients/glue.d.ts +57 -2
- package/clients/migrationhubrefactorspaces.d.ts +16 -4
- package/clients/sagemaker.d.ts +33 -3
- package/dist/aws-sdk-core-react-native.js +1 -1
- package/dist/aws-sdk-react-native.js +6 -6
- package/dist/aws-sdk.js +219 -207
- package/dist/aws-sdk.min.js +55 -55
- package/lib/core.js +1 -1
- package/package.json +1 -1
@@ -388,7 +388,7 @@ declare namespace ApplicationAutoScaling {
|
|
388
388
|
export type MetricNamespace = string;
|
389
389
|
export type MetricScale = number;
|
390
390
|
export type MetricStatistic = "Average"|"Minimum"|"Maximum"|"SampleCount"|"Sum"|string;
|
391
|
-
export type MetricType = "DynamoDBReadCapacityUtilization"|"DynamoDBWriteCapacityUtilization"|"ALBRequestCountPerTarget"|"RDSReaderAverageCPUUtilization"|"RDSReaderAverageDatabaseConnections"|"EC2SpotFleetRequestAverageCPUUtilization"|"EC2SpotFleetRequestAverageNetworkIn"|"EC2SpotFleetRequestAverageNetworkOut"|"SageMakerVariantInvocationsPerInstance"|"ECSServiceAverageCPUUtilization"|"ECSServiceAverageMemoryUtilization"|"AppStreamAverageCapacityUtilization"|"ComprehendInferenceUtilization"|"LambdaProvisionedConcurrencyUtilization"|"CassandraReadCapacityUtilization"|"CassandraWriteCapacityUtilization"|"KafkaBrokerStorageUtilization"|"ElastiCachePrimaryEngineCPUUtilization"|"ElastiCacheReplicaEngineCPUUtilization"|"ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage"|"NeptuneReaderAverageCPUUtilization"|"SageMakerVariantProvisionedConcurrencyUtilization"|string;
|
391
|
+
export type MetricType = "DynamoDBReadCapacityUtilization"|"DynamoDBWriteCapacityUtilization"|"ALBRequestCountPerTarget"|"RDSReaderAverageCPUUtilization"|"RDSReaderAverageDatabaseConnections"|"EC2SpotFleetRequestAverageCPUUtilization"|"EC2SpotFleetRequestAverageNetworkIn"|"EC2SpotFleetRequestAverageNetworkOut"|"SageMakerVariantInvocationsPerInstance"|"ECSServiceAverageCPUUtilization"|"ECSServiceAverageMemoryUtilization"|"AppStreamAverageCapacityUtilization"|"ComprehendInferenceUtilization"|"LambdaProvisionedConcurrencyUtilization"|"CassandraReadCapacityUtilization"|"CassandraWriteCapacityUtilization"|"KafkaBrokerStorageUtilization"|"ElastiCachePrimaryEngineCPUUtilization"|"ElastiCacheReplicaEngineCPUUtilization"|"ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage"|"NeptuneReaderAverageCPUUtilization"|"SageMakerVariantProvisionedConcurrencyUtilization"|"ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage"|string;
|
392
392
|
export type MetricUnit = string;
|
393
393
|
export type MinAdjustmentMagnitude = number;
|
394
394
|
export interface NotScaledReason {
|
@@ -516,7 +516,7 @@ declare namespace ApplicationAutoScaling {
|
|
516
516
|
*/
|
517
517
|
ScalableDimension: ScalableDimension;
|
518
518
|
/**
|
519
|
-
* The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. This property is required when registering a new scalable target. For the following resources, the minimum value allowed is 0. AppStream 2.0 fleets Aurora DB clusters ECS services EMR clusters Lambda provisioned concurrency SageMaker Serverless endpoint provisioned concurrency
|
519
|
+
* The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. This property is required when registering a new scalable target. For the following resources, the minimum value allowed is 0. AppStream 2.0 fleets Aurora DB clusters ECS services EMR clusters Lambda provisioned concurrency SageMaker endpoint variants SageMaker Serverless endpoint provisioned concurrency Spot Fleets custom resources It's strongly recommended that you specify a value greater than 0. A value greater than 0 means that data points are continuously reported to CloudWatch that scaling policies can use to scale on a metric like average CPU utilization. For all other resources, the minimum allowed value depends on the type of resource that you are using. If you provide a value that is lower than what a resource can accept, an error occurs. In which case, the error message will provide the minimum value that the resource can accept.
|
520
520
|
*/
|
521
521
|
MinCapacity?: ResourceCapacity;
|
522
522
|
/**
|
@@ -754,7 +754,7 @@ declare namespace ApplicationAutoScaling {
|
|
754
754
|
*/
|
755
755
|
MetricIntervalUpperBound?: MetricScale;
|
756
756
|
/**
|
757
|
-
* The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a
|
757
|
+
* The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a non-negative value.
|
758
758
|
*/
|
759
759
|
ScalingAdjustment: ScalingAdjustment;
|
760
760
|
}
|
@@ -773,7 +773,7 @@ declare namespace ApplicationAutoScaling {
|
|
773
773
|
*/
|
774
774
|
MinAdjustmentMagnitude?: MinAdjustmentMagnitude;
|
775
775
|
/**
|
776
|
-
* The amount of time, in seconds, to wait for a previous scaling activity to take effect.
|
776
|
+
* The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.
|
777
777
|
*/
|
778
778
|
Cooldown?: Cooldown;
|
779
779
|
/**
|
@@ -892,11 +892,11 @@ declare namespace ApplicationAutoScaling {
|
|
892
892
|
*/
|
893
893
|
CustomizedMetricSpecification?: CustomizedMetricSpecification;
|
894
894
|
/**
|
895
|
-
* The amount of time, in seconds, to wait for a previous scale-out activity to take effect.
|
895
|
+
* The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
|
896
896
|
*/
|
897
897
|
ScaleOutCooldown?: Cooldown;
|
898
898
|
/**
|
899
|
-
* The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
|
899
|
+
* The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
|
900
900
|
*/
|
901
901
|
ScaleInCooldown?: Cooldown;
|
902
902
|
/**
|
@@ -28,11 +28,11 @@ declare class CodePipeline extends Service {
|
|
28
28
|
*/
|
29
29
|
acknowledgeThirdPartyJob(callback?: (err: AWSError, data: CodePipeline.Types.AcknowledgeThirdPartyJobOutput) => void): Request<CodePipeline.Types.AcknowledgeThirdPartyJobOutput, AWSError>;
|
30
30
|
/**
|
31
|
-
* Creates a new custom action that can be used in all pipelines associated with the
|
31
|
+
* Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.
|
32
32
|
*/
|
33
33
|
createCustomActionType(params: CodePipeline.Types.CreateCustomActionTypeInput, callback?: (err: AWSError, data: CodePipeline.Types.CreateCustomActionTypeOutput) => void): Request<CodePipeline.Types.CreateCustomActionTypeOutput, AWSError>;
|
34
34
|
/**
|
35
|
-
* Creates a new custom action that can be used in all pipelines associated with the
|
35
|
+
* Creates a new custom action that can be used in all pipelines associated with the Amazon Web Services account. Only used for custom actions.
|
36
36
|
*/
|
37
37
|
createCustomActionType(callback?: (err: AWSError, data: CodePipeline.Types.CreateCustomActionTypeOutput) => void): Request<CodePipeline.Types.CreateCustomActionTypeOutput, AWSError>;
|
38
38
|
/**
|
@@ -60,11 +60,11 @@ declare class CodePipeline extends Service {
|
|
60
60
|
*/
|
61
61
|
deletePipeline(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
62
62
|
/**
|
63
|
-
* Deletes a previously created webhook by name. Deleting the webhook stops
|
63
|
+
* Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
|
64
64
|
*/
|
65
65
|
deleteWebhook(params: CodePipeline.Types.DeleteWebhookInput, callback?: (err: AWSError, data: CodePipeline.Types.DeleteWebhookOutput) => void): Request<CodePipeline.Types.DeleteWebhookOutput, AWSError>;
|
66
66
|
/**
|
67
|
-
* Deletes a previously created webhook by name. Deleting the webhook stops
|
67
|
+
* Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
|
68
68
|
*/
|
69
69
|
deleteWebhook(callback?: (err: AWSError, data: CodePipeline.Types.DeleteWebhookOutput) => void): Request<CodePipeline.Types.DeleteWebhookOutput, AWSError>;
|
70
70
|
/**
|
@@ -100,11 +100,11 @@ declare class CodePipeline extends Service {
|
|
100
100
|
*/
|
101
101
|
getActionType(callback?: (err: AWSError, data: CodePipeline.Types.GetActionTypeOutput) => void): Request<CodePipeline.Types.GetActionTypeOutput, AWSError>;
|
102
102
|
/**
|
103
|
-
* Returns information about a job. Used for custom actions only. When this API is called,
|
103
|
+
* Returns information about a job. Used for custom actions only. When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
|
104
104
|
*/
|
105
105
|
getJobDetails(params: CodePipeline.Types.GetJobDetailsInput, callback?: (err: AWSError, data: CodePipeline.Types.GetJobDetailsOutput) => void): Request<CodePipeline.Types.GetJobDetailsOutput, AWSError>;
|
106
106
|
/**
|
107
|
-
* Returns information about a job. Used for custom actions only. When this API is called,
|
107
|
+
* Returns information about a job. Used for custom actions only. When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
|
108
108
|
*/
|
109
109
|
getJobDetails(callback?: (err: AWSError, data: CodePipeline.Types.GetJobDetailsOutput) => void): Request<CodePipeline.Types.GetJobDetailsOutput, AWSError>;
|
110
110
|
/**
|
@@ -132,11 +132,11 @@ declare class CodePipeline extends Service {
|
|
132
132
|
*/
|
133
133
|
getPipelineState(callback?: (err: AWSError, data: CodePipeline.Types.GetPipelineStateOutput) => void): Request<CodePipeline.Types.GetPipelineStateOutput, AWSError>;
|
134
134
|
/**
|
135
|
-
* Requests the details of a job for a third party action. Used for partner actions only. When this API is called,
|
135
|
+
* Requests the details of a job for a third party action. Used for partner actions only. When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
|
136
136
|
*/
|
137
137
|
getThirdPartyJobDetails(params: CodePipeline.Types.GetThirdPartyJobDetailsInput, callback?: (err: AWSError, data: CodePipeline.Types.GetThirdPartyJobDetailsOutput) => void): Request<CodePipeline.Types.GetThirdPartyJobDetailsOutput, AWSError>;
|
138
138
|
/**
|
139
|
-
* Requests the details of a job for a third party action. Used for partner actions only. When this API is called,
|
139
|
+
* Requests the details of a job for a third party action. Used for partner actions only. When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
|
140
140
|
*/
|
141
141
|
getThirdPartyJobDetails(callback?: (err: AWSError, data: CodePipeline.Types.GetThirdPartyJobDetailsOutput) => void): Request<CodePipeline.Types.GetThirdPartyJobDetailsOutput, AWSError>;
|
142
142
|
/**
|
@@ -148,11 +148,11 @@ declare class CodePipeline extends Service {
|
|
148
148
|
*/
|
149
149
|
listActionExecutions(callback?: (err: AWSError, data: CodePipeline.Types.ListActionExecutionsOutput) => void): Request<CodePipeline.Types.ListActionExecutionsOutput, AWSError>;
|
150
150
|
/**
|
151
|
-
* Gets a summary of all
|
151
|
+
* Gets a summary of all CodePipeline action types associated with your account.
|
152
152
|
*/
|
153
153
|
listActionTypes(params: CodePipeline.Types.ListActionTypesInput, callback?: (err: AWSError, data: CodePipeline.Types.ListActionTypesOutput) => void): Request<CodePipeline.Types.ListActionTypesOutput, AWSError>;
|
154
154
|
/**
|
155
|
-
* Gets a summary of all
|
155
|
+
* Gets a summary of all CodePipeline action types associated with your account.
|
156
156
|
*/
|
157
157
|
listActionTypes(callback?: (err: AWSError, data: CodePipeline.Types.ListActionTypesOutput) => void): Request<CodePipeline.Types.ListActionTypesOutput, AWSError>;
|
158
158
|
/**
|
@@ -180,43 +180,43 @@ declare class CodePipeline extends Service {
|
|
180
180
|
*/
|
181
181
|
listTagsForResource(callback?: (err: AWSError, data: CodePipeline.Types.ListTagsForResourceOutput) => void): Request<CodePipeline.Types.ListTagsForResourceOutput, AWSError>;
|
182
182
|
/**
|
183
|
-
* Gets a listing of all the webhooks in this
|
183
|
+
* Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
|
184
184
|
*/
|
185
185
|
listWebhooks(params: CodePipeline.Types.ListWebhooksInput, callback?: (err: AWSError, data: CodePipeline.Types.ListWebhooksOutput) => void): Request<CodePipeline.Types.ListWebhooksOutput, AWSError>;
|
186
186
|
/**
|
187
|
-
* Gets a listing of all the webhooks in this
|
187
|
+
* Gets a listing of all the webhooks in this Amazon Web Services Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.
|
188
188
|
*/
|
189
189
|
listWebhooks(callback?: (err: AWSError, data: CodePipeline.Types.ListWebhooksOutput) => void): Request<CodePipeline.Types.ListWebhooksOutput, AWSError>;
|
190
190
|
/**
|
191
|
-
* Returns information about any jobs for
|
191
|
+
* Returns information about any jobs for CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains AWS or ThirdParty in the owner field, the PollForJobs action returns an error. When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
|
192
192
|
*/
|
193
193
|
pollForJobs(params: CodePipeline.Types.PollForJobsInput, callback?: (err: AWSError, data: CodePipeline.Types.PollForJobsOutput) => void): Request<CodePipeline.Types.PollForJobsOutput, AWSError>;
|
194
194
|
/**
|
195
|
-
* Returns information about any jobs for
|
195
|
+
* Returns information about any jobs for CodePipeline to act on. PollForJobs is valid only for action types with "Custom" in the owner field. If the action type contains AWS or ThirdParty in the owner field, the PollForJobs action returns an error. When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
|
196
196
|
*/
|
197
197
|
pollForJobs(callback?: (err: AWSError, data: CodePipeline.Types.PollForJobsOutput) => void): Request<CodePipeline.Types.PollForJobsOutput, AWSError>;
|
198
198
|
/**
|
199
|
-
* Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only. When this API is called,
|
199
|
+
* Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only. When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
|
200
200
|
*/
|
201
201
|
pollForThirdPartyJobs(params: CodePipeline.Types.PollForThirdPartyJobsInput, callback?: (err: AWSError, data: CodePipeline.Types.PollForThirdPartyJobsOutput) => void): Request<CodePipeline.Types.PollForThirdPartyJobsOutput, AWSError>;
|
202
202
|
/**
|
203
|
-
* Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only. When this API is called,
|
203
|
+
* Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only. When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts.
|
204
204
|
*/
|
205
205
|
pollForThirdPartyJobs(callback?: (err: AWSError, data: CodePipeline.Types.PollForThirdPartyJobsOutput) => void): Request<CodePipeline.Types.PollForThirdPartyJobsOutput, AWSError>;
|
206
206
|
/**
|
207
|
-
* Provides information to
|
207
|
+
* Provides information to CodePipeline about new revisions to a source.
|
208
208
|
*/
|
209
209
|
putActionRevision(params: CodePipeline.Types.PutActionRevisionInput, callback?: (err: AWSError, data: CodePipeline.Types.PutActionRevisionOutput) => void): Request<CodePipeline.Types.PutActionRevisionOutput, AWSError>;
|
210
210
|
/**
|
211
|
-
* Provides information to
|
211
|
+
* Provides information to CodePipeline about new revisions to a source.
|
212
212
|
*/
|
213
213
|
putActionRevision(callback?: (err: AWSError, data: CodePipeline.Types.PutActionRevisionOutput) => void): Request<CodePipeline.Types.PutActionRevisionOutput, AWSError>;
|
214
214
|
/**
|
215
|
-
* Provides the response to a manual approval request to
|
215
|
+
* Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.
|
216
216
|
*/
|
217
217
|
putApprovalResult(params: CodePipeline.Types.PutApprovalResultInput, callback?: (err: AWSError, data: CodePipeline.Types.PutApprovalResultOutput) => void): Request<CodePipeline.Types.PutApprovalResultOutput, AWSError>;
|
218
218
|
/**
|
219
|
-
* Provides the response to a manual approval request to
|
219
|
+
* Provides the response to a manual approval request to CodePipeline. Valid responses include Approved and Rejected.
|
220
220
|
*/
|
221
221
|
putApprovalResult(callback?: (err: AWSError, data: CodePipeline.Types.PutApprovalResultOutput) => void): Request<CodePipeline.Types.PutApprovalResultOutput, AWSError>;
|
222
222
|
/**
|
@@ -300,11 +300,11 @@ declare class CodePipeline extends Service {
|
|
300
300
|
*/
|
301
301
|
tagResource(callback?: (err: AWSError, data: CodePipeline.Types.TagResourceOutput) => void): Request<CodePipeline.Types.TagResourceOutput, AWSError>;
|
302
302
|
/**
|
303
|
-
* Removes tags from an
|
303
|
+
* Removes tags from an Amazon Web Services resource.
|
304
304
|
*/
|
305
305
|
untagResource(params: CodePipeline.Types.UntagResourceInput, callback?: (err: AWSError, data: CodePipeline.Types.UntagResourceOutput) => void): Request<CodePipeline.Types.UntagResourceOutput, AWSError>;
|
306
306
|
/**
|
307
|
-
* Removes tags from an
|
307
|
+
* Removes tags from an Amazon Web Services resource.
|
308
308
|
*/
|
309
309
|
untagResource(callback?: (err: AWSError, data: CodePipeline.Types.UntagResourceOutput) => void): Request<CodePipeline.Types.UntagResourceOutput, AWSError>;
|
310
310
|
/**
|
@@ -348,7 +348,7 @@ declare namespace CodePipeline {
|
|
348
348
|
*/
|
349
349
|
jobId: JobId;
|
350
350
|
/**
|
351
|
-
* A system-generated random number that
|
351
|
+
* A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job.
|
352
352
|
*/
|
353
353
|
nonce: Nonce;
|
354
354
|
}
|
@@ -364,7 +364,7 @@ declare namespace CodePipeline {
|
|
364
364
|
*/
|
365
365
|
jobId: ThirdPartyJobId;
|
366
366
|
/**
|
367
|
-
* A system-generated random number that
|
367
|
+
* A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a GetThirdPartyJobDetails request.
|
368
368
|
*/
|
369
369
|
nonce: Nonce;
|
370
370
|
/**
|
@@ -445,7 +445,7 @@ declare namespace CodePipeline {
|
|
445
445
|
*/
|
446
446
|
runOrder?: ActionRunOrder;
|
447
447
|
/**
|
448
|
-
* The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the
|
448
|
+
* The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the CloudFormation action type in CodePipeline, see Configuration Properties Reference in the CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the CloudFormation User Guide. The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows: JSON: "Configuration" : { Key : Value },
|
449
449
|
*/
|
450
450
|
configuration?: ActionConfigurationMap;
|
451
451
|
/**
|
@@ -461,7 +461,7 @@ declare namespace CodePipeline {
|
|
461
461
|
*/
|
462
462
|
roleArn?: RoleArn;
|
463
463
|
/**
|
464
|
-
* The action declaration's
|
464
|
+
* The action declaration's Amazon Web Services Region, such as us-east-1.
|
465
465
|
*/
|
466
466
|
region?: AWSRegionName;
|
467
467
|
/**
|
@@ -499,7 +499,7 @@ declare namespace CodePipeline {
|
|
499
499
|
*/
|
500
500
|
externalExecutionId?: ExecutionId;
|
501
501
|
/**
|
502
|
-
* The URL of a resource external to
|
502
|
+
* The URL of a resource external to Amazon Web Services that is used when running the action (for example, an external repository URL).
|
503
503
|
*/
|
504
504
|
externalExecutionUrl?: Url;
|
505
505
|
/**
|
@@ -507,7 +507,7 @@ declare namespace CodePipeline {
|
|
507
507
|
*/
|
508
508
|
percentComplete?: Percentage;
|
509
509
|
/**
|
510
|
-
* The details of an error returned by a URL external to
|
510
|
+
* The details of an error returned by a URL external to Amazon Web Services.
|
511
511
|
*/
|
512
512
|
errorDetails?: ErrorDetails;
|
513
513
|
}
|
@@ -576,7 +576,7 @@ declare namespace CodePipeline {
|
|
576
576
|
*/
|
577
577
|
roleArn?: RoleArn;
|
578
578
|
/**
|
579
|
-
* The
|
579
|
+
* The Amazon Web Services Region for the action, such as us-east-1.
|
580
580
|
*/
|
581
581
|
region?: AWSRegionName;
|
582
582
|
/**
|
@@ -737,7 +737,7 @@ declare namespace CodePipeline {
|
|
737
737
|
*/
|
738
738
|
type: ExecutorType;
|
739
739
|
/**
|
740
|
-
* The policy statement that specifies the permissions in the CodePipeline customer
|
740
|
+
* The policy statement that specifies the permissions in the CodePipeline customer account that are needed to successfully run an action. To grant permission to another account, specify the account ID as the Principal, a domain-style identifier defined by the service, for example codepipeline.amazonaws.com. The size of the passed JSON policy document cannot exceed 2048 characters.
|
741
741
|
*/
|
742
742
|
policyStatementsTemplate?: PolicyStatementsTemplate;
|
743
743
|
/**
|
@@ -755,7 +755,7 @@ declare namespace CodePipeline {
|
|
755
755
|
*/
|
756
756
|
owner: ActionOwner;
|
757
757
|
/**
|
758
|
-
* The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of
|
758
|
+
* The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.
|
759
759
|
*/
|
760
760
|
provider: ActionProvider;
|
761
761
|
/**
|
@@ -785,7 +785,7 @@ declare namespace CodePipeline {
|
|
785
785
|
export type ActionTypeOwner = string;
|
786
786
|
export interface ActionTypePermissions {
|
787
787
|
/**
|
788
|
-
* A list of
|
788
|
+
* A list of Amazon Web Services account IDs with access to use the action type in their pipelines.
|
789
789
|
*/
|
790
790
|
allowedAccounts: AllowedAccounts;
|
791
791
|
}
|
@@ -822,15 +822,15 @@ declare namespace CodePipeline {
|
|
822
822
|
*/
|
823
823
|
thirdPartyConfigurationUrl?: Url;
|
824
824
|
/**
|
825
|
-
* The URL returned to the
|
825
|
+
* The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for a CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.
|
826
826
|
*/
|
827
827
|
entityUrlTemplate?: UrlTemplate;
|
828
828
|
/**
|
829
|
-
* The URL returned to the
|
829
|
+
* The URL returned to the CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for CodeDeploy. This link is shown on the pipeline view page in the CodePipeline console and provides a link to the execution entity of the external action.
|
830
830
|
*/
|
831
831
|
executionUrlTemplate?: UrlTemplate;
|
832
832
|
/**
|
833
|
-
* The URL returned to the
|
833
|
+
* The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.
|
834
834
|
*/
|
835
835
|
revisionUrlTemplate?: UrlTemplate;
|
836
836
|
}
|
@@ -929,7 +929,7 @@ declare namespace CodePipeline {
|
|
929
929
|
*/
|
930
930
|
revisionChangeIdentifier?: RevisionChangeIdentifier;
|
931
931
|
/**
|
932
|
-
* Summary information about the most recent revision of the artifact. For GitHub and
|
932
|
+
* Summary information about the most recent revision of the artifact. For GitHub and CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.
|
933
933
|
*/
|
934
934
|
revisionSummary?: RevisionSummary;
|
935
935
|
/**
|
@@ -937,7 +937,7 @@ declare namespace CodePipeline {
|
|
937
937
|
*/
|
938
938
|
created?: Timestamp;
|
939
939
|
/**
|
940
|
-
* The commit ID for the artifact revision. For artifacts stored in GitHub or
|
940
|
+
* The commit ID for the artifact revision. For artifacts stored in GitHub or CodeCommit repositories, the commit ID is linked to a commit details page.
|
941
941
|
*/
|
942
942
|
revisionUrl?: Url;
|
943
943
|
}
|
@@ -948,11 +948,11 @@ declare namespace CodePipeline {
|
|
948
948
|
*/
|
949
949
|
type: ArtifactStoreType;
|
950
950
|
/**
|
951
|
-
* The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same
|
951
|
+
* The S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any S3 bucket in the same Amazon Web Services Region as the pipeline to store your pipeline artifacts.
|
952
952
|
*/
|
953
953
|
location: ArtifactStoreLocation;
|
954
954
|
/**
|
955
|
-
* The encryption key used to encrypt the data in the artifact store, such as an
|
955
|
+
* The encryption key used to encrypt the data in the artifact store, such as an Amazon Web Services Key Management Service key. If this is undefined, the default key for Amazon S3 is used.
|
956
956
|
*/
|
957
957
|
encryptionKey?: EncryptionKey;
|
958
958
|
}
|
@@ -983,7 +983,7 @@ declare namespace CodePipeline {
|
|
983
983
|
*/
|
984
984
|
category: ActionCategory;
|
985
985
|
/**
|
986
|
-
* The provider of the service used in the custom action, such as
|
986
|
+
* The provider of the service used in the custom action, such as CodeDeploy.
|
987
987
|
*/
|
988
988
|
provider: ActionProvider;
|
989
989
|
/**
|
@@ -1065,7 +1065,7 @@ declare namespace CodePipeline {
|
|
1065
1065
|
*/
|
1066
1066
|
category: ActionCategory;
|
1067
1067
|
/**
|
1068
|
-
* The provider of the service used in the custom action, such as
|
1068
|
+
* The provider of the service used in the custom action, such as CodeDeploy.
|
1069
1069
|
*/
|
1070
1070
|
provider: ActionProvider;
|
1071
1071
|
/**
|
@@ -1132,11 +1132,11 @@ declare namespace CodePipeline {
|
|
1132
1132
|
export type Enabled = boolean;
|
1133
1133
|
export interface EncryptionKey {
|
1134
1134
|
/**
|
1135
|
-
* The ID used to identify the key. For an
|
1135
|
+
* The ID used to identify the key. For an Amazon Web Services KMS key, you can use the key ID, the key ARN, or the alias ARN. Aliases are recognized only in the account that created the KMS key. For cross-account actions, you can only use the key ID or key ARN to identify the key. Cross-account actions involve using the role from the other account (AccountB), so specifying the key ID will use the key from the other account (AccountB).
|
1136
1136
|
*/
|
1137
1137
|
id: EncryptionKeyId;
|
1138
1138
|
/**
|
1139
|
-
* The type of encryption key, such as an
|
1139
|
+
* The type of encryption key, such as an Amazon Web Services KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.
|
1140
1140
|
*/
|
1141
1141
|
type: EncryptionKeyType;
|
1142
1142
|
}
|
@@ -1158,7 +1158,7 @@ declare namespace CodePipeline {
|
|
1158
1158
|
*/
|
1159
1159
|
summary?: ExecutionSummary;
|
1160
1160
|
/**
|
1161
|
-
* The system-generated unique ID of this action used to identify this job worker in any external systems, such as
|
1161
|
+
* The system-generated unique ID of this action used to identify this job worker in any external systems, such as CodeDeploy.
|
1162
1162
|
*/
|
1163
1163
|
externalExecutionId?: ExecutionId;
|
1164
1164
|
/**
|
@@ -1260,7 +1260,7 @@ declare namespace CodePipeline {
|
|
1260
1260
|
}
|
1261
1261
|
export interface GetPipelineInput {
|
1262
1262
|
/**
|
1263
|
-
* The name of the pipeline for which you want to get information. Pipeline names must be unique
|
1263
|
+
* The name of the pipeline for which you want to get information. Pipeline names must be unique in an Amazon Web Services account.
|
1264
1264
|
*/
|
1265
1265
|
name: PipelineName;
|
1266
1266
|
/**
|
@@ -1324,7 +1324,7 @@ declare namespace CodePipeline {
|
|
1324
1324
|
}
|
1325
1325
|
export interface InputArtifact {
|
1326
1326
|
/**
|
1327
|
-
* The name of the artifact to be worked on (for example, "My App"). The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
|
1327
|
+
* The name of the artifact to be worked on (for example, "My App"). Artifacts are the files that are worked on by actions in the pipeline. See the action configuration for each action for details about artifact parameters. For example, the S3 source action input artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name: SampleApp_Windows.zip The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.
|
1328
1328
|
*/
|
1329
1329
|
name: ArtifactName;
|
1330
1330
|
}
|
@@ -1339,11 +1339,11 @@ declare namespace CodePipeline {
|
|
1339
1339
|
*/
|
1340
1340
|
data?: JobData;
|
1341
1341
|
/**
|
1342
|
-
* A system-generated random number that
|
1342
|
+
* A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeJob request.
|
1343
1343
|
*/
|
1344
1344
|
nonce?: Nonce;
|
1345
1345
|
/**
|
1346
|
-
* The ID of the
|
1346
|
+
* The ID of the Amazon Web Services account to use when performing the job.
|
1347
1347
|
*/
|
1348
1348
|
accountId?: AccountId;
|
1349
1349
|
}
|
@@ -1369,15 +1369,15 @@ declare namespace CodePipeline {
|
|
1369
1369
|
*/
|
1370
1370
|
outputArtifacts?: ArtifactList;
|
1371
1371
|
/**
|
1372
|
-
* Represents an
|
1372
|
+
* Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifacts for the pipeline in CodePipeline.
|
1373
1373
|
*/
|
1374
1374
|
artifactCredentials?: AWSSessionCredentials;
|
1375
1375
|
/**
|
1376
|
-
* A system-generated token, such as a
|
1376
|
+
* A system-generated token, such as a deployment ID, required by a job to continue the job asynchronously.
|
1377
1377
|
*/
|
1378
1378
|
continuationToken?: ContinuationToken;
|
1379
1379
|
/**
|
1380
|
-
* Represents information about the key used to encrypt data in the artifact store, such as an
|
1380
|
+
* Represents information about the key used to encrypt data in the artifact store, such as an KMS key.
|
1381
1381
|
*/
|
1382
1382
|
encryptionKey?: EncryptionKey;
|
1383
1383
|
}
|
@@ -1391,7 +1391,7 @@ declare namespace CodePipeline {
|
|
1391
1391
|
*/
|
1392
1392
|
data?: JobData;
|
1393
1393
|
/**
|
1394
|
-
* The
|
1394
|
+
* The Amazon Web Services account ID associated with the job.
|
1395
1395
|
*/
|
1396
1396
|
accountId?: AccountId;
|
1397
1397
|
}
|
@@ -1641,7 +1641,7 @@ declare namespace CodePipeline {
|
|
1641
1641
|
*/
|
1642
1642
|
name: PipelineName;
|
1643
1643
|
/**
|
1644
|
-
* The Amazon Resource Name (ARN) for
|
1644
|
+
* The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.
|
1645
1645
|
*/
|
1646
1646
|
roleArn: RoleArn;
|
1647
1647
|
/**
|
@@ -1649,7 +1649,7 @@ declare namespace CodePipeline {
|
|
1649
1649
|
*/
|
1650
1650
|
artifactStore?: ArtifactStore;
|
1651
1651
|
/**
|
1652
|
-
* A mapping of artifactStore objects and their corresponding
|
1652
|
+
* A mapping of artifactStore objects and their corresponding Amazon Web Services Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline. You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.
|
1653
1653
|
*/
|
1654
1654
|
artifactStores?: ArtifactStoreMap;
|
1655
1655
|
/**
|
@@ -1735,6 +1735,10 @@ declare namespace CodePipeline {
|
|
1735
1735
|
* The date and time the pipeline was last updated, in timestamp format.
|
1736
1736
|
*/
|
1737
1737
|
updated?: Timestamp;
|
1738
|
+
/**
|
1739
|
+
* The date and time that polling for source changes (periodic checks) was stopped for the pipeline, in timestamp format. You can migrate (update) a polling pipeline to use event-based change detection. For example, for a pipeline with a CodeCommit source, we recommend you migrate (update) your pipeline to use CloudWatch Events. To learn more, see Migrate polling pipelines to use event-based change detection in the CodePipeline User Guide.
|
1740
|
+
*/
|
1741
|
+
pollingDisabledAt?: Timestamp;
|
1738
1742
|
}
|
1739
1743
|
export type PipelineName = string;
|
1740
1744
|
export type PipelineStageDeclarationList = StageDeclaration[];
|
@@ -1873,7 +1877,7 @@ declare namespace CodePipeline {
|
|
1873
1877
|
*/
|
1874
1878
|
currentRevision?: CurrentRevision;
|
1875
1879
|
/**
|
1876
|
-
* A token generated by a job worker, such as
|
1880
|
+
* A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the custom action. When the action is complete, no continuation token should be supplied.
|
1877
1881
|
*/
|
1878
1882
|
continuationToken?: ContinuationToken;
|
1879
1883
|
/**
|
@@ -1913,7 +1917,7 @@ declare namespace CodePipeline {
|
|
1913
1917
|
*/
|
1914
1918
|
currentRevision?: CurrentRevision;
|
1915
1919
|
/**
|
1916
|
-
* A token generated by a job worker, such as
|
1920
|
+
* A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the partner action. When the action is complete, no continuation token should be supplied.
|
1917
1921
|
*/
|
1918
1922
|
continuationToken?: ContinuationToken;
|
1919
1923
|
/**
|
@@ -2013,11 +2017,11 @@ declare namespace CodePipeline {
|
|
2013
2017
|
*/
|
2014
2018
|
revisionId?: Revision;
|
2015
2019
|
/**
|
2016
|
-
* Summary information about the most recent revision of the artifact. For GitHub and
|
2020
|
+
* Summary information about the most recent revision of the artifact. For GitHub and CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.
|
2017
2021
|
*/
|
2018
2022
|
revisionSummary?: RevisionSummary;
|
2019
2023
|
/**
|
2020
|
-
* The commit ID for the artifact revision. For artifacts stored in GitHub or
|
2024
|
+
* The commit ID for the artifact revision. For artifacts stored in GitHub or CodeCommit repositories, the commit ID is linked to a commit details page.
|
2021
2025
|
*/
|
2022
2026
|
revisionUrl?: Url;
|
2023
2027
|
}
|
@@ -2158,7 +2162,7 @@ declare namespace CodePipeline {
|
|
2158
2162
|
*/
|
2159
2163
|
clientId?: ClientId;
|
2160
2164
|
/**
|
2161
|
-
* The identifier used to identify the job in
|
2165
|
+
* The identifier used to identify the job in CodePipeline.
|
2162
2166
|
*/
|
2163
2167
|
jobId?: JobId;
|
2164
2168
|
}
|
@@ -2184,21 +2188,21 @@ declare namespace CodePipeline {
|
|
2184
2188
|
*/
|
2185
2189
|
outputArtifacts?: ArtifactList;
|
2186
2190
|
/**
|
2187
|
-
* Represents an
|
2191
|
+
* Represents an Amazon Web Services session credentials object. These credentials are temporary credentials that are issued by Amazon Web Services Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifact for the pipeline in CodePipeline.
|
2188
2192
|
*/
|
2189
2193
|
artifactCredentials?: AWSSessionCredentials;
|
2190
2194
|
/**
|
2191
|
-
* A system-generated token, such as a
|
2195
|
+
* A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue the job asynchronously.
|
2192
2196
|
*/
|
2193
2197
|
continuationToken?: ContinuationToken;
|
2194
2198
|
/**
|
2195
|
-
* The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an
|
2199
|
+
* The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an Amazon Web Services Key Management Service (Amazon Web Services KMS) key. This is optional and might not be present.
|
2196
2200
|
*/
|
2197
2201
|
encryptionKey?: EncryptionKey;
|
2198
2202
|
}
|
2199
2203
|
export interface ThirdPartyJobDetails {
|
2200
2204
|
/**
|
2201
|
-
* The identifier used to identify the job details in
|
2205
|
+
* The identifier used to identify the job details in CodePipeline.
|
2202
2206
|
*/
|
2203
2207
|
id?: ThirdPartyJobId;
|
2204
2208
|
/**
|
@@ -2206,7 +2210,7 @@ declare namespace CodePipeline {
|
|
2206
2210
|
*/
|
2207
2211
|
data?: ThirdPartyJobData;
|
2208
2212
|
/**
|
2209
|
-
* A system-generated random number that
|
2213
|
+
* A system-generated random number that CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeThirdPartyJob request.
|
2210
2214
|
*/
|
2211
2215
|
nonce?: Nonce;
|
2212
2216
|
}
|
@@ -2315,7 +2319,7 @@ declare namespace CodePipeline {
|
|
2315
2319
|
*/
|
2316
2320
|
jsonPath: JsonPath;
|
2317
2321
|
/**
|
2318
|
-
* The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "
|
2322
|
+
* The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is "refs/heads/{Branch}" and the target action has an action configuration property called "Branch" with a value of "main", the MatchEquals value is evaluated as "refs/heads/main". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.
|
2319
2323
|
*/
|
2320
2324
|
matchEquals?: MatchEquals;
|
2321
2325
|
}
|