@aws-sdk/client-amplify 3.438.0 → 3.441.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.
Files changed (73) hide show
  1. package/README.md +2 -2
  2. package/dist-cjs/index.js +1 -0
  3. package/dist-cjs/pagination/Interfaces.js +2 -0
  4. package/dist-cjs/pagination/ListAppsPaginator.js +29 -0
  5. package/dist-cjs/pagination/ListBranchesPaginator.js +29 -0
  6. package/dist-cjs/pagination/ListDomainAssociationsPaginator.js +29 -0
  7. package/dist-cjs/pagination/ListJobsPaginator.js +29 -0
  8. package/dist-cjs/pagination/index.js +8 -0
  9. package/dist-cjs/protocols/Aws_restJson1.js +3 -0
  10. package/dist-es/index.js +1 -0
  11. package/dist-es/pagination/Interfaces.js +1 -0
  12. package/dist-es/pagination/ListAppsPaginator.js +25 -0
  13. package/dist-es/pagination/ListBranchesPaginator.js +25 -0
  14. package/dist-es/pagination/ListDomainAssociationsPaginator.js +25 -0
  15. package/dist-es/pagination/ListJobsPaginator.js +25 -0
  16. package/dist-es/pagination/index.js +5 -0
  17. package/dist-es/protocols/Aws_restJson1.js +3 -0
  18. package/dist-types/Amplify.d.ts +2 -2
  19. package/dist-types/AmplifyClient.d.ts +2 -2
  20. package/dist-types/commands/CreateAppCommand.d.ts +6 -6
  21. package/dist-types/commands/CreateBackendEnvironmentCommand.d.ts +6 -6
  22. package/dist-types/commands/CreateBranchCommand.d.ts +12 -6
  23. package/dist-types/commands/CreateDeploymentCommand.d.ts +9 -5
  24. package/dist-types/commands/CreateDomainAssociationCommand.d.ts +6 -6
  25. package/dist-types/commands/CreateWebhookCommand.d.ts +7 -7
  26. package/dist-types/commands/DeleteAppCommand.d.ts +6 -6
  27. package/dist-types/commands/DeleteBackendEnvironmentCommand.d.ts +6 -6
  28. package/dist-types/commands/DeleteBranchCommand.d.ts +8 -5
  29. package/dist-types/commands/DeleteDomainAssociationCommand.d.ts +5 -5
  30. package/dist-types/commands/DeleteJobCommand.d.ts +5 -5
  31. package/dist-types/commands/DeleteWebhookCommand.d.ts +6 -6
  32. package/dist-types/commands/GenerateAccessLogsCommand.d.ts +5 -5
  33. package/dist-types/commands/GetAppCommand.d.ts +5 -5
  34. package/dist-types/commands/GetArtifactUrlCommand.d.ts +6 -6
  35. package/dist-types/commands/GetBackendEnvironmentCommand.d.ts +5 -5
  36. package/dist-types/commands/GetBranchCommand.d.ts +7 -4
  37. package/dist-types/commands/GetDomainAssociationCommand.d.ts +4 -4
  38. package/dist-types/commands/GetJobCommand.d.ts +5 -5
  39. package/dist-types/commands/GetWebhookCommand.d.ts +6 -6
  40. package/dist-types/commands/ListAppsCommand.d.ts +4 -4
  41. package/dist-types/commands/ListArtifactsCommand.d.ts +5 -5
  42. package/dist-types/commands/ListBackendEnvironmentsCommand.d.ts +4 -4
  43. package/dist-types/commands/ListBranchesCommand.d.ts +6 -3
  44. package/dist-types/commands/ListDomainAssociationsCommand.d.ts +3 -3
  45. package/dist-types/commands/ListJobsCommand.d.ts +4 -4
  46. package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -4
  47. package/dist-types/commands/ListWebhooksCommand.d.ts +5 -5
  48. package/dist-types/commands/StartDeploymentCommand.d.ts +10 -6
  49. package/dist-types/commands/StartJobCommand.d.ts +5 -5
  50. package/dist-types/commands/StopJobCommand.d.ts +5 -5
  51. package/dist-types/commands/TagResourceCommand.d.ts +4 -4
  52. package/dist-types/commands/UntagResourceCommand.d.ts +4 -4
  53. package/dist-types/commands/UpdateAppCommand.d.ts +5 -5
  54. package/dist-types/commands/UpdateBranchCommand.d.ts +11 -5
  55. package/dist-types/commands/UpdateDomainAssociationCommand.d.ts +5 -5
  56. package/dist-types/commands/UpdateWebhookCommand.d.ts +6 -6
  57. package/dist-types/index.d.ts +3 -2
  58. package/dist-types/models/models_0.d.ts +277 -248
  59. package/dist-types/pagination/Interfaces.d.ts +8 -0
  60. package/dist-types/pagination/ListAppsPaginator.d.ts +7 -0
  61. package/dist-types/pagination/ListBranchesPaginator.d.ts +7 -0
  62. package/dist-types/pagination/ListDomainAssociationsPaginator.d.ts +7 -0
  63. package/dist-types/pagination/ListJobsPaginator.d.ts +7 -0
  64. package/dist-types/pagination/index.d.ts +5 -0
  65. package/dist-types/ts3.4/index.d.ts +1 -0
  66. package/dist-types/ts3.4/models/models_0.d.ts +6 -0
  67. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  68. package/dist-types/ts3.4/pagination/ListAppsPaginator.d.ts +11 -0
  69. package/dist-types/ts3.4/pagination/ListBranchesPaginator.d.ts +11 -0
  70. package/dist-types/ts3.4/pagination/ListDomainAssociationsPaginator.d.ts +11 -0
  71. package/dist-types/ts3.4/pagination/ListJobsPaginator.d.ts +11 -0
  72. package/dist-types/ts3.4/pagination/index.d.ts +5 -0
  73. package/package.json +4 -4
