aws-sdk 2.950.0 → 2.954.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 (45) hide show
  1. package/CHANGELOG.md +25 -1
  2. package/README.md +1 -1
  3. package/apis/codebuild-2016-10-06.min.json +134 -131
  4. package/apis/databrew-2017-07-25.min.json +177 -61
  5. package/apis/ec2-2016-11-15.min.json +1298 -982
  6. package/apis/elasticmapreduce-2009-03-31.min.json +84 -28
  7. package/apis/elasticmapreduce-2009-03-31.paginators.json +5 -0
  8. package/apis/kendra-2019-02-03.min.json +59 -35
  9. package/apis/medialive-2017-10-14.min.json +221 -201
  10. package/apis/monitoring-2010-08-01.min.json +23 -22
  11. package/apis/personalize-2018-05-22.min.json +1 -2
  12. package/apis/qldb-2019-01-02.min.json +51 -28
  13. package/apis/rds-2014-10-31.min.json +3 -0
  14. package/apis/s3control-2018-08-20.min.json +64 -55
  15. package/apis/s3outposts-2017-07-25.min.json +9 -2
  16. package/apis/securityhub-2018-10-26.min.json +409 -207
  17. package/apis/synthetics-2017-10-11.min.json +40 -3
  18. package/apis/textract-2018-06-27.min.json +144 -46
  19. package/clients/cloudwatch.d.ts +19 -14
  20. package/clients/codebuild.d.ts +130 -126
  21. package/clients/databrew.d.ts +123 -8
  22. package/clients/ec2.d.ts +424 -109
  23. package/clients/elbv2.d.ts +1 -1
  24. package/clients/emr.d.ts +146 -56
  25. package/clients/iam.d.ts +4 -4
  26. package/clients/identitystore.d.ts +15 -15
  27. package/clients/imagebuilder.d.ts +1 -1
  28. package/clients/kendra.d.ts +39 -8
  29. package/clients/lambda.d.ts +14 -14
  30. package/clients/medialive.d.ts +16 -0
  31. package/clients/personalize.d.ts +15 -15
  32. package/clients/proton.d.ts +54 -54
  33. package/clients/qldb.d.ts +51 -15
  34. package/clients/rds.d.ts +8 -4
  35. package/clients/s3control.d.ts +100 -78
  36. package/clients/s3outposts.d.ts +44 -13
  37. package/clients/securityhub.d.ts +473 -143
  38. package/clients/synthetics.d.ts +27 -10
  39. package/clients/textract.d.ts +92 -1
  40. package/dist/aws-sdk-core-react-native.js +1 -1
  41. package/dist/aws-sdk-react-native.js +17 -17
  42. package/dist/aws-sdk.js +1551 -1168
  43. package/dist/aws-sdk.min.js +76 -76
  44. package/lib/core.js +1 -1
  45. package/package.json +1 -1
