You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Sources/Services/AWSAmplify/AmplifyClient.swift
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -199,7 +199,7 @@ extension AmplifyClient {
199
199
200
200
/// Performs the `CreateBackendEnvironment` operation on the `Amplify` service.
201
201
///
202
-
/// Creates a new backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
202
+
/// Creates a new backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
203
203
///
204
204
/// - Parameter CreateBackendEnvironmentInput : The request structure for the backend environment create request.
205
205
///
@@ -510,7 +510,7 @@ extension AmplifyClient {
510
510
511
511
/// Performs the `DeleteBackendEnvironment` operation on the `Amplify` service.
512
512
///
513
-
/// Deletes a backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
513
+
/// Deletes a backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
514
514
///
515
515
/// - Parameter DeleteBackendEnvironmentInput : The request structure for the delete backend environment request.
516
516
///
@@ -903,7 +903,7 @@ extension AmplifyClient {
903
903
904
904
/// Performs the `GetBackendEnvironment` operation on the `Amplify` service.
905
905
///
906
-
/// Returns a backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
906
+
/// Returns a backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
907
907
///
908
908
/// - Parameter GetBackendEnvironmentInput : The request structure for the get backend environment request.
909
909
///
@@ -1242,7 +1242,7 @@ extension AmplifyClient {
1242
1242
1243
1243
/// Performs the `ListBackendEnvironments` operation on the `Amplify` service.
1244
1244
///
1245
-
/// Lists the backend environments for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend was created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to applications created using the Amplify Gen 2 public preview. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
1245
+
/// Lists the backend environments for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
1246
1246
///
1247
1247
/// - Parameter ListBackendEnvironmentsInput : The request structure for the list backend environments request.
/// Describes the backend properties associated with an Amplify Branch.
310
+
/// Describes the backend associated with an Amplify Branch. This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
311
311
publicstructBackend{
312
312
/// The Amazon Resource Name (ARN) for the CloudFormation stack.
/// Describes the backend environment for an Amplify app.
341
+
/// Describes the backend environment associated with a Branch of a Gen 1 Amplify app. Amplify Gen 1 applications are created using Amplify Studio or the Amplify command line interface (CLI).
342
342
publicstructBackendEnvironment{
343
343
/// The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
/// A list of custom resources that are linked to this branch.
466
466
publicvarassociatedResources:[Swift.String]?
467
-
/// Describes the backend properties associated with an Amplify Branch.
467
+
/// Describes the backend associated with an Amplify Branch. This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
468
468
publicvarbackend:AmplifyClientTypes.Backend?
469
-
/// The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
469
+
/// The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
470
470
publicvarbackendEnvironmentArn:Swift.String?
471
471
/// The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
472
472
publicvarbasicAuthCredentials:Swift.String?
@@ -996,9 +996,9 @@ public struct CreateBranchInput {
996
996
/// The unique ID for an Amplify app.
997
997
/// This member is required.
998
998
publicvarappId:Swift.String?
999
-
/// The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.
999
+
/// The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack. This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
1000
1000
publicvarbackend:AmplifyClientTypes.Backend?
1001
-
/// The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
1001
+
/// The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app. This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).
1002
1002
publicvarbackendEnvironmentArn:Swift.String?
1003
1003
/// The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.
1004
1004
publicvarbasicAuthCredentials:Swift.String?
@@ -4771,9 +4771,9 @@ public struct UpdateBranchInput {
4771
4771
/// The unique ID for an Amplify app.
4772
4772
/// This member is required.
4773
4773
publicvarappId:Swift.String?
4774
-
/// The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.
4774
+
/// The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack. This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
4775
4775
publicvarbackend:AmplifyClientTypes.Backend?
4776
-
/// The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
4776
+
/// The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app. This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).
4777
4777
publicvarbackendEnvironmentArn:Swift.String?
4778
4778
/// The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.
Copy file name to clipboardExpand all lines: Sources/Services/AWSAthena/AthenaClient.swift
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1661,7 +1661,7 @@ extension AthenaClient {
1661
1661
1662
1662
/// Performs the `GetQueryRuntimeStatistics` operation on the `AmazonAthena` service.
1663
1663
///
1664
-
/// Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Query execution runtime statistics are returned only when [QueryExecutionStatus$State] is in a SUCCEEDED or FAILED state. Stage-level input and output row count and data sizestatistics are not shown when a query has row-level filters defined in Lake Formation.
1664
+
/// Returns query execution runtime statistics related to a single execution of a query if you have access to the workgroup in which the query ran. Statistics from the Timeline section of the response object are available as soon as [QueryExecutionStatus$State] is in a SUCCEEDED or FAILED state. The remaining non-timeline statistics in the response (like stage-level input and output row count and data size) are updated asynchronously and may not be available immediately after a query completes. The non-timeline statistics are also not included when a query has row-level filters defined in Lake Formation.
/// The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by [ResultConfiguration$OutputLocation]. If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See [WorkGroupConfiguration$EnforceWorkGroupConfiguration] and [Workgroup Settings Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html).
6324
6324
publicvarexpectedBucketOwner:Swift.String?
6325
-
/// The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using [WorkGroupConfiguration]. If none of them is set, Athena issues an error that no output location is provided. For more information, see [Working with query results, recent queries, and output files](https://docs.aws.amazon.com/athena/latest/ug/querying.html). If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See [WorkGroupConfiguration$EnforceWorkGroupConfiguration].
6325
+
/// The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using [WorkGroupConfiguration]. If none of them is set, Athena issues an error that no output location is provided. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See [WorkGroupConfiguration$EnforceWorkGroupConfiguration].
/// The Amazon Web Services account ID that you expect to be the owner of the Amazon S3 bucket specified by [ResultConfiguration$OutputLocation]. If set, Athena uses the value for ExpectedBucketOwner when it makes Amazon S3 calls to your specified output location. If the ExpectedBucketOwner Amazon Web Services account ID does not match the actual owner of the Amazon S3 bucket, the call fails with a permissions error. If workgroup settings override client-side settings, then the query uses the ExpectedBucketOwner setting that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See [WorkGroupConfiguration$EnforceWorkGroupConfiguration] and [Workgroup Settings Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html).
6367
6367
publicvarexpectedBucketOwner:Swift.String?
6368
-
/// The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. For more information, see [Working with query results, recent queries, and output files](https://docs.aws.amazon.com/athena/latest/ug/querying.html). If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The "workgroup settings override" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See [WorkGroupConfiguration$EnforceWorkGroupConfiguration].
6368
+
/// The location in Amazon S3 where your query and calculation results are stored, such as s3://path/to/query/bucket/. If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The "workgroup settings override" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See [WorkGroupConfiguration$EnforceWorkGroupConfiguration].
6369
6369
publicvaroutputLocation:Swift.String?
6370
6370
/// If set to true, indicates that the previously-specified ACL configuration for queries in this workgroup should be ignored and set to null. If set to false or not set, and a value is present in the AclConfiguration of ResultConfigurationUpdates, the AclConfiguration in the workgroup's ResultConfiguration is updated with the new value. For more information, see [Workgroup Settings Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html).
/// If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see [Requester Pays Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) in the Amazon Simple Storage Service Developer Guide.
8386
8386
publicvarrequesterPaysEnabled:Swift.Bool?
8387
-
/// The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using [ResultConfiguration$OutputLocation]. If none of them is set, Athena issues an error that no output location is provided. For more information, see [Working with query results, recent queries, and output files](https://docs.aws.amazon.com/athena/latest/ug/querying.html).
8387
+
/// The configuration for the workgroup, which includes the location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using [ResultConfiguration$OutputLocation]. If none of them is set, Athena issues an error that no output location is provided.
0 commit comments