@@ -23,8 +23,12 @@ export interface StartDeploymentCommandOutput extends StartDeploymentResult, __M
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p> Starts a deployment for a manually deployed app. Manually deployed apps are not
26
+ * <p>Starts a deployment for a manually deployed app. Manually deployed apps are not
27
27
  * connected to a repository. </p>
28
+ * <p>The maximum duration between the <code>CreateDeployment</code> call and the
29
+ * <code>StartDeployment</code> call cannot exceed 8 hours. If the duration exceeds 8 hours, the
30
+ * <code>StartDeployment</code> call and the associated <code>Job</code> will
31
+ * fail.</p>
28
32
  * @example
29
33
  * Use a bare-bones client and the command you need to make an API call.
30
34
  * ```javascript
@@ -62,19 +66,19 @@ export interface StartDeploymentCommandOutput extends StartDeploymentResult, __M
62
66
  * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape.
63
67
  *
64
68
  * @throws {@link BadRequestException} (client fault)
65
- * <p> A request contains unexpected data. </p>
69
+ * <p>A request contains unexpected data. </p>
66
70
  *
67
71
  * @throws {@link InternalFailureException} (server fault)
68
- * <p> The service failed to perform an operation due to an internal issue. </p>
72
+ * <p>The service failed to perform an operation due to an internal issue. </p>
69
73
  *
70
74
  * @throws {@link LimitExceededException} (client fault)
71
- * <p> A resource could not be created because service quotas were exceeded. </p>
75
+ * <p>A resource could not be created because service quotas were exceeded. </p>
72
76
  *
73
77
  * @throws {@link NotFoundException} (client fault)
74
- * <p> An entity was not found during an operation. </p>
78
+ * <p>An entity was not found during an operation. </p>
75
79
  *
76
80
  * @throws {@link UnauthorizedException} (client fault)
77
- * <p> An operation failed due to a lack of access. </p>
81
+ * <p>An operation failed due to a lack of access. </p>
78
82
  *
79
83
  * @throws {@link AmplifyServiceException}
80
84
  * <p>Base exception class for all service exceptions from Amplify service.</p>
@@ -65,19 +65,19 @@ export interface StartJobCommandOutput extends StartJobResult, __MetadataBearer
65
65
  * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape.
66
66
  *
67
67
  * @throws {@link BadRequestException} (client fault)
68
- * <p> A request contains unexpected data. </p>
68
+ * <p>A request contains unexpected data. </p>
69
69
  *
70
70
  * @throws {@link InternalFailureException} (server fault)
71
- * <p> The service failed to perform an operation due to an internal issue. </p>
71
+ * <p>The service failed to perform an operation due to an internal issue. </p>
72
72
  *
73
73
  * @throws {@link LimitExceededException} (client fault)
74
- * <p> A resource could not be created because service quotas were exceeded. </p>
74
+ * <p>A resource could not be created because service quotas were exceeded. </p>
75
75
  *
76
76
  * @throws {@link NotFoundException} (client fault)
77
- * <p> An entity was not found during an operation. </p>
77
+ * <p>An entity was not found during an operation. </p>
78
78
  *
79
79
  * @throws {@link UnauthorizedException} (client fault)
80
- * <p> An operation failed due to a lack of access. </p>
80
+ * <p>An operation failed due to a lack of access. </p>
81
81
  *
82
82
  * @throws {@link AmplifyServiceException}
83
83
  * <p>Base exception class for all service exceptions from Amplify service.</p>
@@ -60,19 +60,19 @@ export interface StopJobCommandOutput extends StopJobResult, __MetadataBearer {
60
60
  * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape.
61
61
  *
62
62
  * @throws {@link BadRequestException} (client fault)
63
- * <p> A request contains unexpected data. </p>
63
+ * <p>A request contains unexpected data. </p>
64
64
  *
65
65
  * @throws {@link InternalFailureException} (server fault)
66
- * <p> The service failed to perform an operation due to an internal issue. </p>
66
+ * <p>The service failed to perform an operation due to an internal issue. </p>
67
67
  *
68
68
  * @throws {@link LimitExceededException} (client fault)
69
- * <p> A resource could not be created because service quotas were exceeded. </p>
69
+ * <p>A resource could not be created because service quotas were exceeded. </p>
70
70
  *
71
71
  * @throws {@link NotFoundException} (client fault)
72
- * <p> An entity was not found during an operation. </p>
72
+ * <p>An entity was not found during an operation. </p>
73
73
  *
74
74
  * @throws {@link UnauthorizedException} (client fault)
75
- * <p> An operation failed due to a lack of access. </p>
75
+ * <p>An operation failed due to a lack of access. </p>
76
76
  *
77
77
  * @throws {@link AmplifyServiceException}
78
78
  * <p>Base exception class for all service exceptions from Amplify service.</p>
@@ -23,7 +23,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p> Tags the resource with a tag key and value. </p>
26
+ * <p>Tags the resource with a tag key and value.</p>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
29
29
  * ```javascript