package/clients/iam.d.ts CHANGED
@@ -109,11 +109,11 @@ declare class IAM extends Service {
109
109
  */
110
110
  createLoginProfile(callback?: (err: AWSError, data: IAM.Types.CreateLoginProfileResponse) => void): Request<IAM.Types.CreateLoginProfileResponse, AWSError>;
111
111
  /**
112
- * Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC). The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider. If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federation in the IAM User Guide. When you create the IAM OIDC provider, you specify the following: The URL of the OIDC identity provider (IdP) to trust A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider A list of thumbprints of one or more server certificates that the IdP uses You get all of this information from the OIDC IdP that you want to use to access Amazon Web Services. The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users.
112
+ * Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC). The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider. If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federation in the IAM User Guide. When you create the IAM OIDC provider, you specify the following: The URL of the OIDC identity provider (IdP) to trust A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider A list of thumbprints of one or more server certificates that the IdP uses You get all of this information from the OIDC IdP that you want to use to access Amazon Web Services. Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation. The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users.
113
113
  */
114
114
  createOpenIDConnectProvider(params: IAM.Types.CreateOpenIDConnectProviderRequest, callback?: (err: AWSError, data: IAM.Types.CreateOpenIDConnectProviderResponse) => void): Request<IAM.Types.CreateOpenIDConnectProviderResponse, AWSError>;
115
115
  /**
116
- * Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC). The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider. If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federation in the IAM User Guide. When you create the IAM OIDC provider, you specify the following: The URL of the OIDC identity provider (IdP) to trust A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider A list of thumbprints of one or more server certificates that the IdP uses You get all of this information from the OIDC IdP that you want to use to access Amazon Web Services. The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users.
116
+ * Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC). The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between Amazon Web Services and the OIDC provider. If you are using an OIDC identity provider from Google, Facebook, or Amazon Cognito, you don't need to create a separate IAM identity provider. These OIDC identity providers are already built-in to Amazon Web Services and are available for your use. Instead, you can move directly to creating new roles using your identity provider. To learn more, see Creating a role for web identity or OpenID connect federation in the IAM User Guide. When you create the IAM OIDC provider, you specify the following: The URL of the OIDC identity provider (IdP) to trust A list of client IDs (also known as audiences) that identify the application or applications allowed to authenticate using the OIDC provider A list of thumbprints of one or more server certificates that the IdP uses You get all of this information from the OIDC IdP that you want to use to access Amazon Web Services. Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation. The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users.
117
117
  */
118
118
  createOpenIDConnectProvider(callback?: (err: AWSError, data: IAM.Types.CreateOpenIDConnectProviderResponse) => void): Request<IAM.Types.CreateOpenIDConnectProviderResponse, AWSError>;
119
119
  /**
@@ -1161,11 +1161,11 @@ declare class IAM extends Service {
1161
1161
  */
1162
1162
  updateLoginProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1163
1163
  /**
1164
- * Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints. The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.) Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated. Trust for the OIDC provider is derived from the provider's certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly privileged users.
1164
+ * Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints. The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.) Typically, you need to update a thumbprint only when the identity provider certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated. Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation. Trust for the OIDC provider is derived from the provider certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly privileged users.
1165
1165
  */
1166
1166
  updateOpenIDConnectProviderThumbprint(params: IAM.Types.UpdateOpenIDConnectProviderThumbprintRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1167
1167
  /**
1168
- * Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints. The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.) Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated. Trust for the OIDC provider is derived from the provider's certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly privileged users.
1168
+ * Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints. The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.) Typically, you need to update a thumbprint only when the identity provider certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated. Amazon Web Services secures communication with some OIDC identity providers (IdPs) through our library of trusted certificate authorities (CAs) instead of using a certificate thumbprint to verify your IdP server certificate. These OIDC IdPs include Google, and those that use an Amazon S3 bucket to host a JSON Web Key Set (JWKS) endpoint. In these cases, your legacy thumbprint remains in your configuration, but is no longer used for validation. Trust for the OIDC provider is derived from the provider certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly privileged users.
1169
1169
  */
1170
1170
  updateOpenIDConnectProviderThumbprint(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
1171
1171
  /**
@@ -48,7 +48,7 @@ declare namespace IdentityStore {
48
48
  export type AttributePath = string;
49
49
  export interface DescribeGroupRequest {
50
50
  /**
51
- * The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.
51
+ * The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.
52
52
  */
53
53
  IdentityStoreId: IdentityStoreId;
54
54
  /**
@@ -62,13 +62,13 @@ declare namespace IdentityStore {
62
62
  */
63
63
  GroupId: ResourceId;
64
64
  /**
65
- * Contains the group’s display name value. The length limit is 1024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space and non breaking space in this attribute. The characters “&lt;&gt;;:%” are excluded. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
65
+ * Contains the group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. The characters &lt;&gt;;:% are excluded. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.
66
66
  */
67
67
  DisplayName: GroupDisplayName;
68
68
  }
69
69
  export interface DescribeUserRequest {
70
70
  /**
71
- * The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.
71
+ * The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.
72
72
  */
73
73
  IdentityStoreId: IdentityStoreId;
74
74
  /**
@@ -78,7 +78,7 @@ declare namespace IdentityStore {
78
78
  }
79
79
  export interface DescribeUserResponse {
80
80
  /**
81
- * Contains the user’s username value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers and punctuation. The characters “&lt;&gt;;:%” are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
81
+ * Contains the user’s user name value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. The characters &lt;&gt;;:% are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
82
82
  */
83
83
  UserName: UserName;
84
84
  /**
@@ -88,7 +88,7 @@ declare namespace IdentityStore {
88
88
  }
89
89
  export interface Filter {
90
90
  /**
91
- * The attribute path used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.
91
+ * The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.
92
92
  */
93
93
  AttributePath: AttributePath;
94
94
  /**
@@ -103,7 +103,7 @@ declare namespace IdentityStore {
103
103
  */
104
104
  GroupId: ResourceId;
105
105
  /**
106
- * Contains the group’s display name value. The length limit is 1024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space and non breaking space in this attribute. The characters “&lt;&gt;;:%” are excluded. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
106
+ * Contains the group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. The characters &lt;&gt;;:% are excluded. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.
107
107
  */
108
108
  DisplayName: GroupDisplayName;
109
109
  }
@@ -112,15 +112,15 @@ declare namespace IdentityStore {
112
112
  export type IdentityStoreId = string;
113
113
  export interface ListGroupsRequest {
114
114
  /**
115
- * The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.
115
+ * The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.
116
116
  */
117
117
  IdentityStoreId: IdentityStoreId;
118
118
  /**
119
- * The maximum number of results to be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.
119
+ * The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.
120
120
  */
121
121
  MaxResults?: MaxResults;
122
122
  /**
123
- * The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.
123
+ * The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
124
124
  */
125
125
  NextToken?: NextToken;
126
126
  /**
@@ -134,21 +134,21 @@ declare namespace IdentityStore {
134
134
  */
135
135
  Groups: Groups;
136
136
  /**
137
- * The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.
137
+ * The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it1 is used in the API request to search for the next page.
138
138
  */
139
139
  NextToken?: NextToken;
140
140
  }
141
141
  export interface ListUsersRequest {
142
142
  /**
143
- * The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string which contains number and lower case letters. This value is generated at the time that a new identity store is created.
143
+ * The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.
144
144
  */
145
145
  IdentityStoreId: IdentityStoreId;
146
146
  /**
147
- * The maximum number of results to be returned per request, which is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.
147
+ * The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.
148
148
  */
149
149
  MaxResults?: MaxResults;
150
150
  /**
151
- * The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.
151
+ * The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
152
152
  */
153
153
  NextToken?: NextToken;
154
154
  /**
@@ -162,7 +162,7 @@ declare namespace IdentityStore {
162
162
  */
163
163
  Users: Users;
164
164
  /**
165
- * The pagination token used for the ListUsers and ListGroups APIs. This value is generated by the identity store service and is returned in the API response if the total results are more than the size of one page, and when this token is used in the API request to search for the next page.
165
+ * The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
166
166
  */
167
167
  NextToken?: NextToken;
168
168
  }
@@ -172,7 +172,7 @@ declare namespace IdentityStore {
172
172
  export type SensitiveStringType = string;
173
173
  export interface User {
174
174
  /**
175
- * Contains the user’s username value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers and punctuation. The characters “&lt;&gt;;:%” are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
175
+ * Contains the user’s user name value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. The characters &lt;&gt;;:% are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.
176
176
  */
177
177
  UserName: UserName;
178
178
  /**
@@ -2771,7 +2771,7 @@ declare namespace Imagebuilder {
2771
2771
  export type StringList = NonEmptyString[];
2772
2772
  export interface SystemsManagerAgent {
2773
2773
  /**
2774
- * This property defaults to true. If Image Builder installs the SSM agent on a build instance, it removes the agent before creating a snapshot for the AMI. To ensure that the AMI you create includes the SSM agent, set this property to false.
2774
+ * Controls whether the SSM agent is removed from your final build image, prior to creating the new AMI. If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. The default value is false.
2775
2775
  */
2776
2776
  uninstallAfterBuild?: NullableBoolean;
2777
2777
  }
@@ -292,11 +292,11 @@ declare class Kendra extends Service {
292
292
  */
293
293
  stopDataSourceSyncJob(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
294
294
  /**
295
- * Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
295
+ * Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
296
296
  */
297
297
  submitFeedback(params: Kendra.Types.SubmitFeedbackRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
298
298
  /**
299
- * Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
299
+ * Enables you to provide feedback to Amazon Kendra to improve the performance of your index.
300
300
  */
301
301
  submitFeedback(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
302
302
  /**
@@ -562,11 +562,11 @@ declare namespace Kendra {
562
562
  export type Boolean = boolean;
563
563
  export interface CapacityUnitsConfiguration {
564
564
  /**
565
- * The amount of extra storage capacity for an index. A single capacity unit for an index provides 150 GB of storage space or 500,000 documents, whichever is reached first.
565
+ * The amount of extra storage capacity for an index. A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first.
566
566
  */
567
567
  StorageCapacityUnits: StorageCapacityUnit;
568
568
  /**
569
- * The amount of extra query capacity for an index and GetQuerySuggestions capacity. A single extra capacity unit for an index provides 0.5 queries per second or approximately 40,000 queries per day. GetQuerySuggestions capacity is 5 times the provisioned query capacity for an index. For example, the base capacity for an index is 0.5 queries per second, so GetQuerySuggestions capacity is 2.5 calls per second. If adding another 0.5 queries per second to total 1 queries per second for an index, the GetQuerySuggestions capacity is 5 calls per second.
569
+ * The amount of extra query capacity for an index and GetQuerySuggestions capacity. A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than five times 0.2 queries per second).
570
570
  */
571
571
  QueryCapacityUnits: QueryCapacityUnit;
572
572
  }
@@ -784,7 +784,7 @@ declare namespace Kendra {
784
784
  */
785
785
  TableName: TableName;
786
786
  /**
787
- * The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the Secrets Manager user guide.
787
+ * The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.
788
788
  */
789
789
  SecretArn: SecretArn;
790
790
  }
@@ -880,7 +880,7 @@ declare namespace Kendra {
880
880
  */
881
881
  Name: IndexName;
882
882
  /**
883
- * The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for your production databases. Once you set the edition for an index, it can't be changed. The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.
883
+ * The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for your production databases. Once you set the edition for an index, it can't be changed. The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION. For more information on quota limits for enterprise and developer editions, see Quotas.
884
884
  */
885
885
  Edition?: IndexEdition;
886
886
  /**
@@ -1024,6 +1024,10 @@ declare namespace Kendra {
1024
1024
  */
1025
1025
  GoogleDriveConfiguration?: GoogleDriveConfiguration;
1026
1026
  WebCrawlerConfiguration?: WebCrawlerConfiguration;
1027
+ /**
1028
+ * Provides the configuration information to connect to WorkDocs as your data source.
1029
+ */
1030
+ WorkDocsConfiguration?: WorkDocsConfiguration;
1027
1031
  }
1028
1032
  export type DataSourceDateFieldFormat = string;
1029
1033
  export type DataSourceFieldName = string;
@@ -1154,7 +1158,7 @@ declare namespace Kendra {
1154
1158
  IndexFieldName: IndexFieldName;
1155
1159
  }
1156
1160
  export type DataSourceToIndexFieldMappingList = DataSourceToIndexFieldMapping[];
1157
- export type DataSourceType = "S3"|"SHAREPOINT"|"DATABASE"|"SALESFORCE"|"ONEDRIVE"|"SERVICENOW"|"CUSTOM"|"CONFLUENCE"|"GOOGLEDRIVE"|"WEBCRAWLER"|string;
1161
+ export type DataSourceType = "S3"|"SHAREPOINT"|"DATABASE"|"SALESFORCE"|"ONEDRIVE"|"SERVICENOW"|"CUSTOM"|"CONFLUENCE"|"GOOGLEDRIVE"|"WEBCRAWLER"|"WORKDOCS"|string;
1158
1162
  export interface DataSourceVpcConfiguration {
1159
1163
  /**
1160
1164
  * A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
@@ -2327,6 +2331,7 @@ declare namespace Kendra {
2327
2331
  OneDriveUserS3Path?: S3Path;
2328
2332
  }
2329
2333
  export type Order = "ASCENDING"|"DESCENDING"|string;
2334
+ export type OrganizationId = string;
2330
2335
  export type Port = number;
2331
2336
  export interface Principal {
2332
2337
  /**
@@ -2891,7 +2896,7 @@ declare namespace Kendra {
2891
2896
  */
2892
2897
  Urls: SharePointUrlList;
2893
2898
  /**
2894
- * The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. If you use SharePoint Sever, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the Secrets Manager user guide.
2899
+ * The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see Using a Microsoft SharePoint Data Source. For more information about Secrets Manager, see What Is Secrets Manager in the Secrets Manager user guide.
2895
2900
  */
2896
2901
  SecretArn: SecretArn;
2897
2902
  /**
@@ -3380,6 +3385,32 @@ declare namespace Kendra {
3380
3385
  AuthenticationConfiguration?: AuthenticationConfiguration;
3381
3386
  }
3382
3387
  export type WebCrawlerMode = "HOST_ONLY"|"SUBDOMAINS"|"EVERYTHING"|string;
3388
+ export interface WorkDocsConfiguration {
3389
+ /**
3390
+ * The identifier of the directory corresponding to your Amazon WorkDocs site repository. You can find the organization ID in the AWS Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the AWS Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.
3391
+ */
3392
+ OrganizationId: OrganizationId;
3393
+ /**
3394
+ * TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on. The default is set to FALSE.
3395
+ */
3396
+ CrawlComments?: Boolean;
3397
+ /**
3398
+ * TRUE to use the change logs to update documents in your index instead of scanning all documents. If you are syncing your Amazon WorkDocs data source with your index for the first time, all documents are scanned. After your first sync, you can use the change logs to update your documents in your index for future syncs. The default is set to FALSE.
3399
+ */
3400
+ UseChangeLog?: Boolean;
3401
+ /**
3402
+ * A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
3403
+ */
3404
+ InclusionPatterns?: DataSourceInclusionsExclusionsStrings;
3405
+ /**
3406
+ * A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.
3407
+ */
3408
+ ExclusionPatterns?: DataSourceInclusionsExclusionsStrings;
3409
+ /**
3410
+ * A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first create the custom index fields using the UpdateIndex operation before you map to Amazon WorkDocs fields. For more information, see Mapping Data Source Fields. The Amazon WorkDocs data source field names need to exist in your Amazon WorkDocs custom metadata.
3411
+ */
3412
+ FieldMappings?: DataSourceToIndexFieldMappingList;
3413
+ }
3383
3414
  /**
3384
3415
  * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
3385
3416
  */
@@ -815,7 +815,7 @@ declare namespace Lambda {
815
815
  */
816
816
  Queues?: Queues;
817
817
  /**
818
- * An array of the authentication protocol, or the VPC components to secure your event source.
818
+ * An array of authentication protocols or VPC components required to secure your event source.
819
819
  */
820
820
  SourceAccessConfigurations?: SourceAccessConfigurations;
821
821
  /**
@@ -1044,7 +1044,7 @@ declare namespace Lambda {
1044
1044
  */
1045
1045
  UUID?: String;
1046
1046
  /**
1047
- * The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.
1047
+ * The position in a stream from which to start reading. Required for Amazon Kinesis, Amazon DynamoDB, and Amazon MSK stream sources. AT_TIMESTAMP is supported only for Amazon Kinesis streams.
1048
1048
  */
1049
1049
  StartingPosition?: EventSourcePosition;
1050
1050
  /**
@@ -1056,11 +1056,11 @@ declare namespace Lambda {
1056
1056
  */
1057
1057
  BatchSize?: BatchSize;
1058
1058
  /**
1059
- * (Streams and SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds. The default value is zero.
1059
+ * (Streams and Amazon SQS standard queues) The maximum amount of time to gather records before invoking the function, in seconds. The default value is zero.
1060
1060
  */
1061
1061
  MaximumBatchingWindowInSeconds?: MaximumBatchingWindowInSeconds;
1062
1062
  /**
1063
- * (Streams only) The number of batches to process from each shard concurrently. The default value is 1.
1063
+ * (Streams only) The number of batches to process concurrently from each shard. The default value is 1.
1064
1064
  */
1065
1065
  ParallelizationFactor?: ParallelizationFactor;
1066
1066
  /**
@@ -1072,11 +1072,11 @@ declare namespace Lambda {
1072
1072
  */
1073
1073
  FunctionArn?: FunctionArn;
1074
1074
  /**
1075
- * The date that the event source mapping was last updated, or its state changed.
1075
+ * The date that the event source mapping was last updated or that its state changed.
1076
1076
  */
1077
1077
  LastModified?: _Date;
1078
1078
  /**
1079
- * The result of the last Lambda invocation of your Lambda function.
1079
+ * The result of the last Lambda invocation of your function.
1080
1080
  */
1081
1081
  LastProcessingResult?: String;
1082
1082
  /**
@@ -1084,7 +1084,7 @@ declare namespace Lambda {
1084
1084
  */
1085
1085
  State?: String;
1086
1086
  /**
1087
- * Indicates whether the last change to the event source mapping was made by a user, or by the Lambda service.
1087
+ * Indicates whether a user or Lambda made the last change to the event source mapping.
1088
1088
  */
1089
1089
  StateTransitionReason?: String;
1090
1090
  /**
@@ -1096,15 +1096,15 @@ declare namespace Lambda {
1096
1096
  */
1097
1097
  Topics?: Topics;
1098
1098
  /**
1099
- * (MQ) The name of the Amazon MQ broker destination queue to consume.
1099
+ * (Amazon MQ) The name of the Amazon MQ broker destination queue to consume.
1100
1100
  */
1101
1101
  Queues?: Queues;
1102
1102
  /**
1103
- * An array of the authentication protocol, or the VPC components to secure your event source.
1103
+ * An array of the authentication protocol, VPC components, or virtual host to secure and define your event source.
1104
1104
  */
1105
1105
  SourceAccessConfigurations?: SourceAccessConfigurations;
1106
1106
  /**
1107
- * The Self-Managed Apache Kafka cluster for your event source.
1107
+ * The self-managed Apache Kafka cluster for your event source.
1108
1108
  */
1109
1109
  SelfManagedEventSource?: SelfManagedEventSource;
1110
1110
  /**
@@ -1120,7 +1120,7 @@ declare namespace Lambda {
1120
1120
  */
1121
1121
  MaximumRetryAttempts?: MaximumRetryAttemptsEventSourceMapping;
1122
1122
  /**
1123
- * (Streams only) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.
1123
+ * (Streams only) The duration in seconds of a processing window. The range is 1900 seconds.
1124
1124
  */
1125
1125
  TumblingWindowInSeconds?: TumblingWindowInSeconds;
1126
1126
  /**
@@ -1858,7 +1858,7 @@ declare namespace Lambda {
1858
1858
  */
1859
1859
  Marker?: String;
1860
1860
  /**
1861
- * The maximum number of event source mappings to return.
1861
+ * The maximum number of event source mappings to return. Note that ListEventSourceMappings returns a maximum of 100 items in each response, even if you set the number higher.
1862
1862
  */
1863
1863
  MaxItems?: MaxListItems;
1864
1864
  }
@@ -2351,7 +2351,7 @@ declare namespace Lambda {
2351
2351
  export type SigningProfileVersionArns = Arn[];
2352
2352
  export interface SourceAccessConfiguration {
2353
2353
  /**
2354
- * The type of authentication protocol or the VPC components for your event source. For example: "Type":"SASL_SCRAM_512_AUTH". BASIC_AUTH - (MQ) The Secrets Manager secret that stores your broker credentials. VPC_SUBNET - The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your Self-Managed Apache Kafka cluster. VPC_SECURITY_GROUP - The VPC security group used to manage access to your Self-Managed Apache Kafka brokers. SASL_SCRAM_256_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your Self-Managed Apache Kafka brokers. SASL_SCRAM_512_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your Self-Managed Apache Kafka brokers. VIRTUAL_HOST - The name of the virtual host in your RabbitMQ broker. Lambda will use this host as the event source.
2354
+ * The type of authentication protocol, VPC components, or virtual host for your event source. For example: "Type":"SASL_SCRAM_512_AUTH". BASIC_AUTH - (Amazon MQ) The Secrets Manager secret that stores your broker credentials. BASIC_AUTH - (Self-managed Apache Kafka) The Secrets Manager ARN of your secret key used for SASL/PLAIN authentication of your Apache Kafka brokers. VPC_SUBNET - The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your self-managed Apache Kafka cluster. VPC_SECURITY_GROUP - The VPC security group used to manage access to your self-managed Apache Kafka brokers. SASL_SCRAM_256_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your self-managed Apache Kafka brokers. SASL_SCRAM_512_AUTH - The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers. VIRTUAL_HOST - (Amazon MQ) The name of the virtual host in your RabbitMQ broker. Lambda uses this RabbitMQ host as the event source.
2355
2355
  */
2356
2356
  Type?: SourceAccessType;
2357
2357
  /**
@@ -2506,7 +2506,7 @@ declare namespace Lambda {
2506
2506
  */
2507
2507
  ParallelizationFactor?: ParallelizationFactor;
2508
2508
  /**
2509
- * An array of the authentication protocol, or the VPC components to secure your event source.
2509
+ * An array of authentication protocols or VPC components required to secure your event source.
2510
2510
  */
2511
2511
  SourceAccessConfigurations?: SourceAccessConfigurations;
2512
2512
  /**
@@ -758,6 +758,16 @@ Note that this field and audioType are both ignored if inputType is broadcasterM
758
758
  }
759
759
  export type AudioDescriptionAudioTypeControl = "FOLLOW_INPUT"|"USE_CONFIGURED"|string;
760
760
  export type AudioDescriptionLanguageCodeControl = "FOLLOW_INPUT"|"USE_CONFIGURED"|string;
761
+ export interface AudioHlsRenditionSelection {
762
+ /**
763
+ * Specifies the GROUP-ID in the #EXT-X-MEDIA tag of the target HLS audio rendition.
764
+ */
765
+ GroupId: __stringMin1;
766
+ /**
767
+ * Specifies the NAME in the #EXT-X-MEDIA tag of the target HLS audio rendition.
768
+ */
769
+ Name: __stringMin1;
770
+ }
761
771
  export interface AudioLanguageSelection {
762
772
  /**
763
773
  * Selects a specific three-letter language code from within an audio source.
@@ -836,6 +846,7 @@ Alternate rendition that the client will not try to play back by default. Repres
836
846
  SelectorSettings?: AudioSelectorSettings;
837
847
  }
838
848
  export interface AudioSelectorSettings {
849
+ AudioHlsRenditionSelection?: AudioHlsRenditionSelection;
839
850
  AudioLanguageSelection?: AudioLanguageSelection;
840
851
  AudioPidSelection?: AudioPidSelection;
841
852
  AudioTrackSelection?: AudioTrackSelection;
@@ -6707,7 +6718,12 @@ If STANDARD channel, subnet IDs must be mapped to two unique availability zones
6707
6718
  SampleRate?: __double;
6708
6719
  }
6709
6720
  export interface WebvttDestinationSettings {
6721
+ /**
6722
+ * Controls whether the color and position of the source captions is passed through to the WebVTT output captions. PASSTHROUGH - Valid only if the source captions are EMBEDDED or TELETEXT. NO_STYLE_DATA - Don't pass through the style. The output captions will not contain any font styling information.
6723
+ */
6724
+ StyleControl?: WebvttDestinationStyleControl;
6710
6725
  }
6726
+ export type WebvttDestinationStyleControl = "NO_STYLE_DATA"|"PASSTHROUGH"|string;
6711
6727
  export type __double = number;
6712
6728
  export type __doubleMin0 = number;
6713
6729
  export type __doubleMin0Max1 = number;
@@ -36,27 +36,27 @@ declare class Personalize extends Service {
36
36
  */
37
37
  createDataset(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetResponse) => void): Request<Personalize.Types.CreateDatasetResponse, AWSError>;
38
38
  /**
39
- * Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked AWS Identity and Access Management (IAM) role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide. Status A dataset export job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
39
+ * Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide. Status A dataset export job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
40
40
  */
41
41
  createDatasetExportJob(params: Personalize.Types.CreateDatasetExportJobRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDatasetExportJobResponse) => void): Request<Personalize.Types.CreateDatasetExportJobResponse, AWSError>;
42
42
  /**
43
- * Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked AWS Identity and Access Management (IAM) role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide. Status A dataset export job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
43
+ * Creates a job that exports data from your dataset to an Amazon S3 bucket. To allow Amazon Personalize to export the training data, you must specify an service-linked IAM role that gives Amazon Personalize PutObject permissions for your Amazon S3 bucket. For information, see Exporting a dataset in the Amazon Personalize developer guide. Status A dataset export job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED To get the status of the export job, call DescribeDatasetExportJob, and specify the Amazon Resource Name (ARN) of the dataset export job. The dataset export is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.
44
44
  */
45
45
  createDatasetExportJob(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetExportJobResponse) => void): Request<Personalize.Types.CreateDatasetExportJobResponse, AWSError>;
46
46
  /**
47
- * Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset: Interactions Items Users To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group. A dataset group can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed. You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group. You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an AWS Identity and Access Management (IAM) role that has permission to access the key. APIs that require a dataset group ARN in the request CreateDataset CreateEventTracker CreateSolution Related APIs ListDatasetGroups DescribeDatasetGroup DeleteDatasetGroup
47
+ * Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset: Interactions Items Users To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group. A dataset group can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed. You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group. You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key. APIs that require a dataset group ARN in the request CreateDataset CreateEventTracker CreateSolution Related APIs ListDatasetGroups DescribeDatasetGroup DeleteDatasetGroup
48
48
  */
49
49
  createDatasetGroup(params: Personalize.Types.CreateDatasetGroupRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDatasetGroupResponse) => void): Request<Personalize.Types.CreateDatasetGroupResponse, AWSError>;
50
50
  /**
51
- * Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset: Interactions Items Users To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group. A dataset group can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed. You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group. You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an AWS Identity and Access Management (IAM) role that has permission to access the key. APIs that require a dataset group ARN in the request CreateDataset CreateEventTracker CreateSolution Related APIs ListDatasetGroups DescribeDatasetGroup DeleteDatasetGroup
51
+ * Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset: Interactions Items Users To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group. A dataset group can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED DELETE PENDING To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed. You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group. You can specify an Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an Identity and Access Management (IAM) role that has permission to access the key. APIs that require a dataset group ARN in the request CreateDataset CreateEventTracker CreateSolution Related APIs ListDatasetGroups DescribeDatasetGroup DeleteDatasetGroup
52
52
  */
53
53
  createDatasetGroup(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetGroupResponse) => void): Request<Personalize.Types.CreateDatasetGroupResponse, AWSError>;
54
54
  /**
55
- * Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an AWS Identity and Access Management (IAM) service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it in an internal AWS system. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources. The dataset import job replaces any existing data in the dataset that you imported in bulk. Status A dataset import job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset. Related APIs ListDatasetImportJobs DescribeDatasetImportJob
55
+ * Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources. The dataset import job replaces any existing data in the dataset that you imported in bulk. Status A dataset import job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset. Related APIs ListDatasetImportJobs DescribeDatasetImportJob
56
56
  */
57
57
  createDatasetImportJob(params: Personalize.Types.CreateDatasetImportJobRequest, callback?: (err: AWSError, data: Personalize.Types.CreateDatasetImportJobResponse) => void): Request<Personalize.Types.CreateDatasetImportJobResponse, AWSError>;
58
58
  /**
59
- * Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an AWS Identity and Access Management (IAM) service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it in an internal AWS system. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources. The dataset import job replaces any existing data in the dataset that you imported in bulk. Status A dataset import job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset. Related APIs ListDatasetImportJobs DescribeDatasetImportJob
59
+ * Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an IAM service role that has permission to read from the data source, as Amazon Personalize makes a copy of your data and processes it internally. For information on granting access to your Amazon S3 bucket, see Giving Amazon Personalize Access to Amazon S3 Resources. The dataset import job replaces any existing data in the dataset that you imported in bulk. Status A dataset import job can be in one of the following states: CREATE PENDING &gt; CREATE IN_PROGRESS &gt; ACTIVE -or- CREATE FAILED To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed. Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset. Related APIs ListDatasetImportJobs DescribeDatasetImportJob
60
60
  */
61
61
  createDatasetImportJob(callback?: (err: AWSError, data: Personalize.Types.CreateDatasetImportJobResponse) => void): Request<Personalize.Types.CreateDatasetImportJobResponse, AWSError>;
62
62
  /**
@@ -746,7 +746,7 @@ declare namespace Personalize {
746
746
  /**
747
747
  * Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.
748
748
  */
749
- minProvisionedTPS: TransactionsPerSecond;
749
+ minProvisionedTPS?: TransactionsPerSecond;
750
750
  /**
751
751
  * The configuration details of a campaign.
752
752
  */
@@ -772,7 +772,7 @@ declare namespace Personalize {
772
772
  */
773
773
  ingestionMode?: IngestionMode;
774
774
  /**
775
- * The Amazon Resource Name (ARN) of the AWS Identity and Access Management service role that has permissions to add data to your output Amazon S3 bucket.
775
+ * The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
776
776
  */
777
777
  roleArn: RoleArn;
778
778
  /**
@@ -792,11 +792,11 @@ declare namespace Personalize {
792
792
  */
793
793
  name: Name;
794
794
  /**
795
- * The ARN of the IAM role that has permissions to access the KMS key. Supplying an IAM role is only valid when also specifying a KMS key.
795
+ * The ARN of the Identity and Access Management (IAM) role that has permissions to access the Key Management Service (KMS) key. Supplying an IAM role is only valid when also specifying a KMS key.
796
796
  */
797
797
  roleArn?: RoleArn;
798
798
  /**
799
- * The Amazon Resource Name (ARN) of a KMS key used to encrypt the datasets.
799
+ * The Amazon Resource Name (ARN) of a Key Management Service (KMS) key used to encrypt the datasets.
800
800
  */
801
801
  kmsKeyArn?: KmsKeyArn;
802
802
  }
@@ -1020,7 +1020,7 @@ declare namespace Personalize {
1020
1020
  */
1021
1021
  ingestionMode?: IngestionMode;
1022
1022
  /**
1023
- * The Amazon Resource Name (ARN) of the AWS Identity and Access Management service role that has permissions to add data to your output Amazon S3 bucket.
1023
+ * The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
1024
1024
  */
1025
1025
  roleArn?: Arn;
1026
1026
  /**
@@ -1092,7 +1092,7 @@ declare namespace Personalize {
1092
1092
  */
1093
1093
  roleArn?: RoleArn;
1094
1094
  /**
1095
- * The Amazon Resource Name (ARN) of the KMS key used to encrypt the datasets.
1095
+ * The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the datasets.
1096
1096
  */
1097
1097
  kmsKeyArn?: KmsKeyArn;
1098
1098
  /**
@@ -1153,7 +1153,7 @@ declare namespace Personalize {
1153
1153
  */
1154
1154
  dataSource?: DataSource;
1155
1155
  /**
1156
- * The ARN of the AWS Identity and Access Management (IAM) role that has permissions to read from the Amazon S3 data source.
1156
+ * The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
1157
1157
  */
1158
1158
  roleArn?: Arn;
1159
1159
  /**
@@ -1558,7 +1558,7 @@ declare namespace Personalize {
1558
1558
  */
1559
1559
  eventTrackerArn?: Arn;
1560
1560
  /**
1561
- * The Amazon AWS account that owns the event tracker.
1561
+ * The Amazon Web Services account that owns the event tracker.
1562
1562
  */
1563
1563
  accountId?: AccountId;
1564
1564
  /**
@@ -2167,7 +2167,7 @@ declare namespace Personalize {
2167
2167
  */
2168
2168
  path: S3Location;
2169
2169
  /**
2170
- * The Amazon Resource Name (ARN) of the Amazon Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files of a batch inference job.
2170
+ * The Amazon Resource Name (ARN) of the Key Management Service (KMS) key that Amazon Personalize uses to encrypt or decrypt the input and output files of a batch inference job.
2171
2171
  */
2172
2172
  kmsKeyArn?: KmsKeyArn;
2173
2173
  }