aws-sdk 2.1681.0 → 2.1683.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.
@@ -597,6 +597,10 @@ declare namespace QBusiness {
597
597
  * The status of the Amazon Q Business application. The application is ready to use when the status is ACTIVE.
598
598
  */
599
599
  status?: ApplicationStatus;
600
+ /**
601
+ * The authentication type being used by a Amazon Q Business application.
602
+ */
603
+ identityType?: IdentityType;
600
604
  }
601
605
  export type ApplicationArn = string;
602
606
  export type ApplicationId = string;
@@ -710,6 +714,17 @@ declare namespace QBusiness {
710
714
  export type AuthResponseKey = string;
711
715
  export type AuthResponseValue = string;
712
716
  export type AuthorizationResponseMap = {[key: string]: AuthResponseValue};
717
+ export interface AutoSubscriptionConfiguration {
718
+ /**
719
+ * Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.
720
+ */
721
+ autoSubscribe: AutoSubscriptionStatus;
722
+ /**
723
+ * Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management. If the value for autoSubscribe is set to ENABLED you must select a value for this field.
724
+ */
725
+ defaultSubscriptionType?: SubscriptionType;
726
+ }
727
+ export type AutoSubscriptionStatus = "ENABLED"|"DISABLED"|string;
713
728
  export interface BasicAuthConfiguration {
714
729
  /**
715
730
  * The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..
@@ -896,6 +911,8 @@ declare namespace QBusiness {
896
911
  */
897
912
  failedAttachments?: AttachmentsOutput;
898
913
  }
914
+ export type ClientIdForOIDC = string;
915
+ export type ClientIdsForOIDC = ClientIdForOIDC[];
899
916
  export type ClientToken = string;
900
917
  export interface ContentBlockerRule {
901
918
  /**
@@ -936,10 +953,22 @@ declare namespace QBusiness {
936
953
  * The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
937
954
  */
938
955
  roleArn?: RoleArn;
956
+ /**
957
+ * The authentication type being used by a Amazon Q Business application.
958
+ */
959
+ identityType?: IdentityType;
960
+ /**
961
+ * The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
962
+ */
963
+ iamIdentityProviderArn?: IamIdentityProviderArn;
939
964
  /**
940
965
  * The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
941
966
  */
942
967
  identityCenterInstanceArn?: InstanceArn;
968
+ /**
969
+ * The OIDC client ID for a Amazon Q Business application.
970
+ */
971
+ clientIdsForOIDC?: ClientIdsForOIDC;
943
972
  /**
944
973
  * A description for the Amazon Q Business application.
945
974
  */
@@ -993,7 +1022,7 @@ declare namespace QBusiness {
993
1022
  */
994
1023
  displayName: DataSourceName;
995
1024
  /**
996
- * Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.
1025
+ * Configuration information to connect your data source repository to Amazon Q Business. Use this parameter to provide a JSON schema with configuration information specific to your data source connector. Each data source has a JSON schema provided by Amazon Q Business that you must use. For example, the Amazon S3 and Web Crawler connectors require the following JSON schemas: Amazon S3 JSON schema Web Crawler JSON schema You can find configuration templates for your specific data source using the following steps: Navigate to the Supported connectors page in the Amazon Q Business User Guide, and select the data source of your choice. Then, from your specific data source connector page, select Using the API. You will find the JSON schema for your data source, including parameter descriptions, in this section.
997
1026
  */
998
1027
  configuration: DataSourceConfiguration;
999
1028
  /**
@@ -1197,7 +1226,7 @@ declare namespace QBusiness {
1197
1226
  */
1198
1227
  samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
1199
1228
  /**
1200
- * The Amazon Resource Name (ARN) of the service role attached to your web experience.
1229
+ * The Amazon Resource Name (ARN) of the service role attached to your web experience. You must provide this value if you're using IAM Identity Center to manage end user access to your application. If you're using legacy identity management to manage user access, you don't need to provide this value.
1201
1230
  */
1202
1231
  roleArn?: RoleArn;
1203
1232
  /**
@@ -1208,6 +1237,10 @@ declare namespace QBusiness {
1208
1237
  * A token you provide to identify a request to create an Amazon Q Business web experience.
1209
1238
  */
1210
1239
  clientToken?: ClientToken;
1240
+ /**
1241
+ * Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
1242
+ */
1243
+ identityProviderConfiguration?: IdentityProviderConfiguration;
1211
1244
  }
1212
1245
  export interface CreateWebExperienceResponse {
1213
1246
  /**
@@ -1717,6 +1750,14 @@ declare namespace QBusiness {
1717
1750
  * The Amazon Resource Name (ARN) of the Amazon Q Business application.
1718
1751
  */
1719
1752
  applicationArn?: ApplicationArn;
1753
+ /**
1754
+ * The authentication type being used by a Amazon Q Business application.
1755
+ */
1756
+ identityType?: IdentityType;
1757
+ /**
1758
+ * The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
1759
+ */
1760
+ iamIdentityProviderArn?: IamIdentityProviderArn;
1720
1761
  /**
1721
1762
  * The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to your Amazon Q Business application.
1722
1763
  */
@@ -1761,6 +1802,14 @@ declare namespace QBusiness {
1761
1802
  * Configuration information about chat response personalization. For more information, see Personalizing chat responses.
1762
1803
  */
1763
1804
  personalizationConfiguration?: PersonalizationConfiguration;
1805
+ /**
1806
+ * Settings for auto-subscription behavior for this application. This is only applicable to SAML and OIDC applications.
1807
+ */
1808
+ autoSubscriptionConfiguration?: AutoSubscriptionConfiguration;
1809
+ /**
1810
+ * The OIDC client ID for a Amazon Q Business application.
1811
+ */
1812
+ clientIdsForOIDC?: ClientIdsForOIDC;
1764
1813
  }
1765
1814
  export interface GetChatControlsConfigurationRequest {
1766
1815
  /**
@@ -2148,6 +2197,10 @@ declare namespace QBusiness {
2148
2197
  * The Amazon Resource Name (ARN) of the service role attached to your web experience.
2149
2198
  */
2150
2199
  roleArn?: RoleArn;
2200
+ /**
2201
+ * Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
2202
+ */
2203
+ identityProviderConfiguration?: IdentityProviderConfiguration;
2151
2204
  /**
2152
2205
  * The authentication configuration information for your Amazon Q Business web experience.
2153
2206
  */
@@ -2209,7 +2262,13 @@ declare namespace QBusiness {
2209
2262
  */
2210
2263
  roleArn?: RoleArn;
2211
2264
  }
2265
+ export type IamIdentityProviderArn = string;
2212
2266
  export type IdcApplicationArn = string;
2267
+ export interface IdentityProviderConfiguration {
2268
+ samlConfiguration?: SamlProviderConfiguration;
2269
+ openIDConnectConfiguration?: OpenIDConnectProviderConfiguration;
2270
+ }
2271
+ export type IdentityType = "AWS_IAM_IDP_SAML"|"AWS_IAM_IDP_OIDC"|"AWS_IAM_IDC"|string;
2213
2272
  export interface Index {
2214
2273
  /**
2215
2274
  * The name of the index.
@@ -2726,6 +2785,16 @@ declare namespace QBusiness {
2726
2785
  */
2727
2786
  roleArn: RoleArn;
2728
2787
  }
2788
+ export interface OpenIDConnectProviderConfiguration {
2789
+ /**
2790
+ * The Amazon Resource Name (ARN) of a Secrets Manager secret containing the OIDC client secret.
2791
+ */
2792
+ secretsArn: SecretArn;
2793
+ /**
2794
+ * An IAM role with permissions to access KMS to decrypt the Secrets Manager secret containing your OIDC client secret.
2795
+ */
2796
+ secretsRole: RoleArn;
2797
+ }
2729
2798
  export type Payload = string;
2730
2799
  export interface PersonalizationConfiguration {
2731
2800
  /**
@@ -2871,7 +2940,7 @@ declare namespace QBusiness {
2871
2940
  */
2872
2941
  indexId: IndexId;
2873
2942
  /**
2874
- * The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing". If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.
2943
+ * The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".
2875
2944
  */
2876
2945
  groupName: GroupName;
2877
2946
  /**
@@ -2974,6 +3043,7 @@ declare namespace QBusiness {
2974
3043
  export type S3BucketName = string;
2975
3044
  export type S3ObjectKey = string;
2976
3045
  export type SamlAttribute = string;
3046
+ export type SamlAuthenticationUrl = string;
2977
3047
  export interface SamlConfiguration {
2978
3048
  /**
2979
3049
  * The metadata XML that your IdP generated.
@@ -2993,6 +3063,12 @@ declare namespace QBusiness {
2993
3063
  userGroupAttribute?: SamlAttribute;
2994
3064
  }
2995
3065
  export type SamlMetadataXML = string;
3066
+ export interface SamlProviderConfiguration {
3067
+ /**
3068
+ * The URL where Amazon Q Business end users will be redirected for authentication.
3069
+ */
3070
+ authenticationUrl: SamlAuthenticationUrl;
3071
+ }
2996
3072
  export type SecretArn = string;
2997
3073
  export type SecurityGroupId = string;
2998
3074
  export type SecurityGroupIds = SecurityGroupId[];
@@ -3088,6 +3164,7 @@ declare namespace QBusiness {
3088
3164
  }
3089
3165
  export type SubnetId = string;
3090
3166
  export type SubnetIds = SubnetId[];
3167
+ export type SubscriptionType = "Q_LITE"|"Q_BUSINESS"|string;
3091
3168
  export type SyncSchedule = string;
3092
3169
  export type SystemMessageId = string;
3093
3170
  export type SystemMessageOverride = string;
@@ -3210,6 +3287,10 @@ declare namespace QBusiness {
3210
3287
  * Configuration information about chat response personalization. For more information, see Personalizing chat responses.
3211
3288
  */
3212
3289
  personalizationConfiguration?: PersonalizationConfiguration;
3290
+ /**
3291
+ * An option to enable updating the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.
3292
+ */
3293
+ autoSubscriptionConfiguration?: AutoSubscriptionConfiguration;
3213
3294
  }
3214
3295
  export interface UpdateApplicationResponse {
3215
3296
  }
@@ -3426,6 +3507,10 @@ declare namespace QBusiness {
3426
3507
  * Determines whether sample prompts are enabled in the web experience for an end user.
3427
3508
  */
3428
3509
  samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
3510
+ /**
3511
+ * Information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
3512
+ */
3513
+ identityProviderConfiguration?: IdentityProviderConfiguration;
3429
3514
  }
3430
3515
  export interface UpdateWebExperienceResponse {
3431
3516
  }
@@ -28,11 +28,11 @@ declare class SupplyChain extends Service {
28
28
  */
29
29
  getBillOfMaterialsImportJob(callback?: (err: AWSError, data: SupplyChain.Types.GetBillOfMaterialsImportJobResponse) => void): Request<SupplyChain.Types.GetBillOfMaterialsImportJobResponse, AWSError>;
30
30
  /**
31
- * Send transactional data events with real-time data for analysis or monitoring.
31
+ * Send the transactional data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake. New data events are synced with data lake at 5 PM GMT everyday. The updated transactional data is available in data lake after ingestion.
32
32
  */
33
33
  sendDataIntegrationEvent(params: SupplyChain.Types.SendDataIntegrationEventRequest, callback?: (err: AWSError, data: SupplyChain.Types.SendDataIntegrationEventResponse) => void): Request<SupplyChain.Types.SendDataIntegrationEventResponse, AWSError>;
34
34
  /**
35
- * Send transactional data events with real-time data for analysis or monitoring.
35
+ * Send the transactional data payload for the event with real-time data for analysis or monitoring. The real-time data events are stored in an Amazon Web Services service before being processed and stored in data lake. New data events are synced with data lake at 5 PM GMT everyday. The updated transactional data is available in data lake after ingestion.
36
36
  */
37
37
  sendDataIntegrationEvent(callback?: (err: AWSError, data: SupplyChain.Types.SendDataIntegrationEventResponse) => void): Request<SupplyChain.Types.SendDataIntegrationEventResponse, AWSError>;
38
38
  }
@@ -111,7 +111,7 @@ declare namespace SupplyChain {
111
111
  */
112
112
  eventType: DataIntegrationEventType;
113
113
  /**
114
- * The data payload of the event.
114
+ * The data payload of the event. For more information on the data schema to use, see Data entities supported in AWS Supply Chain .
115
115
  */
116
116
  data: DataIntegrationEventData;
117
117
  /**
@@ -1949,6 +1949,20 @@ declare namespace WorkSpaces {
1949
1949
  */
1950
1950
  NextToken?: PaginationToken;
1951
1951
  }
1952
+ export interface DescribeWorkspaceDirectoriesFilter {
1953
+ /**
1954
+ * The name of the WorkSpaces to filter.
1955
+ */
1956
+ Name: DescribeWorkspaceDirectoriesFilterName;
1957
+ /**
1958
+ * The values for filtering WorkSpaces
1959
+ */
1960
+ Values: DescribeWorkspaceDirectoriesFilterValues;
1961
+ }
1962
+ export type DescribeWorkspaceDirectoriesFilterList = DescribeWorkspaceDirectoriesFilter[];
1963
+ export type DescribeWorkspaceDirectoriesFilterName = "USER_IDENTITY_TYPE"|"WORKSPACE_TYPE"|string;
1964
+ export type DescribeWorkspaceDirectoriesFilterValue = string;
1965
+ export type DescribeWorkspaceDirectoriesFilterValues = DescribeWorkspaceDirectoriesFilterValue[];
1952
1966
  export interface DescribeWorkspaceDirectoriesRequest {
1953
1967
  /**
1954
1968
  * The identifiers of the directories. If the value is null, all directories are retrieved.
@@ -1966,6 +1980,10 @@ declare namespace WorkSpaces {
1966
1980
  * If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
1967
1981
  */
1968
1982
  NextToken?: PaginationToken;
1983
+ /**
1984
+ * The filter condition for the WorkSpaces.
1985
+ */
1986
+ Filters?: DescribeWorkspaceDirectoriesFilterList;
1969
1987
  }
1970
1988
  export interface DescribeWorkspaceDirectoriesResult {
1971
1989
  /**
@@ -2308,6 +2326,16 @@ declare namespace WorkSpaces {
2308
2326
  */
2309
2327
  AccountLink?: AccountLink;
2310
2328
  }
2329
+ export interface IDCConfig {
2330
+ /**
2331
+ * The Amazon Resource Name (ARN) of the identity center instance.
2332
+ */
2333
+ InstanceArn?: ARN;
2334
+ /**
2335
+ * The Amazon Resource Name (ARN) of the application.
2336
+ */
2337
+ ApplicationArn?: ARN;
2338
+ }
2311
2339
  export type IdleDisconnectTimeoutInSeconds = number;
2312
2340
  export type ImageAssociatedResourceType = "APPLICATION"|string;
2313
2341
  export type ImageAssociatedResourceTypeList = ImageAssociatedResourceType[];
@@ -2578,6 +2606,17 @@ declare namespace WorkSpaces {
2578
2606
  export type ManagementCidrRangeMaxResults = number;
2579
2607
  export type MaxUserDurationInSeconds = number;
2580
2608
  export type MaximumLength = number;
2609
+ export interface MicrosoftEntraConfig {
2610
+ /**
2611
+ * The identifier of the tenant.
2612
+ */
2613
+ TenantId?: MicrosoftEntraConfigTenantId;
2614
+ /**
2615
+ * The Amazon Resource Name (ARN) of the application config.
2616
+ */
2617
+ ApplicationConfigSecretArn?: SecretsManagerArn;
2618
+ }
2619
+ export type MicrosoftEntraConfigTenantId = string;
2581
2620
  export interface MigrateWorkspaceRequest {
2582
2621
  /**
2583
2622
  * The identifier of the WorkSpace to migrate from.
@@ -2862,6 +2901,14 @@ declare namespace WorkSpaces {
2862
2901
  * The type of identity management the user is using.
2863
2902
  */
2864
2903
  UserIdentityType?: UserIdentityType;
2904
+ /**
2905
+ * The Amazon Resource Name (ARN) of the identity center instance.
2906
+ */
2907
+ IdcInstanceArn?: ARN;
2908
+ /**
2909
+ * The details about Microsoft Entra config.
2910
+ */
2911
+ MicrosoftEntraConfig?: MicrosoftEntraConfig;
2865
2912
  /**
2866
2913
  * Indicates whether the directory's WorkSpace type is personal or pools.
2867
2914
  */
@@ -3307,7 +3354,7 @@ declare namespace WorkSpaces {
3307
3354
  */
3308
3355
  WorkspacesPool?: WorkspacesPool;
3309
3356
  }
3310
- export type UserIdentityType = "CUSTOMER_MANAGED"|"AWS_DIRECTORY_SERVICE"|string;
3357
+ export type UserIdentityType = "CUSTOMER_MANAGED"|"AWS_DIRECTORY_SERVICE"|"AWS_IAM_IDENTITY_CENTER"|string;
3311
3358
  export type UserName = string;
3312
3359
  export interface UserSetting {
3313
3360
  /**
@@ -3673,6 +3720,10 @@ declare namespace WorkSpaces {
3673
3720
  * The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
3674
3721
  */
3675
3722
  CertificateBasedAuthProperties?: CertificateBasedAuthProperties;
3723
+ /**
3724
+ * Specifies details about Microsoft Entra configurations.
3725
+ */
3726
+ MicrosoftEntraConfig?: MicrosoftEntraConfig;
3676
3727
  /**
3677
3728
  * The name fo the WorkSpace directory.
3678
3729
  */
@@ -3689,6 +3740,10 @@ declare namespace WorkSpaces {
3689
3740
  * Indicates whether the directory's WorkSpace type is personal or pools.
3690
3741
  */
3691
3742
  WorkspaceType?: WorkspaceType;
3743
+ /**
3744
+ * Specifies details about identity center configurations.
3745
+ */
3746
+ IDCConfig?: IDCConfig;
3692
3747
  /**
3693
3748
  * Information about the Active Directory config.
3694
3749
  */
@@ -3706,7 +3761,7 @@ declare namespace WorkSpaces {
3706
3761
  export type WorkspaceDirectoryName = string;
3707
3762
  export type WorkspaceDirectoryNameList = WorkspaceDirectoryName[];
3708
3763
  export type WorkspaceDirectoryState = "REGISTERING"|"REGISTERED"|"DEREGISTERING"|"DEREGISTERED"|"ERROR"|string;
3709
- export type WorkspaceDirectoryType = "SIMPLE_AD"|"AD_CONNECTOR"|"CUSTOMER_MANAGED"|string;
3764
+ export type WorkspaceDirectoryType = "SIMPLE_AD"|"AD_CONNECTOR"|"CUSTOMER_MANAGED"|"AWS_IAM_IDENTITY_CENTER"|string;
3710
3765
  export type WorkspaceErrorCode = string;
3711
3766
  export type WorkspaceId = string;
3712
3767
  export type WorkspaceIdList = WorkspaceId[];
@@ -83,7 +83,7 @@ return /******/ (function(modules) { // webpackBootstrap
83
83
  /**
84
84
  * @constant
85
85
  */
86
- VERSION: '2.1681.0',
86
+ VERSION: '2.1683.0',
87
87
 
88
88
  /**
89
89
  * @api private