@@ -49,13 +49,13 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
49
49
  * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape.
50
50
  *
51
51
  * @throws {@link BadRequestException} (client fault)
52
- * <p> A request contains unexpected data. </p>
52
+ * <p>A request contains unexpected data. </p>
53
53
  *
54
54
  * @throws {@link InternalFailureException} (server fault)
55
- * <p> The service failed to perform an operation due to an internal issue. </p>
55
+ * <p>The service failed to perform an operation due to an internal issue. </p>
56
56
  *
57
57
  * @throws {@link ResourceNotFoundException} (client fault)
58
- * <p> An operation failed due to a non-existent resource. </p>
58
+ * <p>An operation failed due to a non-existent resource. </p>
59
59
  *
60
60
  * @throws {@link AmplifyServiceException}
61
61
  * <p>Base exception class for all service exceptions from Amplify service.</p>
@@ -23,7 +23,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p> Untags a resource with a specified Amazon Resource Name (ARN). </p>
26
+ * <p>Untags a resource with a specified Amazon Resource Name (ARN).</p>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
29
29
  * ```javascript
@@ -49,13 +49,13 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
49
49
  * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape.
50
50
  *
51
51
  * @throws {@link BadRequestException} (client fault)
52
- * <p> A request contains unexpected data. </p>
52
+ * <p>A request contains unexpected data. </p>
53
53
  *
54
54
  * @throws {@link InternalFailureException} (server fault)
55
- * <p> The service failed to perform an operation due to an internal issue. </p>
55
+ * <p>The service failed to perform an operation due to an internal issue. </p>
56
56
  *
57
57
  * @throws {@link ResourceNotFoundException} (client fault)
58
- * <p> An operation failed due to a non-existent resource. </p>
58
+ * <p>An operation failed due to a non-existent resource. </p>
59
59
  *
60
60
  * @throws {@link AmplifyServiceException}
61
61
  * <p>Base exception class for all service exceptions from Amplify service.</p>
@@ -23,7 +23,7 @@ export interface UpdateAppCommandOutput extends UpdateAppResult, __MetadataBeare
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p> Updates an existing Amplify app. </p>
26
+ * <p>Updates an existing Amplify app. </p>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
29
29
  * ```javascript
