cdk-comprehend-s3olap 2.0.27 → 2.0.30
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +16 -3
- package/lib/cdk-comprehend-s3olap.js +2 -2
- package/lib/comprehend-lambdas.js +2 -2
- package/lib/iam-roles.js +4 -4
- package/node_modules/aws-sdk/CHANGELOG.md +12 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/cloudformation-2010-05-15.min.json +50 -49
- package/node_modules/aws-sdk/apis/metadata.json +3 -0
- package/node_modules/aws-sdk/apis/models.lex.v2-2020-08-07.min.json +112 -111
- package/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json +318 -205
- package/node_modules/aws-sdk/apis/rds-2014-10-31.waiters2.json +85 -0
- package/node_modules/aws-sdk/apis/rolesanywhere-2018-05-10.examples.json +5 -0
- package/node_modules/aws-sdk/apis/rolesanywhere-2018-05-10.min.json +819 -0
- package/node_modules/aws-sdk/apis/rolesanywhere-2018-05-10.paginators.json +24 -0
- package/node_modules/aws-sdk/apis/ssm-incidents-2018-05-10.min.json +20 -12
- package/node_modules/aws-sdk/apis/synthetics-2017-10-11.min.json +272 -39
- package/node_modules/aws-sdk/apis/synthetics-2017-10-11.paginators.json +15 -0
- package/node_modules/aws-sdk/clients/all.d.ts +1 -0
- package/node_modules/aws-sdk/clients/all.js +2 -1
- package/node_modules/aws-sdk/clients/cloudformation.d.ts +5 -0
- package/node_modules/aws-sdk/clients/configservice.d.ts +12 -12
- package/node_modules/aws-sdk/clients/lexmodelsv2.d.ts +5 -0
- package/node_modules/aws-sdk/clients/quicksight.d.ts +182 -20
- package/node_modules/aws-sdk/clients/rds.d.ts +95 -79
- package/node_modules/aws-sdk/clients/rolesanywhere.d.ts +788 -0
- package/node_modules/aws-sdk/clients/rolesanywhere.js +18 -0
- package/node_modules/aws-sdk/clients/ssmincidents.d.ts +9 -0
- package/node_modules/aws-sdk/clients/synthetics.d.ts +270 -30
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +2 -2
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +48 -11
- package/node_modules/aws-sdk/dist/aws-sdk.js +141 -52
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +37 -37
- package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +2 -0
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +4 -4
@@ -608,6 +608,7 @@ declare class CloudFormation extends Service {
|
|
608
608
|
declare namespace CloudFormation {
|
609
609
|
export type AcceptTermsAndConditions = boolean;
|
610
610
|
export type Account = string;
|
611
|
+
export type AccountFilterType = "NONE"|"INTERSECTION"|"DIFFERENCE"|"UNION"|string;
|
611
612
|
export interface AccountGateResult {
|
612
613
|
/**
|
613
614
|
* The status of the account gate function. SUCCEEDED: The account gate function has determined that the account and Region passes any requirements for a stack set operation to occur. CloudFormation proceeds with the stack operation in that account and Region. FAILED: The account gate function has determined that the account and Region doesn't meet the requirements for a stack set operation to occur. CloudFormation cancels the stack set operation in that account and Region, and sets the stack set operation result status for that account and Region to FAILED. SKIPPED: CloudFormation has skipped calling the account gate function for this account and Region, for one of the following reasons: An account gate function hasn't been specified for the account and Region. CloudFormation proceeds with the stack set operation in this account and Region. The AWSCloudFormationStackSetExecutionRole of the stack set administration account lacks permissions to invoke the function. CloudFormation proceeds with the stack set operation in this account and Region. Either no action is necessary, or no action is possible, on the stack. CloudFormation skips the stack set operation in this account and Region.
|
@@ -1271,6 +1272,10 @@ declare namespace CloudFormation {
|
|
1271
1272
|
* The organization root ID or organizational unit (OU) IDs to which StackSets deploys.
|
1272
1273
|
*/
|
1273
1274
|
OrganizationalUnitIds?: OrganizationalUnitIdList;
|
1275
|
+
/**
|
1276
|
+
* Limit deployment targets to individual accounts or include additional accounts with provided OUs. The following is a list of possible values for the AccountFilterType operation. INTERSECTION: StackSets deploys to the accounts specified in Accounts parameter. DIFFERENCE: StackSets excludes the accounts specified in Accounts parameter. This enables user to avoid certain accounts within an OU such as suspended accounts. UNION: (default value) StackSets includes additional accounts deployment targets. This is the default value if AccountFilterType is not provided. This enables user to update an entire OU and individual accounts from a different OU in one request, which used to be two separate requests. NONE: Deploys to all the accounts in specified organizational units (OU).
|
1277
|
+
*/
|
1278
|
+
AccountFilterType?: AccountFilterType;
|
1274
1279
|
}
|
1275
1280
|
export type DeprecatedStatus = "LIVE"|"DEPRECATED"|string;
|
1276
1281
|
export interface DeregisterTypeInput {
|
@@ -292,11 +292,11 @@ declare class ConfigService extends Service {
|
|
292
292
|
*/
|
293
293
|
describeOrganizationConfigRuleStatuses(callback?: (err: AWSError, data: ConfigService.Types.DescribeOrganizationConfigRuleStatusesResponse) => void): Request<ConfigService.Types.DescribeOrganizationConfigRuleStatusesResponse, AWSError>;
|
294
294
|
/**
|
295
|
-
* Returns a list of organization Config rules. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.
|
295
|
+
* Returns a list of organization Config rules. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules. For accounts within an organzation If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won't be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.
|
296
296
|
*/
|
297
297
|
describeOrganizationConfigRules(params: ConfigService.Types.DescribeOrganizationConfigRulesRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeOrganizationConfigRulesResponse) => void): Request<ConfigService.Types.DescribeOrganizationConfigRulesResponse, AWSError>;
|
298
298
|
/**
|
299
|
-
* Returns a list of organization Config rules. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.
|
299
|
+
* Returns a list of organization Config rules. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules. For accounts within an organzation If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won't be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.
|
300
300
|
*/
|
301
301
|
describeOrganizationConfigRules(callback?: (err: AWSError, data: ConfigService.Types.DescribeOrganizationConfigRulesResponse) => void): Request<ConfigService.Types.DescribeOrganizationConfigRulesResponse, AWSError>;
|
302
302
|
/**
|
@@ -308,11 +308,11 @@ declare class ConfigService extends Service {
|
|
308
308
|
*/
|
309
309
|
describeOrganizationConformancePackStatuses(callback?: (err: AWSError, data: ConfigService.Types.DescribeOrganizationConformancePackStatusesResponse) => void): Request<ConfigService.Types.DescribeOrganizationConformancePackStatusesResponse, AWSError>;
|
310
310
|
/**
|
311
|
-
* Returns a list of organization conformance packs. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.
|
311
|
+
* Returns a list of organization conformance packs. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs. For accounts within an organzation If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won't be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.
|
312
312
|
*/
|
313
313
|
describeOrganizationConformancePacks(params: ConfigService.Types.DescribeOrganizationConformancePacksRequest, callback?: (err: AWSError, data: ConfigService.Types.DescribeOrganizationConformancePacksResponse) => void): Request<ConfigService.Types.DescribeOrganizationConformancePacksResponse, AWSError>;
|
314
314
|
/**
|
315
|
-
* Returns a list of organization conformance packs. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.
|
315
|
+
* Returns a list of organization conformance packs. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs. For accounts within an organzation If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won't be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.
|
316
316
|
*/
|
317
317
|
describeOrganizationConformancePacks(callback?: (err: AWSError, data: ConfigService.Types.DescribeOrganizationConformancePacksResponse) => void): Request<ConfigService.Types.DescribeOrganizationConformancePacksResponse, AWSError>;
|
318
318
|
/**
|
@@ -600,19 +600,19 @@ declare class ConfigService extends Service {
|
|
600
600
|
*/
|
601
601
|
putOrganizationConfigRule(callback?: (err: AWSError, data: ConfigService.Types.PutOrganizationConfigRuleResponse) => void): Request<ConfigService.Types.PutOrganizationConfigRuleResponse, AWSError>;
|
602
602
|
/**
|
603
|
-
* Deploys conformance packs across member accounts in an Amazon Web Services Organization. Only a master account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added. This API enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegate-admin for config-multiaccountsetup.amazonaws.com. Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization. You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter. Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.
|
603
|
+
* Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see Service Limits in the Config Developer Guide. Only a master account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added. An organization can have up to 3 delegated administrators. This API enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegate-admin for config-multiaccountsetup.amazonaws.com. Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization. You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter. Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.
|
604
604
|
*/
|
605
605
|
putOrganizationConformancePack(params: ConfigService.Types.PutOrganizationConformancePackRequest, callback?: (err: AWSError, data: ConfigService.Types.PutOrganizationConformancePackResponse) => void): Request<ConfigService.Types.PutOrganizationConformancePackResponse, AWSError>;
|
606
606
|
/**
|
607
|
-
* Deploys conformance packs across member accounts in an Amazon Web Services Organization. Only a master account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added. This API enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegate-admin for config-multiaccountsetup.amazonaws.com. Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization. You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter. Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.
|
607
|
+
* Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see Service Limits in the Config Developer Guide. Only a master account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added. An organization can have up to 3 delegated administrators. This API enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegate-admin for config-multiaccountsetup.amazonaws.com. Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization. You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter. Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.
|
608
608
|
*/
|
609
609
|
putOrganizationConformancePack(callback?: (err: AWSError, data: ConfigService.Types.PutOrganizationConformancePackResponse) => void): Request<ConfigService.Types.PutOrganizationConformancePackResponse, AWSError>;
|
610
610
|
/**
|
611
|
-
* Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the RemediationConfiguration object for the Config rule. The Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target. If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run. This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.
|
611
|
+
* Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the RemediationConfiguration object for the Config rule. The Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target. If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run. This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub. For manual remediation configuration, you need to provide a value for automationAssumeRole or use a value in the assumeRolefield to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter. However, for automatic remediation configuration, the only valid assumeRole field value is AutomationAssumeRole and you need to provide a value for AutomationAssumeRole to remediate your resources.
|
612
612
|
*/
|
613
613
|
putRemediationConfigurations(params: ConfigService.Types.PutRemediationConfigurationsRequest, callback?: (err: AWSError, data: ConfigService.Types.PutRemediationConfigurationsResponse) => void): Request<ConfigService.Types.PutRemediationConfigurationsResponse, AWSError>;
|
614
614
|
/**
|
615
|
-
* Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the RemediationConfiguration object for the Config rule. The Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target. If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run. This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.
|
615
|
+
* Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the RemediationConfiguration object for the Config rule. The Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target. If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run. This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub. For manual remediation configuration, you need to provide a value for automationAssumeRole or use a value in the assumeRolefield to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter. However, for automatic remediation configuration, the only valid assumeRole field value is AutomationAssumeRole and you need to provide a value for AutomationAssumeRole to remediate your resources.
|
616
616
|
*/
|
617
617
|
putRemediationConfigurations(callback?: (err: AWSError, data: ConfigService.Types.PutRemediationConfigurationsResponse) => void): Request<ConfigService.Types.PutRemediationConfigurationsResponse, AWSError>;
|
618
618
|
/**
|
@@ -1191,7 +1191,7 @@ declare namespace ConfigService {
|
|
1191
1191
|
*/
|
1192
1192
|
InputParameters?: StringWithCharLimit1024;
|
1193
1193
|
/**
|
1194
|
-
* The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
|
1194
|
+
* The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when: This is for an Config managed rule that is triggered at a periodic frequency. Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties. By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
|
1195
1195
|
*/
|
1196
1196
|
MaximumExecutionFrequency?: MaximumExecutionFrequency;
|
1197
1197
|
/**
|
@@ -1442,7 +1442,7 @@ declare namespace ConfigService {
|
|
1442
1442
|
*/
|
1443
1443
|
name?: RecorderName;
|
1444
1444
|
/**
|
1445
|
-
* Amazon Resource Name (ARN) of the IAM role used to describe the Amazon Web Services resources associated with the account.
|
1445
|
+
* Amazon Resource Name (ARN) of the IAM role used to describe the Amazon Web Services resources associated with the account. While the API model does not require this field, the server will reject a request without a defined roleARN for the configuration recorder.
|
1446
1446
|
*/
|
1447
1447
|
roleARN?: String;
|
1448
1448
|
/**
|
@@ -3484,7 +3484,7 @@ declare namespace ConfigService {
|
|
3484
3484
|
*/
|
3485
3485
|
InputParameters?: StringWithCharLimit2048;
|
3486
3486
|
/**
|
3487
|
-
* The maximum frequency with which Config runs evaluations for a rule.
|
3487
|
+
* The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency. By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
|
3488
3488
|
*/
|
3489
3489
|
MaximumExecutionFrequency?: MaximumExecutionFrequency;
|
3490
3490
|
/**
|
@@ -3787,7 +3787,7 @@ declare namespace ConfigService {
|
|
3787
3787
|
*/
|
3788
3788
|
Configuration: Configuration;
|
3789
3789
|
/**
|
3790
|
-
* Tags associated with the resource.
|
3790
|
+
* Tags associated with the resource. This field is not to be confused with the Amazon Web Services-wide tag feature for Amazon Web Services resources. Tags for PutResourceConfig are tags that you supply for the configuration items of your custom resources.
|
3791
3791
|
*/
|
3792
3792
|
Tags?: Tags;
|
3793
3793
|
}
|
@@ -3886,6 +3886,7 @@ declare namespace LexModelsV2 {
|
|
3886
3886
|
variations?: MessageVariationsList;
|
3887
3887
|
}
|
3888
3888
|
export type MessageGroupsList = MessageGroup[];
|
3889
|
+
export type MessageSelectionStrategy = "Random"|"Ordered"|string;
|
3889
3890
|
export type MessageVariationsList = Message[];
|
3890
3891
|
export type MissedCount = number;
|
3891
3892
|
export interface MultipleValuesSetting {
|
@@ -3971,6 +3972,10 @@ declare namespace LexModelsV2 {
|
|
3971
3972
|
* Indicates whether the user can interrupt a speech prompt from the bot.
|
3972
3973
|
*/
|
3973
3974
|
allowInterrupt?: BoxedBoolean;
|
3975
|
+
/**
|
3976
|
+
* Indicates how a message is selected from a message group among retries.
|
3977
|
+
*/
|
3978
|
+
messageSelectionStrategy?: MessageSelectionStrategy;
|
3974
3979
|
}
|
3975
3980
|
export type QueryFilterString = string;
|
3976
3981
|
export type RecommendedAction = string;
|
@@ -20,13 +20,21 @@ declare class QuickSight extends Service {
|
|
20
20
|
*/
|
21
21
|
cancelIngestion(callback?: (err: AWSError, data: QuickSight.Types.CancelIngestionResponse) => void): Request<QuickSight.Types.CancelIngestionResponse, AWSError>;
|
22
22
|
/**
|
23
|
-
* Creates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
|
23
|
+
* Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
|
24
24
|
*/
|
25
25
|
createAccountCustomization(params: QuickSight.Types.CreateAccountCustomizationRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateAccountCustomizationResponse) => void): Request<QuickSight.Types.CreateAccountCustomizationResponse, AWSError>;
|
26
26
|
/**
|
27
|
-
* Creates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
|
27
|
+
* Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
|
28
28
|
*/
|
29
29
|
createAccountCustomization(callback?: (err: AWSError, data: QuickSight.Types.CreateAccountCustomizationResponse) => void): Request<QuickSight.Types.CreateAccountCustomizationResponse, AWSError>;
|
30
|
+
/**
|
31
|
+
* Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q. The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region. Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide. If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny, the Deny action prevails and your API call fails. You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide. You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.
|
32
|
+
*/
|
33
|
+
createAccountSubscription(params: QuickSight.Types.CreateAccountSubscriptionRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateAccountSubscriptionResponse) => void): Request<QuickSight.Types.CreateAccountSubscriptionResponse, AWSError>;
|
34
|
+
/**
|
35
|
+
* Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q. The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region. Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide. If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny, the Deny action prevails and your API call fails. You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide. You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.
|
36
|
+
*/
|
37
|
+
createAccountSubscription(callback?: (err: AWSError, data: QuickSight.Types.CreateAccountSubscriptionResponse) => void): Request<QuickSight.Types.CreateAccountSubscriptionResponse, AWSError>;
|
30
38
|
/**
|
31
39
|
* Creates an analysis in Amazon QuickSight.
|
32
40
|
*/
|
@@ -299,6 +307,14 @@ declare class QuickSight extends Service {
|
|
299
307
|
* Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
|
300
308
|
*/
|
301
309
|
describeAccountSettings(callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountSettingsResponse) => void): Request<QuickSight.Types.DescribeAccountSettingsResponse, AWSError>;
|
310
|
+
/**
|
311
|
+
* Use the DescribeAccountSubscription operation to receive a description of a Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.
|
312
|
+
*/
|
313
|
+
describeAccountSubscription(params: QuickSight.Types.DescribeAccountSubscriptionRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountSubscriptionResponse) => void): Request<QuickSight.Types.DescribeAccountSubscriptionResponse, AWSError>;
|
314
|
+
/**
|
315
|
+
* Use the DescribeAccountSubscription operation to receive a description of a Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.
|
316
|
+
*/
|
317
|
+
describeAccountSubscription(callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountSubscriptionResponse) => void): Request<QuickSight.Types.DescribeAccountSubscriptionResponse, AWSError>;
|
302
318
|
/**
|
303
319
|
* Provides a summary of the metadata for an analysis.
|
304
320
|
*/
|
@@ -492,11 +508,11 @@ declare class QuickSight extends Service {
|
|
492
508
|
*/
|
493
509
|
describeUser(callback?: (err: AWSError, data: QuickSight.Types.DescribeUserResponse) => void): Request<QuickSight.Types.DescribeUserResponse, AWSError>;
|
494
510
|
/**
|
495
|
-
* Generates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions. The following rules apply to the generated URL: It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again. The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
|
511
|
+
* Generates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions. The following rules apply to the generated URL: It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again. The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. You are charged only when the URL is used or there is interaction with Amazon QuickSight. For more information, see Embedded Analytics in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
|
496
512
|
*/
|
497
513
|
generateEmbedUrlForAnonymousUser(params: QuickSight.Types.GenerateEmbedUrlForAnonymousUserRequest, callback?: (err: AWSError, data: QuickSight.Types.GenerateEmbedUrlForAnonymousUserResponse) => void): Request<QuickSight.Types.GenerateEmbedUrlForAnonymousUserResponse, AWSError>;
|
498
514
|
/**
|
499
|
-
* Generates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions. The following rules apply to the generated URL: It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again. The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
|
515
|
+
* Generates an embed URL that you can use to embed an Amazon QuickSight dashboard in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions. The following rules apply to the generated URL: It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again. The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. You are charged only when the URL is used or there is interaction with Amazon QuickSight. For more information, see Embedded Analytics in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
|
500
516
|
*/
|
501
517
|
generateEmbedUrlForAnonymousUser(callback?: (err: AWSError, data: QuickSight.Types.GenerateEmbedUrlForAnonymousUserResponse) => void): Request<QuickSight.Types.GenerateEmbedUrlForAnonymousUserResponse, AWSError>;
|
502
518
|
/**
|
@@ -508,11 +524,11 @@ declare class QuickSight extends Service {
|
|
508
524
|
*/
|
509
525
|
generateEmbedUrlForRegisteredUser(callback?: (err: AWSError, data: QuickSight.Types.GenerateEmbedUrlForRegisteredUserResponse) => void): Request<QuickSight.Types.GenerateEmbedUrlForRegisteredUserResponse, AWSError>;
|
510
526
|
/**
|
511
|
-
* Generates a session URL and authorization code that you can use to embed an Amazon
|
527
|
+
* Generates a temporary session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions. Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL: They must be used together. They can be used one time only. They are valid for 5 minutes after you run this command. The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customi session duration. For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
|
512
528
|
*/
|
513
529
|
getDashboardEmbedUrl(params: QuickSight.Types.GetDashboardEmbedUrlRequest, callback?: (err: AWSError, data: QuickSight.Types.GetDashboardEmbedUrlResponse) => void): Request<QuickSight.Types.GetDashboardEmbedUrlResponse, AWSError>;
|
514
530
|
/**
|
515
|
-
* Generates a session URL and authorization code that you can use to embed an Amazon
|
531
|
+
* Generates a temporary session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions. Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL: They must be used together. They can be used one time only. They are valid for 5 minutes after you run this command. The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customi session duration. For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
|
516
532
|
*/
|
517
533
|
getDashboardEmbedUrl(callback?: (err: AWSError, data: QuickSight.Types.GetDashboardEmbedUrlResponse) => void): Request<QuickSight.Types.GetDashboardEmbedUrlResponse, AWSError>;
|
518
534
|
/**
|
@@ -764,11 +780,11 @@ declare class QuickSight extends Service {
|
|
764
780
|
*/
|
765
781
|
untagResource(callback?: (err: AWSError, data: QuickSight.Types.UntagResourceResponse) => void): Request<QuickSight.Types.UntagResourceResponse, AWSError>;
|
766
782
|
/**
|
767
|
-
* Updates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, the only customization you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
|
783
|
+
* Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
|
768
784
|
*/
|
769
785
|
updateAccountCustomization(params: QuickSight.Types.UpdateAccountCustomizationRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateAccountCustomizationResponse) => void): Request<QuickSight.Types.UpdateAccountCustomizationResponse, AWSError>;
|
770
786
|
/**
|
771
|
-
* Updates Amazon QuickSight customizations the current Amazon Web Services Region. Currently, the only customization you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
|
787
|
+
* Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
|
772
788
|
*/
|
773
789
|
updateAccountCustomization(callback?: (err: AWSError, data: QuickSight.Types.UpdateAccountCustomizationResponse) => void): Request<QuickSight.Types.UpdateAccountCustomizationResponse, AWSError>;
|
774
790
|
/**
|
@@ -892,11 +908,11 @@ declare class QuickSight extends Service {
|
|
892
908
|
*/
|
893
909
|
updateIpRestriction(callback?: (err: AWSError, data: QuickSight.Types.UpdateIpRestrictionResponse) => void): Request<QuickSight.Types.UpdateIpRestrictionResponse, AWSError>;
|
894
910
|
/**
|
895
|
-
* Use the UpdatePublicSharingSettings operation to
|
911
|
+
* Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard. To use this operation, turn on session capacity pricing for your Amazon QuickSight account. Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.
|
896
912
|
*/
|
897
913
|
updatePublicSharingSettings(params: QuickSight.Types.UpdatePublicSharingSettingsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdatePublicSharingSettingsResponse) => void): Request<QuickSight.Types.UpdatePublicSharingSettingsResponse, AWSError>;
|
898
914
|
/**
|
899
|
-
* Use the UpdatePublicSharingSettings operation to
|
915
|
+
* Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard. To use this operation, turn on session capacity pricing for your Amazon QuickSight account. Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.
|
900
916
|
*/
|
901
917
|
updatePublicSharingSettings(callback?: (err: AWSError, data: QuickSight.Types.UpdatePublicSharingSettingsResponse) => void): Request<QuickSight.Types.UpdatePublicSharingSettingsResponse, AWSError>;
|
902
918
|
/**
|
@@ -967,6 +983,28 @@ declare namespace QuickSight {
|
|
967
983
|
*/
|
968
984
|
DefaultEmailCustomizationTemplate?: Arn;
|
969
985
|
}
|
986
|
+
export interface AccountInfo {
|
987
|
+
/**
|
988
|
+
* The account name that you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It's unique over all of Amazon Web Services, and it appears only when users sign in.
|
989
|
+
*/
|
990
|
+
AccountName?: String;
|
991
|
+
/**
|
992
|
+
* The edition of your Amazon QuickSight account.
|
993
|
+
*/
|
994
|
+
Edition?: Edition;
|
995
|
+
/**
|
996
|
+
* The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.
|
997
|
+
*/
|
998
|
+
NotificationEmail?: String;
|
999
|
+
/**
|
1000
|
+
* The way that your Amazon QuickSight account is authenticated.
|
1001
|
+
*/
|
1002
|
+
AuthenticationType?: String;
|
1003
|
+
/**
|
1004
|
+
* The status of your account subscription.
|
1005
|
+
*/
|
1006
|
+
AccountSubscriptionStatus?: String;
|
1007
|
+
}
|
970
1008
|
export interface AccountSettings {
|
971
1009
|
/**
|
972
1010
|
* The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it appears only when users sign in.
|
@@ -985,7 +1023,7 @@ declare namespace QuickSight {
|
|
985
1023
|
*/
|
986
1024
|
NotificationEmail?: String;
|
987
1025
|
/**
|
988
|
-
* A
|
1026
|
+
* A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings.
|
989
1027
|
*/
|
990
1028
|
PublicSharingEnabled?: Boolean;
|
991
1029
|
}
|
@@ -1184,6 +1222,7 @@ declare namespace QuickSight {
|
|
1184
1222
|
*/
|
1185
1223
|
Database: Database;
|
1186
1224
|
}
|
1225
|
+
export type AuthenticationMethodOption = "IAM_AND_QUICKSIGHT"|"IAM_ONLY"|"ACTIVE_DIRECTORY"|string;
|
1187
1226
|
export type AwsAccountId = string;
|
1188
1227
|
export type AwsAndAccountId = string;
|
1189
1228
|
export interface AwsIotAnalyticsParameters {
|
@@ -1386,6 +1425,82 @@ declare namespace QuickSight {
|
|
1386
1425
|
*/
|
1387
1426
|
Status?: StatusCode;
|
1388
1427
|
}
|
1428
|
+
export interface CreateAccountSubscriptionRequest {
|
1429
|
+
/**
|
1430
|
+
* The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q. If you choose ENTERPRISE_AND_Q, the following parameters are required: FirstName LastName EmailAddress ContactNumber
|
1431
|
+
*/
|
1432
|
+
Edition: Edition;
|
1433
|
+
/**
|
1434
|
+
* The method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for this parameter are IAM_AND_QUICKSIGHT, IAM_ONLY, and ACTIVE_DIRECTORY. If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory.
|
1435
|
+
*/
|
1436
|
+
AuthenticationMethod: AuthenticationMethodOption;
|
1437
|
+
/**
|
1438
|
+
* The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.
|
1439
|
+
*/
|
1440
|
+
AwsAccountId: AwsAccountId;
|
1441
|
+
/**
|
1442
|
+
* The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change AccountName value after the Amazon QuickSight account is created.
|
1443
|
+
*/
|
1444
|
+
AccountName: String;
|
1445
|
+
/**
|
1446
|
+
* The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.
|
1447
|
+
*/
|
1448
|
+
NotificationEmail: String;
|
1449
|
+
/**
|
1450
|
+
* The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
|
1451
|
+
*/
|
1452
|
+
ActiveDirectoryName?: String;
|
1453
|
+
/**
|
1454
|
+
* The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
|
1455
|
+
*/
|
1456
|
+
Realm?: String;
|
1457
|
+
/**
|
1458
|
+
* The ID of the Active Directory that is associated with your Amazon QuickSight account.
|
1459
|
+
*/
|
1460
|
+
DirectoryId?: String;
|
1461
|
+
/**
|
1462
|
+
* The admin group associated with your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
|
1463
|
+
*/
|
1464
|
+
AdminGroup?: GroupsList;
|
1465
|
+
/**
|
1466
|
+
* The author group associated with your Active Directory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
|
1467
|
+
*/
|
1468
|
+
AuthorGroup?: GroupsList;
|
1469
|
+
/**
|
1470
|
+
* The reader group associated with your Active Direcrtory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
|
1471
|
+
*/
|
1472
|
+
ReaderGroup?: GroupsList;
|
1473
|
+
/**
|
1474
|
+
* The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
|
1475
|
+
*/
|
1476
|
+
FirstName?: String;
|
1477
|
+
/**
|
1478
|
+
* The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
|
1479
|
+
*/
|
1480
|
+
LastName?: String;
|
1481
|
+
/**
|
1482
|
+
* The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
|
1483
|
+
*/
|
1484
|
+
EmailAddress?: String;
|
1485
|
+
/**
|
1486
|
+
* A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
|
1487
|
+
*/
|
1488
|
+
ContactNumber?: String;
|
1489
|
+
}
|
1490
|
+
export interface CreateAccountSubscriptionResponse {
|
1491
|
+
/**
|
1492
|
+
* A SignupResponse object that returns information about a newly created Amazon QuickSight account.
|
1493
|
+
*/
|
1494
|
+
SignupResponse?: SignupResponse;
|
1495
|
+
/**
|
1496
|
+
* The HTTP status of the request.
|
1497
|
+
*/
|
1498
|
+
Status?: StatusCode;
|
1499
|
+
/**
|
1500
|
+
* The Amazon Web Services request ID for this operation.
|
1501
|
+
*/
|
1502
|
+
RequestId?: String;
|
1503
|
+
}
|
1389
1504
|
export interface CreateAnalysisRequest {
|
1390
1505
|
/**
|
1391
1506
|
* The ID of the Amazon Web Services account where you are creating an analysis.
|
@@ -3241,7 +3356,7 @@ declare namespace QuickSight {
|
|
3241
3356
|
}
|
3242
3357
|
export interface DescribeAccountSettingsResponse {
|
3243
3358
|
/**
|
3244
|
-
* The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the Amazon QuickSight subscription.
|
3359
|
+
* The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the Amazon QuickSight subscription. In the QuickSight console, the Amazon QuickSight subscription is sometimes referred to as a QuickSight "account" even though it's technically not an account by itself. Instead, it's a subscription to the Amazon QuickSight service for your Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.
|
3245
3360
|
*/
|
3246
3361
|
AccountSettings?: AccountSettings;
|
3247
3362
|
/**
|
@@ -3253,6 +3368,26 @@ declare namespace QuickSight {
|
|
3253
3368
|
*/
|
3254
3369
|
Status?: StatusCode;
|
3255
3370
|
}
|
3371
|
+
export interface DescribeAccountSubscriptionRequest {
|
3372
|
+
/**
|
3373
|
+
* The Amazon Web Services account ID associated with your Amazon QuickSight account.
|
3374
|
+
*/
|
3375
|
+
AwsAccountId: AwsAccountId;
|
3376
|
+
}
|
3377
|
+
export interface DescribeAccountSubscriptionResponse {
|
3378
|
+
/**
|
3379
|
+
* A structure that contains the following elements: Your Amazon QuickSight account name. The edition of Amazon QuickSight that your account is using. The notification email address that is associated with the Amazon QuickSight account. The authentication type of the Amazon QuickSight account. The status of the Amazon QuickSight account's subscription.
|
3380
|
+
*/
|
3381
|
+
AccountInfo?: AccountInfo;
|
3382
|
+
/**
|
3383
|
+
* The HTTP status of the request.
|
3384
|
+
*/
|
3385
|
+
Status?: StatusCode;
|
3386
|
+
/**
|
3387
|
+
* The Amazon Web Services request ID for this operation.
|
3388
|
+
*/
|
3389
|
+
RequestId?: String;
|
3390
|
+
}
|
3256
3391
|
export interface DescribeAnalysisPermissionsRequest {
|
3257
3392
|
/**
|
3258
3393
|
* The ID of the Amazon Web Services account that contains the analysis whose permissions you're describing. You must be using the Amazon Web Services account that the analysis is in.
|
@@ -3957,7 +4092,7 @@ declare namespace QuickSight {
|
|
3957
4092
|
export type Domain = string;
|
3958
4093
|
export type Double = number;
|
3959
4094
|
export type DoubleList = Double[];
|
3960
|
-
export type Edition = "STANDARD"|"ENTERPRISE"|string;
|
4095
|
+
export type Edition = "STANDARD"|"ENTERPRISE"|"ENTERPRISE_AND_Q"|string;
|
3961
4096
|
export type EmbeddingIdentityType = "IAM"|"QUICKSIGHT"|"ANONYMOUS"|string;
|
3962
4097
|
export type EmbeddingUrl = string;
|
3963
4098
|
export type EntryPath = string;
|
@@ -4111,17 +4246,21 @@ declare namespace QuickSight {
|
|
4111
4246
|
*/
|
4112
4247
|
Namespace: Namespace;
|
4113
4248
|
/**
|
4114
|
-
* The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security. These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with
|
4249
|
+
* The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security. These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
|
4115
4250
|
*/
|
4116
4251
|
SessionTags?: SessionTagList;
|
4117
4252
|
/**
|
4118
|
-
* The Amazon Resource Names for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view. Currently, you can pass up to 25 dashboard ARNs in each API call.
|
4253
|
+
* The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view. Currently, you can pass up to 25 dashboard ARNs in each API call.
|
4119
4254
|
*/
|
4120
4255
|
AuthorizedResourceArns: ArnList;
|
4121
4256
|
/**
|
4122
|
-
* The configuration of the experience you are embedding.
|
4257
|
+
* The configuration of the experience that you are embedding.
|
4123
4258
|
*/
|
4124
4259
|
ExperienceConfiguration: AnonymousUserEmbeddingExperienceConfiguration;
|
4260
|
+
/**
|
4261
|
+
* The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console and instead allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call. To include a subdomain, use * to include all subdomains under a specific domain to the allow list. For example, https://*.sapp.amazon.com, includes all subdomains under https://sapp.amazon.com.
|
4262
|
+
*/
|
4263
|
+
AllowedDomains?: StringList;
|
4125
4264
|
}
|
4126
4265
|
export interface GenerateEmbedUrlForAnonymousUserResponse {
|
4127
4266
|
/**
|
@@ -4154,6 +4293,10 @@ declare namespace QuickSight {
|
|
4154
4293
|
* The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards or the entire Amazon QuickSight console.
|
4155
4294
|
*/
|
4156
4295
|
ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration;
|
4296
|
+
/**
|
4297
|
+
* The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console and instead allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call. To include a subdomain, use * to include all subdomains under a specific domain to the allow list. For example, https://*.sapp.amazon.com, includes all subdomains under https://sapp.amazon.com.
|
4298
|
+
*/
|
4299
|
+
AllowedDomains?: StringList;
|
4157
4300
|
}
|
4158
4301
|
export interface GenerateEmbedUrlForRegisteredUserResponse {
|
4159
4302
|
/**
|
@@ -4223,7 +4366,7 @@ declare namespace QuickSight {
|
|
4223
4366
|
*/
|
4224
4367
|
Namespace?: Namespace;
|
4225
4368
|
/**
|
4226
|
-
* A list of one or more dashboard IDs that you want
|
4369
|
+
* A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.
|
4227
4370
|
*/
|
4228
4371
|
AdditionalDashboardIds?: AdditionalDashboardIdList;
|
4229
4372
|
}
|
@@ -4323,6 +4466,7 @@ declare namespace QuickSight {
|
|
4323
4466
|
Value: String;
|
4324
4467
|
}
|
4325
4468
|
export type GroupSearchFilterList = GroupSearchFilter[];
|
4469
|
+
export type GroupsList = String[];
|
4326
4470
|
export interface GutterStyle {
|
4327
4471
|
/**
|
4328
4472
|
* This Boolean value controls whether to display a gutter space between sheet tiles.
|
@@ -5618,7 +5762,7 @@ declare namespace QuickSight {
|
|
5618
5762
|
*/
|
5619
5763
|
QuickSightConsole?: RegisteredUserQuickSightConsoleEmbeddingConfiguration;
|
5620
5764
|
/**
|
5621
|
-
* The configuration details for embedding the Q search bar. For more information about embedding the Q search bar, see Embedding Overview.
|
5765
|
+
* The configuration details for embedding the Q search bar. For more information about embedding the Q search bar, see Embedding Overview in the Amazon QuickSight User Guide.
|
5622
5766
|
*/
|
5623
5767
|
QSearchBar?: RegisteredUserQSearchBarEmbeddingConfiguration;
|
5624
5768
|
}
|
@@ -5999,6 +6143,24 @@ declare namespace QuickSight {
|
|
5999
6143
|
*/
|
6000
6144
|
TileLayout?: TileLayoutStyle;
|
6001
6145
|
}
|
6146
|
+
export interface SignupResponse {
|
6147
|
+
/**
|
6148
|
+
* A Boolean that is TRUE if the Amazon QuickSight uses IAM as an authentication method.
|
6149
|
+
*/
|
6150
|
+
IAMUser?: Boolean;
|
6151
|
+
/**
|
6152
|
+
* The user login name for your Amazon QuickSight account.
|
6153
|
+
*/
|
6154
|
+
userLoginName?: String;
|
6155
|
+
/**
|
6156
|
+
* The name of your Amazon QuickSight account.
|
6157
|
+
*/
|
6158
|
+
accountName?: String;
|
6159
|
+
/**
|
6160
|
+
* The type of Active Directory that is being used to authenticate the Amazon QuickSight account. Valid values are SIMPLE_AD, AD_CONNECTOR, and MICROSOFT_AD.
|
6161
|
+
*/
|
6162
|
+
directoryType?: String;
|
6163
|
+
}
|
6002
6164
|
export type SiteBaseUrl = string;
|
6003
6165
|
export interface SnowflakeParameters {
|
6004
6166
|
/**
|
@@ -6640,7 +6802,7 @@ declare namespace QuickSight {
|
|
6640
6802
|
*/
|
6641
6803
|
AwsAccountId: AwsAccountId;
|
6642
6804
|
/**
|
6643
|
-
* The default namespace for this Amazon Web Services account. Currently, the default is default. Identity and Access Management (IAM) users that register for the first time with Amazon QuickSight provide an email that becomes associated with the default namespace.
|
6805
|
+
* The default namespace for this Amazon Web Services account. Currently, the default is default. Identity and Access Management (IAM) users that register for the first time with Amazon QuickSight provide an email address that becomes associated with the default namespace.
|
6644
6806
|
*/
|
6645
6807
|
DefaultNamespace: Namespace;
|
6646
6808
|
/**
|
@@ -7282,7 +7444,7 @@ declare namespace QuickSight {
|
|
7282
7444
|
*/
|
7283
7445
|
AwsAccountId: AwsAccountId;
|
7284
7446
|
/**
|
7285
|
-
* A
|
7447
|
+
* A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.
|
7286
7448
|
*/
|
7287
7449
|
PublicSharingEnabled?: Boolean;
|
7288
7450
|
}
|