@@ -146,16 +146,16 @@ export interface UpdateAppCommandOutput extends UpdateAppResult, __MetadataBeare
146
146
  * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape.
147
147
  *
148
148
  * @throws {@link BadRequestException} (client fault)
149
- * <p> A request contains unexpected data. </p>
149
+ * <p>A request contains unexpected data. </p>
150
150
  *
151
151
  * @throws {@link InternalFailureException} (server fault)
152
- * <p> The service failed to perform an operation due to an internal issue. </p>
152
+ * <p>The service failed to perform an operation due to an internal issue. </p>
153
153
  *
154
154
  * @throws {@link NotFoundException} (client fault)
155
- * <p> An entity was not found during an operation. </p>
155
+ * <p>An entity was not found during an operation. </p>
156
156
  *
157
157
  * @throws {@link UnauthorizedException} (client fault)
158
- * <p> An operation failed due to a lack of access. </p>
158
+ * <p>An operation failed due to a lack of access. </p>
159
159
  *
160
160
  * @throws {@link AmplifyServiceException}
161
161
  * <p>Base exception class for all service exceptions from Amplify service.</p>
@@ -50,6 +50,9 @@ export interface UpdateBranchCommandOutput extends UpdateBranchResult, __Metadat
50
50
  * enablePullRequestPreview: true || false,
51
51
  * pullRequestEnvironmentName: "STRING_VALUE",
52
52
  * backendEnvironmentArn: "STRING_VALUE",
53
+ * backend: { // Backend
54
+ * stackArn: "STRING_VALUE",
55
+ * },
53
56
  * };
54
57
  * const command = new UpdateBranchCommand(input);
55
58
  * const response = await client.send(command);
@@ -90,6 +93,9 @@ export interface UpdateBranchCommandOutput extends UpdateBranchResult, __Metadat
90
93
  * // destinationBranch: "STRING_VALUE",
91
94
  * // sourceBranch: "STRING_VALUE",
92
95
  * // backendEnvironmentArn: "STRING_VALUE",
96
+ * // backend: { // Backend
97
+ * // stackArn: "STRING_VALUE",
98
+ * // },
93
99
  * // },
94
100
  * // };
95
101
  *
@@ -102,19 +108,19 @@ export interface UpdateBranchCommandOutput extends UpdateBranchResult, __Metadat
102
108
  * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape.
103
109
  *
104
110
  * @throws {@link BadRequestException} (client fault)
105
- * <p> A request contains unexpected data. </p>
111
+ * <p>A request contains unexpected data. </p>
106
112
  *
107
113
  * @throws {@link DependentServiceFailureException} (server fault)
108
- * <p> An operation failed because a dependent service threw an exception. </p>
114
+ * <p>An operation failed because a dependent service threw an exception. </p>
109
115
  *
110
116
  * @throws {@link InternalFailureException} (server fault)
111
- * <p> The service failed to perform an operation due to an internal issue. </p>
117
+ * <p>The service failed to perform an operation due to an internal issue. </p>
112
118
  *
113
119
  * @throws {@link NotFoundException} (client fault)
114
- * <p> An entity was not found during an operation. </p>
120
+ * <p>An entity was not found during an operation. </p>
115
121
  *
116
122
  * @throws {@link UnauthorizedException} (client fault)
117
- * <p> An operation failed due to a lack of access. </p>
123
+ * <p>An operation failed due to a lack of access. </p>
118
124
  *
119
125
  * @throws {@link AmplifyServiceException}
120
126
  * <p>Base exception class for all service exceptions from Amplify service.</p>
@@ -81,19 +81,19 @@ export interface UpdateDomainAssociationCommandOutput extends UpdateDomainAssoci
81
81
  * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape.
82
82
  *
83
83
  * @throws {@link BadRequestException} (client fault)
84
- * <p> A request contains unexpected data. </p>
84
+ * <p>A request contains unexpected data. </p>
85
85
  *
86
86
  * @throws {@link DependentServiceFailureException} (server fault)
87
- * <p> An operation failed because a dependent service threw an exception. </p>
87
+ * <p>An operation failed because a dependent service threw an exception. </p>
88
88
  *
89
89
  * @throws {@link InternalFailureException} (server fault)
90
- * <p> The service failed to perform an operation due to an internal issue. </p>
90
+ * <p>The service failed to perform an operation due to an internal issue. </p>
91
91
  *
92
92
  * @throws {@link NotFoundException} (client fault)
93
- * <p> An entity was not found during an operation. </p>
93
+ * <p>An entity was not found during an operation. </p>
94
94
  *
95
95
  * @throws {@link UnauthorizedException} (client fault)
96
- * <p> An operation failed due to a lack of access. </p>
96
+ * <p>An operation failed due to a lack of access. </p>
97
97
  *
98
98
  * @throws {@link AmplifyServiceException}
99
99
  * <p>Base exception class for all service exceptions from Amplify service.</p>
@@ -23,7 +23,7 @@ export interface UpdateWebhookCommandOutput extends UpdateWebhookResult, __Metad
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p> Updates a webhook. </p>
26
+ * <p>Updates a webhook. </p>
27
27
  * @example
28
28
  * Use a bare-bones client and the command you need to make an API call.
29
29
  * ```javascript
@@ -58,19 +58,19 @@ export interface UpdateWebhookCommandOutput extends UpdateWebhookResult, __Metad
58
58
  * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape.
59
59
  *
60
60
  * @throws {@link BadRequestException} (client fault)
61
- * <p> A request contains unexpected data. </p>
61
+ * <p>A request contains unexpected data. </p>
62
62
  *
63
63
  * @throws {@link DependentServiceFailureException} (server fault)
64
- * <p> An operation failed because a dependent service threw an exception. </p>
64
+ * <p>An operation failed because a dependent service threw an exception. </p>
65
65
  *
66
66
  * @throws {@link InternalFailureException} (server fault)
67
- * <p> The service failed to perform an operation due to an internal issue. </p>
67
+ * <p>The service failed to perform an operation due to an internal issue. </p>
68
68
  *
69
69
  * @throws {@link NotFoundException} (client fault)
70
- * <p> An entity was not found during an operation. </p>
70
+ * <p>An entity was not found during an operation. </p>
71
71
  *
72
72
  * @throws {@link UnauthorizedException} (client fault)
73
- * <p> An operation failed due to a lack of access. </p>
73
+ * <p>An operation failed due to a lack of access. </p>
74
74
  *
75
75
  * @throws {@link AmplifyServiceException}
76
76
  * <p>Base exception class for all service exceptions from Amplify service.</p>
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * <p>Amplify enables developers to develop and deploy cloud-powered mobile and web apps.
3
- * The Amplify Console provides a continuous delivery and hosting service for web
4
- * applications. For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Console User Guide</a>. The
3
+ * Amplify Hosting provides a continuous delivery and hosting service for web
4
+ * applications. For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Hosting User Guide</a>. The
5
5
  * Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation
6
6
  * for client app development. For more information, see the <a href="https://docs.amplify.aws/">Amplify Framework.</a>
7
7
  * </p>
@@ -12,6 +12,7 @@ export * from "./AmplifyClient";
12
12
  export * from "./Amplify";
13
13
  export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
14
14
  export * from "./commands";
15
+ export * from "./pagination";
15
16
  export * from "./models";
16
17
  import "@aws-sdk/util-endpoints";
17
18
  export { AmplifyServiceException } from "./models/AmplifyServiceException";