Information on the dataset.
* @public */ DataSet?: DataSet | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeDataSetPermissionsRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID for the dataset that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ DataSetId: string | undefined; } /** * @public */ export interface DescribeDataSetPermissionsResponse { /** *The Amazon Resource Name (ARN) of the dataset.
* @public */ DataSetArn?: string | undefined; /** *The ID for the dataset that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ DataSetId?: string | undefined; /** *A list of resource permissions on the dataset.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeDataSetRefreshPropertiesRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the dataset.
* @public */ DataSetId: string | undefined; } /** * @public */ export interface DescribeDataSetRefreshPropertiesResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The dataset refresh properties.
* @public */ DataSetRefreshProperties?: DataSetRefreshProperties | undefined; } /** * @public */ export interface DescribeDataSourceRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the data source. This ID is unique per Amazon Web Services Region for each * Amazon Web Services account.
* @public */ DataSourceId: string | undefined; } /** * @public */ export interface DescribeDataSourceResponse { /** *The information on the data source.
* @public */ DataSource?: DataSource | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeDataSourcePermissionsRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the data source. This ID is unique per Amazon Web Services Region for each * Amazon Web Services account.
* @public */ DataSourceId: string | undefined; } /** * @public */ export interface DescribeDataSourcePermissionsResponse { /** *The Amazon Resource Name (ARN) of the data source.
* @public */ DataSourceArn?: string | undefined; /** *The ID of the data source. This ID is unique per Amazon Web Services Region for each * Amazon Web Services account.
* @public */ DataSourceId?: string | undefined; /** *A list of resource permissions on the data source.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeDefaultQBusinessApplicationRequest { /** *The ID of the Quick Sight account that is linked to the Amazon Q Business application that you want described.
* @public */ AwsAccountId: string | undefined; /** *The Quick Sight namespace that contains the linked Amazon Q Business application. If this field is left blank, the default namespace is used. Currently, the default namespace is the only valid value for this parameter.
* @public */ Namespace?: string | undefined; } /** * @public */ export interface DescribeDefaultQBusinessApplicationResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The ID of the Amazon Q Business application that is linked to the Quick Sight account.
* @public */ ApplicationId?: string | undefined; } /** * @public */ export interface DescribeFlowRequest { /** *The ID of the Amazon Web Services account that contains the flow that you are describing.
* @public */ AwsAccountId: string | undefined; /** *The unique identifier of the flow.
* @public */ FlowId: string | undefined; /** *The publish state of the flow version to describe. Valid values are DRAFT, PUBLISHED,
* or PENDING_APPROVAL.
A mapping between a step identifier and its alias in a flow.
* @public */ export interface StepAliasMapping { /** *The unique identifier of the step.
* @public */ StepId: string | undefined; /** *The alias for the step.
* @public */ StepAlias: string | undefined; } /** *The full details of a flow, including its definition specifying the steps.
* @public */ export interface FlowDetail { /** *The Amazon Resource Name (ARN) of the flow.
* @public */ Arn: string | undefined; /** *The unique identifier of the flow.
* @public */ FlowId: string | undefined; /** *The display name of the flow.
* @public */ Name: string | undefined; /** *The description of the flow.
* @public */ Description?: string | undefined; /** *The publish state of the flow. Valid values are DRAFT, PUBLISHED,
* or PENDING_APPROVAL.
The time this flow was created.
* @public */ CreatedTime: Date | undefined; /** *The identifier of the principal who created the flow.
* @public */ CreatedBy?: string | undefined; /** *The last time this flow was modified.
* @public */ LastUpdatedTime?: Date | undefined; /** *The identifier of the last principal who updated the flow.
* @public */ LastUpdatedBy?: string | undefined; /** *The definition of the flow, specifying the steps and configurations. This is the flow definition in Quick Flow's internal format. The format is subject to change.
* @public */ FlowDefinition: __DocumentType | undefined; /** *A list of step alias mappings for the flow.
* @public */ StepAliases?: StepAliasMapping[] | undefined; } /** * @public */ export interface DescribeFlowResponse { /** *The full details of the flow.
* @public */ Flow: FlowDetail | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeFolderRequest { /** *The ID for the Amazon Web Services account that contains the folder.
* @public */ AwsAccountId: string | undefined; /** *The ID of the folder.
* @public */ FolderId: string | undefined; } /** *A folder in Quick Sight.
* @public */ export interface Folder { /** *The ID of the folder.
* @public */ FolderId?: string | undefined; /** *The Amazon Resource Name (ARN) for the folder.
* @public */ Arn?: string | undefined; /** *A display name for the folder.
* @public */ Name?: string | undefined; /** *The type of folder it is.
* @public */ FolderType?: FolderType | undefined; /** *An array of ancestor ARN strings for the folder.
* @public */ FolderPath?: string[] | undefined; /** *The time that the folder was created.
* @public */ CreatedTime?: Date | undefined; /** *The time that the folder was last updated.
* @public */ LastUpdatedTime?: Date | undefined; /** *The sharing scope of the folder.
* @public */ SharingModel?: SharingModel | undefined; } /** * @public */ export interface DescribeFolderResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *Information about the folder.
* @public */ Folder?: Folder | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeFolderPermissionsRequest { /** *The ID for the Amazon Web Services account that contains the folder.
* @public */ AwsAccountId: string | undefined; /** *The ID of the folder.
* @public */ FolderId: string | undefined; /** *The namespace of the folder whose permissions you want described.
* @public */ Namespace?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; /** *A pagination token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface DescribeFolderPermissionsResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The ID of the folder.
* @public */ FolderId?: string | undefined; /** *The Amazon Resource Name (ARN) for the folder.
* @public */ Arn?: string | undefined; /** *Information about the permissions on the folder.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The pagination token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface DescribeFolderResolvedPermissionsRequest { /** *The ID for the Amazon Web Services account that contains the folder.
* @public */ AwsAccountId: string | undefined; /** *The ID of the folder.
* @public */ FolderId: string | undefined; /** *The namespace of the folder whose permissions you want described.
* @public */ Namespace?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; /** *A pagination token for the next set of results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface DescribeFolderResolvedPermissionsResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The ID of the folder.
* @public */ FolderId?: string | undefined; /** *The Amazon Resource Name (ARN) of the folder.
* @public */ Arn?: string | undefined; /** *Information about the permissions for the folder.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *A pagination token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface DescribeGroupRequest { /** *The name of the group that you want to describe.
* @public */ GroupName: string | undefined; /** *The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace of the group that you want described.
* @public */ Namespace: string | undefined; } /** * @public */ export interface DescribeGroupResponse { /** *The name of the group.
* @public */ Group?: Group | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeGroupMembershipRequest { /** *The user name of the user that you want to search for.
* @public */ MemberName: string | undefined; /** *The name of the group that you want to search.
* @public */ GroupName: string | undefined; /** *The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace that includes the group you are searching within.
* @public */ Namespace: string | undefined; } /** * @public */ export interface DescribeGroupMembershipResponse { /** *A member of an Quick Sight group. Currently, group members must be users. Groups * can't be members of another group. .
* @public */ GroupMember?: GroupMember | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeIAMPolicyAssignmentRequest { /** *The ID of the Amazon Web Services account that contains the assignment that you want to * describe.
* @public */ AwsAccountId: string | undefined; /** *The name of the assignment, also called a rule.
* @public */ AssignmentName: string | undefined; /** *The namespace that contains the assignment.
* @public */ Namespace: string | undefined; } /** *An Identity and Access Management (IAM) policy assignment.
* @public */ export interface IAMPolicyAssignment { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId?: string | undefined; /** *Assignment ID.
* @public */ AssignmentId?: string | undefined; /** *Assignment name.
* @public */ AssignmentName?: string | undefined; /** *The Amazon Resource Name (ARN) for the IAM policy.
* @public */ PolicyArn?: string | undefined; /** *Identities.
* @public */ Identities?: RecordAssignment status.
* @public */ AssignmentStatus?: AssignmentStatus | undefined; } /** * @public */ export interface DescribeIAMPolicyAssignmentResponse { /** *Information describing the IAM policy assignment.
* @public */ IAMPolicyAssignment?: IAMPolicyAssignment | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeIngestionRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the dataset used in the ingestion.
* @public */ DataSetId: string | undefined; /** *An ID for the ingestion.
* @public */ IngestionId: string | undefined; } /** *Error information for the SPICE ingestion of a dataset.
* @public */ export interface ErrorInfo { /** *Error type.
* @public */ Type?: IngestionErrorType | undefined; /** *Error message.
* @public */ Message?: string | undefined; } /** *Information about a queued dataset SPICE ingestion.
* @public */ export interface QueueInfo { /** *The ID of the queued ingestion.
* @public */ WaitingOnIngestion: string | undefined; /** *The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing * ingestion to complete.
* @public */ QueuedIngestion: string | undefined; } /** *Information about rows for a data set SPICE ingestion.
* @public */ export interface RowInfo { /** *The number of rows that were ingested.
* @public */ RowsIngested?: number | undefined; /** *The number of rows that were not ingested.
* @public */ RowsDropped?: number | undefined; /** *The total number of rows in the dataset.
* @public */ TotalRowsInDataset?: number | undefined; } /** *Information about the SPICE ingestion for a dataset.
* @public */ export interface Ingestion { /** *The Amazon Resource Name (ARN) of the resource.
* @public */ Arn: string | undefined; /** *Ingestion ID.
* @public */ IngestionId?: string | undefined; /** *Ingestion status.
* @public */ IngestionStatus: IngestionStatus | undefined; /** *Error information for this ingestion.
* @public */ ErrorInfo?: ErrorInfo | undefined; /** *Information about rows for a data set SPICE ingestion.
* @public */ RowInfo?: RowInfo | undefined; /** *Information about a queued dataset SPICE ingestion.
* @public */ QueueInfo?: QueueInfo | undefined; /** *The time that this ingestion started.
* @public */ CreatedTime: Date | undefined; /** *The time that this ingestion took, measured in seconds.
* @public */ IngestionTimeInSeconds?: number | undefined; /** *The size of the data ingested, in bytes.
* @public */ IngestionSizeInBytes?: number | undefined; /** *Event source for this ingestion.
* @public */ RequestSource?: IngestionRequestSource | undefined; /** *Type of this ingestion.
* @public */ RequestType?: IngestionRequestType | undefined; } /** * @public */ export interface DescribeIngestionResponse { /** *Information about the ingestion.
* @public */ Ingestion?: Ingestion | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeIpRestrictionRequest { /** *The ID of the Amazon Web Services account that contains the IP rules.
* @public */ AwsAccountId: string | undefined; } /** * @public */ export interface DescribeIpRestrictionResponse { /** *The ID of the Amazon Web Services account that contains the IP rules.
* @public */ AwsAccountId?: string | undefined; /** *A map that describes the IP rules with CIDR range and description.
* @public */ IpRestrictionRuleMap?: RecordA map of allowed VPC IDs and their rule descriptions.
* @public */ VpcIdRestrictionRuleMap?: RecordA map of allowed VPC endpoint IDs and their rule descriptions.
* @public */ VpcEndpointIdRestrictionRuleMap?: RecordA value that specifies whether IP rules are turned on.
* @public */ Enabled?: boolean | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request. *
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeKeyRegistrationRequest { /** *The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.
* @public */ AwsAccountId: string | undefined; /** *Determines whether the request returns the default key only.
* @public */ DefaultKeyOnly?: boolean | undefined; } /** *A customer managed key structure that contains the information listed below:
*
* KeyArn - The ARN of a KMS key that is registered to a Quick Sight account for encryption and decryption use.
* DefaultKey - Indicates whether the current key is set as the default key for encryption and decryption use.
The ARN of the KMS key that is registered to a Quick Sight account for encryption and decryption use.
* @public */ KeyArn?: string | undefined; /** *Indicates whether a RegisteredCustomerManagedKey is set as the default key for encryption and decryption use.
A structure that contains information about the QDataKey.
The ARN of the KMS key that is registered to a Quick Sight account for encryption and decryption use as a QDataKey.
The type of QDataKey.
The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request.
* @public */ AwsAccountId?: string | undefined; /** *A list of RegisteredCustomerManagedKey objects in a Quick Sight account.
A list of QDataKey objects in a Quick Sight account.
The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeKnowledgeBaseRequest { /** *The ID of the Amazon Web Services account that contains the knowledge base.
* @public */ AwsAccountId: string | undefined; /** *The unique identifier for the knowledge base.
* @public */ KnowledgeBaseId: string | undefined; } /** *A summary of an ingestion job for a knowledge base.
* @public */ export interface KnowledgeBaseIngestionSummary { /** *The unique identifier for the ingestion job.
* @public */ IngestionId: string | undefined; /** *The status of the ingestion job.
* @public */ IngestionStatus: KbIngestionStatus | undefined; /** *The start time of the ingestion job.
* @public */ StartTime?: Date | undefined; /** *The end time of the ingestion job.
* @public */ EndTime?: Date | undefined; } /** *The template configuration for a knowledge base.
* @public */ export interface KbTemplateConfiguration { /** *The template document that defines the knowledge base behavior.
* @public */ template?: __DocumentType | undefined; } /** *The configuration settings for a knowledge base.
* @public */ export interface KnowledgeBaseConfiguration { /** *The template configuration for the knowledge base.
* @public */ templateConfiguration?: KbTemplateConfiguration | undefined; /** *Indicates whether event notifications are enabled for the knowledge base.
* @public */ eventEnabled?: boolean | undefined; } /** *The configuration for image extraction from knowledge base documents.
* @public */ export interface ImageExtractionConfiguration { /** *The status of image extraction. Valid values are ENABLED and DISABLED.
* @public */ imageExtractionStatus: ImageExtractionStatus | undefined; } /** *The configuration for video extraction from knowledge base documents.
* @public */ export interface VideoExtractionConfiguration { /** *The status of video extraction. Valid values are ENABLED and DISABLED.
* @public */ videoExtractionStatus: VideoExtractionStatus | undefined; /** *The type of video extraction to perform.
* @public */ videoExtractionType?: VideoExtractionType | undefined; } /** *The configuration for media extraction from knowledge base documents.
* @public */ export interface MediaExtractionConfiguration { /** *The configuration for image extraction.
* @public */ imageExtractionConfiguration?: ImageExtractionConfiguration | undefined; /** *The configuration for audio extraction.
* @public */ audioExtractionConfiguration?: AudioExtractionConfiguration | undefined; /** *The configuration for video extraction.
* @public */ videoExtractionConfiguration?: VideoExtractionConfiguration | undefined; } /** *A knowledge base resource that provides data from connected sources for AI-powered experiences in Amazon QuickSight.
* @public */ export interface KnowledgeBase { /** *The Amazon Resource Name (ARN) of the knowledge base.
* @public */ KnowledgeBaseArn: string | undefined; /** *The unique identifier for the knowledge base.
* @public */ KnowledgeBaseId: string | undefined; /** *The name of the knowledge base.
* @public */ Name: string | undefined; /** *The status of the knowledge base.
* @public */ Status: DataSetStatus | undefined; /** *The ARN of the data source associated with the knowledge base.
* @public */ DataSourceArn: string | undefined; /** *The configuration settings for the knowledge base.
* @public */ KnowledgeBaseConfiguration: KnowledgeBaseConfiguration | undefined; /** *The media extraction configuration for the knowledge base.
* @public */ MediaExtractionConfiguration?: MediaExtractionConfiguration | undefined; /** *The type of the knowledge base.
* @public */ Type?: string | undefined; /** *The date and time that the knowledge base was created.
* @public */ CreatedAt?: Date | undefined; /** *The date and time that the knowledge base was last updated.
* @public */ UpdatedAt?: Date | undefined; /** *The description of the knowledge base.
* @public */ Description?: string | undefined; /** *Indicates whether email notifications are enabled for ingestion failures.
* @public */ IsEmailNotificationOptedForIngestionFailures?: boolean | undefined; /** *A summary of the first completed ingestion for the knowledge base.
* @public */ FirstCompletedIngestionSummary?: KnowledgeBaseIngestionSummary | undefined; /** *A summary of the first incomplete ingestion for the knowledge base.
* @public */ FirstIncompleteIngestionSummary?: KnowledgeBaseIngestionSummary | undefined; /** *A summary of the most recent ingestion for the knowledge base.
* @public */ LatestIngestionSummary?: KnowledgeBaseIngestionSummary | undefined; /** *The size of the knowledge base in bytes.
* @public */ KnowledgeBaseSizeBytes?: number | undefined; /** *The number of documents in the knowledge base.
* @public */ DocumentCount?: number | undefined; /** *The ARN of the primary owner of the knowledge base.
* @public */ PrimaryOwnerArn?: string | undefined; /** *The username of the primary owner of the knowledge base.
* @public */ PrimaryOwnerUsername?: string | undefined; } /** * @public */ export interface DescribeKnowledgeBaseResponse { /** *The knowledge base.
* @public */ KnowledgeBase: KnowledgeBase | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeKnowledgeBasePermissionsRequest { /** *The ID of the Amazon Web Services account that contains the knowledge base.
* @public */ AwsAccountId: string | undefined; /** *The unique identifier for the knowledge base.
* @public */ KnowledgeBaseId: string | undefined; } /** * @public */ export interface DescribeKnowledgeBasePermissionsResponse { /** *The Amazon Resource Name (ARN) of the knowledge base.
* @public */ KnowledgeBaseArn: string | undefined; /** *The unique identifier for the knowledge base.
* @public */ KnowledgeBaseId: string | undefined; /** *The resource permissions for the knowledge base.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeNamespaceRequest { /** *The ID for the Amazon Web Services account that contains the Quick Sight namespace that you want to describe.
* @public */ AwsAccountId: string | undefined; /** *The namespace that you want to describe.
* @public */ Namespace: string | undefined; } /** *Errors that occur during namespace creation.
* @public */ export interface NamespaceError { /** *The error type.
* @public */ Type?: NamespaceErrorType | undefined; /** *The message for the error.
* @public */ Message?: string | undefined; } /** *The error type.
* @public */ export interface NamespaceInfoV2 { /** *The name of the error.
* @public */ Name?: string | undefined; /** *The namespace ARN.
* @public */ Arn?: string | undefined; /** *The namespace Amazon Web Services Region.
* @public */ CapacityRegion?: string | undefined; /** *The creation status of a namespace that is not yet completely created.
* @public */ CreationStatus?: NamespaceStatus | undefined; /** *The identity store used for the namespace.
* @public */ IdentityStore?: IdentityStore | undefined; /** *An error that occurred when the namespace was created.
* @public */ NamespaceError?: NamespaceError | undefined; /** *The Amazon Resource Name (ARN) for the IAM Identity Center application.
* @public */ IamIdentityCenterApplicationArn?: string | undefined; /** *The Amazon Resource Name (ARN) for the IAM Identity Center instance.
* @public */ IamIdentityCenterInstanceArn?: string | undefined; } /** * @public */ export interface DescribeNamespaceResponse { /** *The information about the namespace that you're describing. The response includes
* the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also
* works for namespaces that are in the process of being created. For incomplete namespaces,
* this API operation lists the namespace error types and messages associated with the creation process.
The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeOAuthClientApplicationRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the OAuthClientApplication that you want to describe.
* @public */ OAuthClientApplicationId: string | undefined; } /** *An OAuth client application that is used to authenticate connections to a data source through an OAuth identity provider.
* @public */ export interface OAuthClientApplication { /** *The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ OAuthClientApplicationId?: string | undefined; /** *The display name of the OAuthClientApplication.
* @public */ Name?: string | undefined; /** *The OAuth client authentication type used by the OAuthClientApplication. Valid values are TOKEN.
The token endpoint URL of the identity provider that is used to obtain access tokens.
* @public */ OAuthTokenEndpointUrl?: string | undefined; /** *The authorization endpoint URL of the identity provider that is used to obtain authorization codes.
* @public */ OAuthAuthorizationEndpointUrl?: string | undefined; /** *The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the identity provider.
* @public */ OAuthScopes?: string | undefined; /** *The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.
VPC connection properties.
* @public */ IdentityProviderVpcConnectionProperties?: VpcConnectionProperties | undefined; /** *The time that the OAuthClientApplication was created.
* @public */ CreatedTime?: Date | undefined; /** *The time that the OAuthClientApplication was last updated.
* @public */ LastUpdatedTime?: Date | undefined; /** *The Amazon Resource Name (ARN) of the OAuthClientApplication.
* @public */ Arn?: string | undefined; } /** * @public */ export interface DescribeOAuthClientApplicationResponse { /** *The information about the OAuthClientApplication.
* @public */ OAuthClientApplication?: OAuthClientApplication | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeQPersonalizationConfigurationRequest { /** *The ID of the Amazon Web Services account that contains the personalization configuration that the user wants described.
* @public */ AwsAccountId: string | undefined; } /** * @public */ export interface DescribeQPersonalizationConfigurationResponse { /** *A value that indicates whether personalization is enabled or not.
* @public */ PersonalizationMode?: PersonalizationMode | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeQuickSightQSearchConfigurationRequest { /** *The ID of the Amazon Web Services account that contains the Quick Sight Q Search configuration that the user wants described.
* @public */ AwsAccountId: string | undefined; } /** * @public */ export interface DescribeQuickSightQSearchConfigurationResponse { /** *The status of Quick Sight Q Search configuration.
* @public */ QSearchStatus?: QSearchStatus | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeRefreshScheduleRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the dataset.
* @public */ DataSetId: string | undefined; /** *The ID of the refresh schedule.
* @public */ ScheduleId: string | undefined; } /** * @public */ export interface DescribeRefreshScheduleResponse { /** *The refresh schedule.
* @public */ RefreshSchedule?: RefreshSchedule | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The Amazon Resource Name (ARN) for the refresh schedule.
* @public */ Arn?: string | undefined; } /** * @public */ export interface DescribeRoleCustomPermissionRequest { /** *The name of the role whose permissions you want described.
* @public */ Role: Role | undefined; /** *The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace that contains the role.
* @public */ Namespace: string | undefined; } /** * @public */ export interface DescribeRoleCustomPermissionResponse { /** *The name of the custom permission that is described.
* @public */ CustomPermissionsName?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeSelfUpgradeConfigurationRequest { /** *The ID of the Amazon Web Services account that contains the Quick self-upgrade configuration.
* @public */ AwsAccountId: string | undefined; /** *The Quick namespace that you want to describe the Quick self-upgrade configuration for.
* @public */ Namespace: string | undefined; } /** *The self-upgrade configuration for the Quick account.
* @public */ export interface SelfUpgradeConfiguration { /** *Status set for the self-upgrade configuration for the Quick account. It can contain the following values:
*
* AUTO_APPROVAL: All the self-upgrade requests will be auto approved.
* ADMIN_APPROVAL: All the self-upgrade requests will require admin approval.
The self-upgrade configuration for the Quick account.
* @public */ SelfUpgradeConfiguration?: SelfUpgradeConfiguration | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeSpaceRequest { /** *The ID of the Amazon Web Services account that contains the space.
* @public */ AwsAccountId: string | undefined; /** *The ID of the space that you want to describe.
* @public */ SpaceId: string | undefined; /** *The maximum number of contributors to include in the response.
* @public */ MaxContributors?: number | undefined; } /** *A contributor to an Amazon QuickSight space.
* @public */ export interface SpaceContributor { /** *The user name of the contributor.
* @public */ userName?: string | undefined; /** *The raw file size in bytes contributed by the user.
* @public */ rawFileSizeBytes: number | undefined; /** *The percentage of total contributions made by the user.
* @public */ percentage?: number | undefined; } /** *The details of a QuickSight resource in a space.
* @public */ export type SpaceQuickSightResourceDetails = SpaceQuickSightResourceDetails.ResourceArnMember | SpaceQuickSightResourceDetails.$UnknownMember; /** * @public */ export declare namespace SpaceQuickSightResourceDetails { /** *The ARN of the QuickSight resource.
* @public */ interface ResourceArnMember { resourceArn: string; $unknown?: never; } /** * @public */ interface $UnknownMember { resourceArn?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorA QuickSight resource that is associated with a space.
* @public */ export interface SpaceQuickSightResource { /** *The type of the QuickSight resource.
* @public */ resourceType: SpaceQuickSightResourceType | undefined; /** *The details of the QuickSight resource.
* @public */ resourceDetails: SpaceQuickSightResourceDetails | undefined; } /** *The details of an Amazon QuickSight space.
* @public */ export interface SpaceDetails { /** *The display name of the space.
* @public */ name?: string | undefined; /** *The description of the space.
* @public */ description?: string | undefined; /** *The resources in the space.
* @public */ resources?: SpaceQuickSightResource[] | undefined; /** *The date and time that the space was created.
* @public */ createdAt?: Date | undefined; /** *The date and time that the space was last updated.
* @public */ updatedAt?: Date | undefined; /** *The total consumed source size in bytes.
* @public */ consumedSourceSize?: number | undefined; /** *The number of consumed source documents.
* @public */ consumedSourceDocCount?: number | undefined; /** *The user who created the space.
* @public */ createdBy?: string | undefined; /** *The ARN of the user who created the space.
* @public */ createdByArn?: string | undefined; } /** * @public */ export interface DescribeSpaceResponse { /** *The ID of the space.
* @public */ spaceId: string | undefined; /** *The ARN of the space.
* @public */ spaceArn?: string | undefined; /** *The details of the space.
* @public */ Space: SpaceDetails | undefined; /** *A list of contributors to the space.
* @public */ Contributors?: SpaceContributor[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeSpacePermissionsRequest { /** *The ID of the Amazon Web Services account that contains the space.
* @public */ AwsAccountId: string | undefined; /** *The ID of the space that you want to describe permissions for.
* @public */ SpaceId: string | undefined; } /** * @public */ export interface DescribeSpacePermissionsResponse { /** *The ID of the space.
* @public */ spaceId: string | undefined; /** *The ARN of the space.
* @public */ spaceArn?: string | undefined; /** *A list of resource permissions for the space.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeTemplateRequest { /** *The ID of the Amazon Web Services account that contains the template that you're describing.
* @public */ AwsAccountId: string | undefined; /** *The ID for the template.
* @public */ TemplateId: string | undefined; /** *(Optional) The number for the version to describe. If a VersionNumber parameter
* value isn't provided, the latest version of the template is described.
The alias of the template that you want to describe. If you name a specific alias, you
* describe the version that the alias points to. You can specify the latest version of the
* template by providing the keyword $LATEST in the AliasName
* parameter. The keyword $PUBLISHED doesn't apply to templates.
List of errors that occurred when the template version creation failed.
* @public */ export interface TemplateError { /** *Type of error.
* @public */ Type?: TemplateErrorType | undefined; /** *Description of the error type.
* @public */ Message?: string | undefined; /** *An error path that shows which entities caused the template error.
* @public */ ViolatedEntities?: Entity[] | undefined; } /** *A version of a template.
* @public */ export interface TemplateVersion { /** *The time that this template version was created.
* @public */ CreatedTime?: Date | undefined; /** *Errors associated with this template version.
* @public */ Errors?: TemplateError[] | undefined; /** *The version number of the template version.
* @public */ VersionNumber?: number | undefined; /** *The status that is associated with the template.
*
* CREATION_IN_PROGRESS
*
* CREATION_SUCCESSFUL
*
* CREATION_FAILED
*
* UPDATE_IN_PROGRESS
*
* UPDATE_SUCCESSFUL
*
* UPDATE_FAILED
*
* DELETED
*
Schema of the dataset identified by the placeholder. Any dashboard created from this * template should be bound to new datasets matching the same schema described through this * API operation.
* @public */ DataSetConfigurations?: DataSetConfiguration[] | undefined; /** *The description of the template.
* @public */ Description?: string | undefined; /** *The Amazon Resource Name (ARN) of an analysis or template that was used to create this * template.
* @public */ SourceEntityArn?: string | undefined; /** *The ARN of the theme associated with this version of the template.
* @public */ ThemeArn?: string | undefined; /** *A list of the associated sheets with the unique identifier and name of each sheet.
* @public */ Sheets?: Sheet[] | undefined; } /** *A template object. A template is an entity in Quick Sight that * encapsulates the metadata required to create an analysis and that you can use to create * a dashboard. A template adds a layer of abstraction by using placeholders to replace the * dataset associated with an analysis. You can use templates to create dashboards by * replacing dataset placeholders with datasets that follow the same schema that was used * to create the source analysis and template.
*You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to * create a template or a dashboard from an existing template.
* @public */ export interface Template { /** *The Amazon Resource Name (ARN) of the template.
* @public */ Arn?: string | undefined; /** *The display name of the template.
* @public */ Name?: string | undefined; /** *A structure describing the versions of the template.
* @public */ Version?: TemplateVersion | undefined; /** *The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TemplateId?: string | undefined; /** *Time when this was last updated.
* @public */ LastUpdatedTime?: Date | undefined; /** *Time when this was created.
* @public */ CreatedTime?: Date | undefined; } /** * @public */ export interface DescribeTemplateResponse { /** *The template structure for the object you want to describe.
* @public */ Template?: Template | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeTemplateAliasRequest { /** *The ID of the Amazon Web Services account that contains the template alias that you're * describing.
* @public */ AwsAccountId: string | undefined; /** *The ID for the template.
* @public */ TemplateId: string | undefined; /** *The name of the template alias that you want to describe. If you name a specific alias, you
* describe the version that the alias points to. You can specify the latest version of the
* template by providing the keyword $LATEST in the AliasName
* parameter. The keyword $PUBLISHED doesn't apply to templates.
Information about the template alias.
* @public */ TemplateAlias?: TemplateAlias | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeTemplateDefinitionRequest { /** *The ID of the Amazon Web Services account that contains the template. You must be using the * Amazon Web Services account that the template is in.
* @public */ AwsAccountId: string | undefined; /** *The ID of the template that you're describing.
* @public */ TemplateId: string | undefined; /** *The version number of the template.
* @public */ VersionNumber?: number | undefined; /** *The alias of the template that you want to describe. If you name a specific alias, you
* describe the version that the alias points to. You can specify the latest version of the
* template by providing the keyword $LATEST in the AliasName
* parameter. The keyword $PUBLISHED doesn't apply to templates.
The descriptive name of the template.
* @public */ Name?: string | undefined; /** *The ID of the template described.
* @public */ TemplateId?: string | undefined; /** *Errors associated with the template version.
* @public */ Errors?: TemplateError[] | undefined; /** *Status associated with the template.
*
* CREATION_IN_PROGRESS
*
* CREATION_SUCCESSFUL
*
* CREATION_FAILED
*
* UPDATE_IN_PROGRESS
*
* UPDATE_SUCCESSFUL
*
* UPDATE_FAILED
*
* DELETED
*
The ARN of the theme of the template.
* @public */ ThemeArn?: string | undefined; /** *The definition of the template.
*A definition is the data model of all features in a Dashboard, Template, or Analysis.
* @public */ Definition?: TemplateVersionDefinition | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeTemplatePermissionsRequest { /** *The ID of the Amazon Web Services account that contains the template that you're describing.
* @public */ AwsAccountId: string | undefined; /** *The ID for the template.
* @public */ TemplateId: string | undefined; } /** * @public */ export interface DescribeTemplatePermissionsResponse { /** *The ID for the template.
* @public */ TemplateId?: string | undefined; /** *The Amazon Resource Name (ARN) of the template.
* @public */ TemplateArn?: string | undefined; /** *A list of resource permissions to be set on the template.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeThemeRequest { /** *The ID of the Amazon Web Services account that contains the theme that you're describing.
* @public */ AwsAccountId: string | undefined; /** *The ID for the theme.
* @public */ ThemeId: string | undefined; /** *The version number for the version to describe. If a VersionNumber parameter
* value isn't provided, the latest version of the theme is described.
The alias of the theme that you want to describe. If you name a specific alias, you
* describe the version that the alias points to. You can specify the latest version of the
* theme by providing the keyword $LATEST in the AliasName
* parameter. The keyword $PUBLISHED doesn't apply to themes.
Theme error.
* @public */ export interface ThemeError { /** *The type of error.
* @public */ Type?: ThemeErrorType | undefined; /** *The error message.
* @public */ Message?: string | undefined; } /** *A version of a theme.
* @public */ export interface ThemeVersion { /** *The version number of the theme.
* @public */ VersionNumber?: number | undefined; /** *The Amazon Resource Name (ARN) of the resource.
* @public */ Arn?: string | undefined; /** *The description of the theme.
* @public */ Description?: string | undefined; /** *The Quick Sight-defined ID of the theme that a custom theme inherits from. All * themes initially inherit from a default Quick Sight theme.
* @public */ BaseThemeId?: string | undefined; /** *The date and time that this theme version was created.
* @public */ CreatedTime?: Date | undefined; /** *The theme configuration, which contains all the theme display properties.
* @public */ Configuration?: ThemeConfiguration | undefined; /** *Errors associated with the theme.
* @public */ Errors?: ThemeError[] | undefined; /** *The status of the theme version.
* @public */ Status?: ResourceStatus | undefined; } /** *Summary information about a theme.
* @public */ export interface Theme { /** *The Amazon Resource Name (ARN) of the theme.
* @public */ Arn?: string | undefined; /** *The name that the user gives to the theme.
* @public */ Name?: string | undefined; /** *The identifier that the user gives to the theme.
* @public */ ThemeId?: string | undefined; /** *A version of a theme.
* @public */ Version?: ThemeVersion | undefined; /** *The date and time that the theme was created.
* @public */ CreatedTime?: Date | undefined; /** *The date and time that the theme was last updated.
* @public */ LastUpdatedTime?: Date | undefined; /** *The type of theme, based on how it was created. Valid values include:
* QUICKSIGHT and CUSTOM.
The information about the theme that you are describing.
* @public */ Theme?: Theme | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeThemeAliasRequest { /** *The ID of the Amazon Web Services account that contains the theme alias that you're * describing.
* @public */ AwsAccountId: string | undefined; /** *The ID for the theme.
* @public */ ThemeId: string | undefined; /** *The name of the theme alias that you want to describe.
* @public */ AliasName: string | undefined; } /** * @public */ export interface DescribeThemeAliasResponse { /** *Information about the theme alias.
* @public */ ThemeAlias?: ThemeAlias | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeThemePermissionsRequest { /** *The ID of the Amazon Web Services account that contains the theme that you're describing.
* @public */ AwsAccountId: string | undefined; /** *The ID for the theme that you want to describe permissions for.
* @public */ ThemeId: string | undefined; } /** * @public */ export interface DescribeThemePermissionsResponse { /** *The ID for the theme.
* @public */ ThemeId?: string | undefined; /** *The Amazon Resource Name (ARN) of the theme.
* @public */ ThemeArn?: string | undefined; /** *A list of resource permissions set on the theme.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeTopicRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId: string | undefined; } /** * @public */ export interface DescribeTopicResponse { /** *The Amazon Resource Name (ARN) of the topic.
* @public */ Arn?: string | undefined; /** *The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId?: string | undefined; /** *The definition of a topic.
* @public */ Topic?: TopicDetails | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *Custom instructions for the topic.
* @public */ CustomInstructions?: CustomInstructions | undefined; } /** * @public */ export interface DescribeTopicPermissionsRequest { /** *The ID of the Amazon Web Services account that contains the topic that you want * described.
* @public */ AwsAccountId: string | undefined; /** *The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId: string | undefined; } /** * @public */ export interface DescribeTopicPermissionsResponse { /** *The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId?: string | undefined; /** *The Amazon Resource Name (ARN) of the topic.
* @public */ TopicArn?: string | undefined; /** *A list of resource permissions that are configured to the topic.
* @public */ Permissions?: ResourcePermission[] | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeTopicRefreshRequest { /** *The ID of the Amazon Web Services account that contains the topic whose refresh you want * to describe.
* @public */ AwsAccountId: string | undefined; /** *The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId: string | undefined; /** *The ID of the refresh, which is performed when the topic is created or updated.
* @public */ RefreshId: string | undefined; } /** *The details about the refresh of a topic.
* @public */ export interface TopicRefreshDetails { /** *The Amazon Resource Name (ARN) of the topic refresh.
* @public */ RefreshArn?: string | undefined; /** *The ID of the refresh, which occurs as a result of topic creation or topic update.
* @public */ RefreshId?: string | undefined; /** *The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.
* @public */ RefreshStatus?: TopicRefreshStatus | undefined; } /** * @public */ export interface DescribeTopicRefreshResponse { /** *Details of the refresh, which is performed when the topic is created or updated.
* @public */ RefreshDetails?: TopicRefreshDetails | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeTopicRefreshScheduleRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the topic that contains the refresh schedule that you want to describe. This * ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId: string | undefined; /** *The ID of the dataset.
* @public */ DatasetId: string | undefined; } /** * @public */ export interface DescribeTopicRefreshScheduleResponse { /** *The ID of the topic that contains the refresh schedule that you want to describe. This * ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId?: string | undefined; /** *The Amazon Resource Name (ARN) of the topic.
* @public */ TopicArn?: string | undefined; /** *The Amazon Resource Name (ARN) of the dataset.
* @public */ DatasetArn?: string | undefined; /** *The definition of a refresh schedule.
* @public */ RefreshSchedule?: TopicRefreshSchedule | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface DescribeUserRequest { /** *The name of the user that you want to describe.
* @public */ UserName: string | undefined; /** *The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace. Currently, you should set this to default.
A registered user of Quick Sight.
* @public */ export interface User { /** *The Amazon Resource Name (ARN) for the user.
* @public */ Arn?: string | undefined; /** *The user's user name. This value is required if you are registering a user that will be managed in Quick Sight. In the output, the value for UserName is
* N/A when the value for IdentityType is IAM
* and the corresponding IAM user is deleted.
The user's email address.
* @public */ Email?: string | undefined; /** *The Quick Sight role for the user. The user role can be one of the * following:.
*
* READER: A user who has read-only access to dashboards.
* AUTHOR: A user who can create data sources, datasets, analyses,
* and dashboards.
* ADMIN: A user who is an author, who can also manage Amazon
* Quick Sight settings.
* READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can build stories with Amazon Q, and can generate executive summaries from dashboards.
* AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
* ADMIN_PRO: Admin Pros are Author Pros who can also manage Quick Sight administrative settings. Admin Pro users are billed at Author Pro pricing.
* RESTRICTED_READER: This role isn't currently available for
* use.
* RESTRICTED_AUTHOR: This role isn't currently available for
* use.
The type of identity authentication used by the user.
* @public */ IdentityType?: IdentityType | undefined; /** *The active status of user. When you create an Quick Sight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a * password.
* @public */ Active?: boolean | undefined; /** *The principal ID of the user.
* @public */ PrincipalId?: string | undefined; /** *The custom permissions profile associated with this user.
* @public */ CustomPermissionsName?: string | undefined; /** *The type of supported external login provider that provides identity to let the user * federate into Quick Sight with an associated IAM role. The type can be one of the following.
*
* COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
* CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.
The URL of the external login provider.
* @public */ ExternalLoginFederationProviderUrl?: string | undefined; /** *The identity ID for the user in the external login provider.
* @public */ ExternalLoginId?: string | undefined; } /** * @public */ export interface DescribeUserResponse { /** *The user name.
* @public */ User?: User | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface DescribeVPCConnectionRequest { /** *The Amazon Web Services account ID of the account that contains the VPC connection that * you want described.
* @public */ AwsAccountId: string | undefined; /** *The ID of the VPC connection that * you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
* @public */ VPCConnectionId: string | undefined; } /** *The structure that contains information about a network interface.
* @public */ export interface NetworkInterface { /** *The subnet ID associated with the network interface.
* @public */ SubnetId?: string | undefined; /** *The availability zone that the network interface resides in.
* @public */ AvailabilityZone?: string | undefined; /** *An error message.
* @public */ ErrorMessage?: string | undefined; /** *The status of the network interface.
* @public */ Status?: NetworkInterfaceStatus | undefined; /** *The network interface ID.
* @public */ NetworkInterfaceId?: string | undefined; } /** *The structure of a VPC connection.
* @public */ export interface VPCConnection { /** *The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an * Amazon Web Services account.
* @public */ VPCConnectionId?: string | undefined; /** *The Amazon Resource Name (ARN) of the VPC connection.
* @public */ Arn?: string | undefined; /** *The display name for the VPC connection.
* @public */ Name?: string | undefined; /** *The Amazon EC2 VPC ID associated with the VPC connection.
* @public */ VPCId?: string | undefined; /** *The Amazon EC2 security group IDs associated with the VPC connection.
* @public */ SecurityGroupIds?: string[] | undefined; /** *A list of IP addresses of DNS resolver endpoints for the VPC connection.
* @public */ DnsResolvers?: string[] | undefined; /** *The status of the VPC connection.
* @public */ Status?: VPCConnectionResourceStatus | undefined; /** *The availability status of the VPC connection.
* @public */ AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; /** *A list of network interfaces.
* @public */ NetworkInterfaces?: NetworkInterface[] | undefined; /** *The ARN of the * IAM role associated with the VPC * connection.
* @public */ RoleArn?: string | undefined; /** *The time that the VPC connection was created.
* @public */ CreatedTime?: Date | undefined; /** *The time that the VPC connection was last updated.
* @public */ LastUpdatedTime?: Date | undefined; } /** * @public */ export interface DescribeVPCConnectionResponse { /** *A response object that provides information for the specified VPC connection.
* @public */ VPCConnection?: VPCConnection | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** *An entry that appears when a KeyRegistration update to Quick Sight fails.
The ARN of the KMS key that failed to update.
* @public */ KeyArn?: string | undefined; /** *A message that provides information about why a FailedKeyRegistrationEntry error occurred.
The HTTP status of a FailedKeyRegistrationEntry error.
A boolean that indicates whether a FailedKeyRegistrationEntry resulted from user error. If the value of this property is True, the error was caused by user error. If the value of this property is False, the error occurred on the backend. If your job continues fail and with a False
* SenderFault value, contact Amazon Web Services Support.
A resource operation that failed.
* @public */ export interface FailedSpaceResourceOperation { /** *The type of the resource.
* @public */ ResourceType: SpaceQuickSightResourceType | undefined; /** *The details of the resource.
* @public */ ResourceDetails?: SpaceQuickSightResourceDetails | undefined; /** *The error message that describes why the operation failed.
* @public */ ErrorMessage: string | undefined; } /** *Information about a per-ARN failure when updating agent associations.
* @public */ export interface FailedToUpdateAssociation { /** *The ARN that could not be added or removed.
* @public */ Arn?: string | undefined; /** *A description of the failure.
* @public */ ErrorMessage?: string | undefined; /** *The error code for the failure.
* @public */ ErrorCode?: string | undefined; } /** *The basic information of the flow exluding its definition specifying the steps.
* @public */ export interface FlowSummary { /** *The Amazon Resource Name (ARN) of the flow.
* @public */ Arn: string | undefined; /** *The unique identifier of the flow.
* @public */ FlowId: string | undefined; /** *The display name of the flow.
* @public */ Name: string | undefined; /** *The description of the flow.
* @public */ Description?: string | undefined; /** *The time this flow was created.
* @public */ CreatedTime: Date | undefined; /** *The identifier of the principal who created the flow.
* @public */ CreatedBy?: string | undefined; /** *The last time this flow was modified.
* @public */ LastUpdatedTime?: Date | undefined; /** *The identifier of the last principal who updated the flow.
* @public */ LastUpdatedBy?: string | undefined; /** *The publish state for the flow. The valid values are DRAFT, PUBLISHED,
* or PENDING_APPROVAL.
The number of runs done for the flow.
* @public */ RunCount?: number | undefined; /** *The number of users who have used the flow.
* @public */ UserCount?: number | undefined; /** *The identifier of the last principal who published the flow.
* @public */ LastPublishedBy?: string | undefined; /** *The last time this flow was published.
* @public */ LastPublishedAt?: Date | undefined; } /** *An object that consists of a member Amazon Resource Name (ARN) and a member ID.
* @public */ export interface MemberIdArnPair { /** *The ID of the member.
* @public */ MemberId?: string | undefined; /** *The Amazon Resource Name (ARN) of the member.
* @public */ MemberArn?: string | undefined; } /** *A filter to use to search an Quick Sight folder.
* @public */ export interface FolderSearchFilter { /** *The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".
If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value FOLDER_NAME.
The name of a value that you want to use in the filter. For example, "Name": "QUICKSIGHT_OWNER".
Valid values are defined as follows:
*
* QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the folder's owners or viewers are returned. Implicit permissions from folders or groups are considered.
* QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered.
* DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered.
* DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are not considered.
* DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered.
* FOLDER_NAME: Any folders whose names have a substring match to this value will be returned.
* PARENT_FOLDER_ARN: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.
The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId".
A summary of information about an existing Quick Sight folder.
* @public */ export interface FolderSummary { /** *The Amazon Resource Name (ARN) of the folder.
* @public */ Arn?: string | undefined; /** *The ID of the folder.
* @public */ FolderId?: string | undefined; /** *The display name of the folder.
* @public */ Name?: string | undefined; /** *The type of folder.
* @public */ FolderType?: FolderType | undefined; /** *The time that the folder was created.
* @public */ CreatedTime?: Date | undefined; /** *The time that the folder was last updated.
* @public */ LastUpdatedTime?: Date | undefined; /** *The sharing scope of the folder.
* @public */ SharingModel?: SharingModel | undefined; } /** *The QA result that is made from generated answer.
* @public */ export interface GeneratedAnswerResult { /** *The question text.
* @public */ QuestionText?: string | undefined; /** *The answer status of the generated answer.
* @public */ AnswerStatus?: GeneratedAnswerStatus | undefined; /** *The ID of the topic.
* @public */ TopicId?: string | undefined; /** *The name of the topic.
* @public */ TopicName?: string | undefined; /** *The restatement for the answer.
* @public */ Restatement?: string | undefined; /** *The ID of the question.
* @public */ QuestionId?: string | undefined; /** *The ID of the answer.
* @public */ AnswerId?: string | undefined; /** *The URL of the question.
* @public */ QuestionUrl?: string | undefined; } /** *The key-value pair used for the row-level security tags feature.
* @public */ export interface SessionTag { /** *The key for the tag.
* @public */ Key: string | undefined; /** *The value that you want to assign the tag.
* @public */ Value: string | undefined; } /** * @public */ export interface GenerateEmbedUrlForAnonymousUserRequest { /** *The ID for the Amazon Web Services account that contains the dashboard that you're * embedding.
* @public */ AwsAccountId: string | undefined; /** *How many minutes the session is valid. The session lifetime must be in [15-600] * minutes range.
* @public */ SessionLifetimeInMinutes?: number | undefined; /** *The Amazon Quick Sight namespace that the anonymous user virtually belongs to. If you
* are not using an Amazon Quick custom namespace, set this to
* default.
Session tags are user-specified strings that identify a session in your application. You can use these tags to implement row-level security (RLS) controls.
* Before you use the SessionTags 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.
When using SessionTags in GenerateEmbedUrlForAnonymousUser,
Treat SessionTags as security credentials. Do not expose SessionTags to end users or client-side code.
Implement server-side controls. Ensure that SessionTags are set exclusively by your trusted backend services, not by parameters that end users can modify.
Protect SessionTags from enumeration. Ensure that users in one tenant cannot discover or guess sessionTag values belonging to other tenants.
Review your architecture. If downstream customers or partners are allowed to call the GenerateEmbedUrlForAnonymousUser API directly,
* evaluate whether those parties could specify sessionTag values for tenants they should not access.
Besides, these are not the tags used for the Amazon Web Services resource tagging feature. * For more information, see Using Row-Level Security (RLS) with Tags in the Amazon Quick User Guide.
* @public */ SessionTags?: SessionTag[] | undefined; /** *The Amazon Resource Names (ARNs) for the Quick Sight 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.
If you want to make changes to the theme of your embedded content, pass a list of * theme ARNs that the anonymous users need access to.
*Currently, you can pass up to 25 theme ARNs in each API call.
* @public */ AuthorizedResourceArns: string[] | undefined; /** *The configuration of the experience that you are embedding.
* @public */ ExperienceConfiguration: AnonymousUserEmbeddingExperienceConfiguration | undefined; /** *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 Quick Sight menu in the Amazon Quick Sight console. Instead, it * 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 all subdomains under a specific domain to the allow list, use
* *. For example, https://*.sapp.amazon.com includes all
* subdomains under https://sapp.amazon.com.
The embed URL for the dashboard.
* @public */ EmbedUrl: string | undefined; /** *The HTTP status of the request.
* @public */ Status: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId: string | undefined; /** *The Amazon Resource Name (ARN) to use for the anonymous Amazon Quick * user.
* @public */ AnonymousUserArn: string | undefined; } /** *The recent snapshots configuration for an embedded Quick Sight dashboard.
* @public */ export interface RecentSnapshotsConfigurations { /** *The recent snapshots configuration for an embedded Quick Sight dashboard.
* @public */ Enabled: boolean | undefined; } /** *The schedules configuration for an embedded Quick Sight dashboard.
* @public */ export interface SchedulesConfigurations { /** *The schedules configuration for an embedded Quick Sight dashboard.
* @public */ Enabled: boolean | undefined; } /** *The state perssitence configuration of an embedded dashboard.
* @public */ export interface StatePersistenceConfigurations { /** *Determines if a Quick Sight dashboard's state persistence settings are turned on or off.
* @public */ Enabled: boolean | undefined; } /** *The threshold alerts configuration for an embedded Quick Sight dashboard.
* @public */ export interface ThresholdAlertsConfigurations { /** *The threshold alerts configuration for an embedded Quick Sight dashboard.
* @public */ Enabled: boolean | undefined; } /** *The feature configuration for an embedded dashboard.
* @public */ export interface RegisteredUserDashboardFeatureConfigurations { /** *The state persistence settings of an embedded dashboard.
* @public */ StatePersistence?: StatePersistenceConfigurations | undefined; /** *The bookmarks configuration for an embedded dashboard in Amazon Quick Sight.
* @public */ Bookmarks?: BookmarksConfigurations | undefined; /** *The shared view settings of an embedded dashboard.
* @public */ SharedView?: SharedViewConfigurations | undefined; /** *The Amazon Q configurations of an embedded Amazon Quick Sight * dashboard.
* @public */ AmazonQInQuickSight?: AmazonQInQuickSightDashboardConfigurations | undefined; /** *The schedules configuration for an embedded Quick Sight dashboard.
* @public */ Schedules?: SchedulesConfigurations | undefined; /** *The recent snapshots configuration for an Quick Sight embedded dashboard
* @public */ RecentSnapshots?: RecentSnapshotsConfigurations | undefined; /** *The threshold alerts configuration for an Quick Sight embedded dashboard.
* @public */ ThresholdAlerts?: ThresholdAlertsConfigurations | undefined; /** *The dashboard customization summary configuration for an embedded Quick Sight dashboard.
* @public */ DashboardCustomizationSummary?: DashboardCustomizationSummaryConfigurations | undefined; } /** *Information about the dashboard you want to embed.
* @public */ export interface RegisteredUserDashboardEmbeddingConfiguration { /** *The dashboard ID for the dashboard that you want the user to see first. This ID is * included in the output URL. When the URL in response is accessed, Amazon Quick Sight * renders this dashboard if the user has permissions to view it.
*If the user does not have permission to view this dashboard, they see a permissions * error message.
* @public */ InitialDashboardId: string | undefined; /** *The feature configurations of an embbedded Amazon Quick Sight dashboard.
* @public */ FeatureConfigurations?: RegisteredUserDashboardFeatureConfigurations | undefined; } /** *The experience that you are embedding. You can use this object to generate a url that * embeds a visual into your application.
* @public */ export interface RegisteredUserDashboardVisualEmbeddingConfiguration { /** *The visual ID for the visual that you want the user to embed. This ID is included in * the output URL. When the URL in response is accessed, Amazon Quick Sight renders this * visual.
*The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be
* included in the AuthorizedResourceArns parameter. Otherwise, the request
* will fail with InvalidParameterValueException.
An object that provides information about the configuration of a Generative Q&A experience.
* @public */ export interface RegisteredUserGenerativeQnAEmbeddingConfiguration { /** *The ID of the new Q reader experience topic that you want to make the starting topic * in the Generative Q&A experience. You can find a topic ID by navigating to the Topics pane in the Quick application and opening a topic. The ID is in the URL for the topic that * you open.
*If you don't specify an initial topic or you specify a legacy topic, a list of all * shared new reader experience topics is shown in the Generative Q&A experience for * your readers. When you select an initial new reader experience topic, you can specify * whether or not readers are allowed to select other new reader experience topics from the * available ones in the list.
* @public */ InitialTopicId?: string | undefined; } /** *Information about the Q search bar embedding experience.
* @public */ export interface RegisteredUserQSearchBarEmbeddingConfiguration { /** *The ID of the legacy Q topic that you want to use as the starting topic in the Q
* search bar. To locate the topic ID of the topic that you want to use, open the Quick Sight console, navigate to the
* Topics pane, and choose thre topic that you want to
* use. The TopicID is located in the URL of the topic that opens. When you
* select an initial topic, you can specify whether or not readers are allowed to select
* other topics from the list of available topics.
If you don't specify an initial topic or if you specify a new reader experience topic, * a list of all shared legacy topics is shown in the Q bar.
* @public */ InitialTopicId?: string | undefined; } /** *An object that provides information about the configuration of a chat agent.
* @public */ export interface RegisteredUserQuickChatEmbeddingConfiguration { } /** *The feature configurations of an embedded Amazon Quick Sight console.
* @public */ export interface RegisteredUserConsoleFeatureConfigurations { /** *The state persistence configurations of an embedded Amazon Quick Sight console.
* @public */ StatePersistence?: StatePersistenceConfigurations | undefined; /** *The shared view settings of an embedded dashboard.
* @public */ SharedView?: SharedViewConfigurations | undefined; /** *The Amazon Q configurations of an embedded Amazon Quick Sight * console.
* @public */ AmazonQInQuickSight?: AmazonQInQuickSightConsoleConfigurations | undefined; /** *The schedules configuration for an embedded Quick Sight dashboard.
* @public */ Schedules?: SchedulesConfigurations | undefined; /** *The recent snapshots configuration for an embedded Quick Sight dashboard.
* @public */ RecentSnapshots?: RecentSnapshotsConfigurations | undefined; /** *The threshold alerts configuration for an embedded Quick Sight dashboard.
* @public */ ThresholdAlerts?: ThresholdAlertsConfigurations | undefined; /** *The dashboard customization summary configuration for an embedded Quick Sight console.
* @public */ DashboardCustomizationSummary?: DashboardCustomizationSummaryConfigurations | undefined; } /** *Information about the Amazon Quick Sight console that you want to embed.
* @public */ export interface RegisteredUserQuickSightConsoleEmbeddingConfiguration { /** *The initial URL path for the Amazon Quick Sight console. InitialPath is
* required.
The entry point URL is constrained to the following paths:
*
* /start
*
* /start/analyses
*
* /start/dashboards
*
* /start/favorites
*
* /dashboards/DashboardId. DashboardId is the
* actual ID key from the Amazon Quick Sight console URL of the dashboard.
* /analyses/AnalysisId. AnalysisId is the
* actual ID key from the Amazon Quick Sight console URL of the analysis.
The embedding configuration of an embedded Amazon Quick Sight console.
* @public */ FeatureConfigurations?: RegisteredUserConsoleFeatureConfigurations | undefined; } /** *The type of experience you want to embed. For registered users, you can embed Quick dashboards or the Amazon Quick Sight console.
*Exactly one of the experience configurations is required. You can choose
* Dashboard or QuickSightConsole. You cannot choose more
* than one experience configuration.
The configuration details for providing a dashboard embedding experience.
* @public */ Dashboard?: RegisteredUserDashboardEmbeddingConfiguration | undefined; /** *The configuration details for providing each Amazon Quick Sight console embedding * experience. This can be used along with custom permissions to restrict access to certain * features. For more information, see Customizing Access to the Amazon Quick Sight Console in the * Amazon Quick User Guide.
*Use
* GenerateEmbedUrlForRegisteredUser
* where you want to provide an
* authoring portal that allows users to create data sources, datasets, analyses, and
* dashboards. The users who accesses an embedded Amazon Quick Sight console needs to belong
* to the author or admin security cohort. If you want to restrict permissions to some of
* these features, add a custom permissions profile to the user with the
* UpdateUser
* API operation. Use the
* RegisterUser
* API operation to add a new user with a custom
* permission profile attached. For more information, see the following sections in the
* Amazon Quick User Guide:
* Embedding the Full Functionality of the Amazon Quick Sight Console for * Authenticated Users *
*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 Quick * Developer Portal.
* @public */ QuickSightConsole?: RegisteredUserQuickSightConsoleEmbeddingConfiguration | undefined; /** *The configuration details for embedding the Q search bar.
*For more information about embedding the Q search bar, see Embedding Overview in * the Amazon Quick Sight User Guide.
* @public */ QSearchBar?: RegisteredUserQSearchBarEmbeddingConfiguration | undefined; /** *The type of embedding experience. In this case, Amazon Quick Sight visuals.
* @public */ DashboardVisual?: RegisteredUserDashboardVisualEmbeddingConfiguration | undefined; /** *The configuration details for embedding the Generative Q&A experience.
*For more information about embedding the Generative Q&A experience, see Embedding Overview in * the Amazon Quick Sight User Guide.
* @public */ GenerativeQnA?: RegisteredUserGenerativeQnAEmbeddingConfiguration | undefined; /** *The configuration details for embedding the Quick chat agent.
* @public */ QuickChat?: RegisteredUserQuickChatEmbeddingConfiguration | undefined; } /** * @public */ export interface GenerateEmbedUrlForRegisteredUserRequest { /** *The ID for the Amazon Web Services account that contains the dashboard that you're * embedding.
* @public */ AwsAccountId: string | undefined; /** *How many minutes the session is valid. The session lifetime must be in [15-600] * minutes range.
* @public */ SessionLifetimeInMinutes?: number | undefined; /** *The Amazon Resource Name for the registered user.
* @public */ UserArn: string | undefined; /** *The experience that you want to embed. For registered users, you can embed Quick dashboards, Amazon Quick Sight visuals, the Amazon Quick Sight Q search bar, * the Amazon Quick Sight Generative Q&A experience, or the entire Amazon Quick Sight console.
* @public */ ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration | undefined; /** *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 Quick Sight menu in the Amazon Quick Sight console. Instead, it * 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 all subdomains under a specific domain to the allow list, use
* *. For example, https://*.sapp.amazon.com includes all
* subdomains under https://sapp.amazon.com.
The embed URL for the Amazon Quick Sight dashboard, visual, Q search bar, Generative Q&A experience, or * console.
* @public */ EmbedUrl: string | undefined; /** *The HTTP status of the request.
* @public */ Status: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId: string | undefined; } /** * @public */ export interface GenerateEmbedUrlForRegisteredUserWithIdentityRequest { /** *The ID of the Amazon Web Services registered user.
* @public */ AwsAccountId: string | undefined; /** *The validity of the session in minutes.
* @public */ SessionLifetimeInMinutes?: number | undefined; /** *The type of experience you want to embed. For registered users, you can embed Quick dashboards or the Amazon Quick Sight console.
*Exactly one of the experience configurations is required. You can choose
* Dashboard or QuickSightConsole. You cannot choose more
* than one experience configuration.
A list of domains to be allowed to generate the embed URL.
* @public */ AllowedDomains?: string[] | undefined; } /** * @public */ export interface GenerateEmbedUrlForRegisteredUserWithIdentityResponse { /** *The generated embed URL for the registered user.
* @public */ EmbedUrl: string | undefined; /** *The HTTP status of the request.
* @public */ Status: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId: string | undefined; } /** * @public */ export interface GetDashboardEmbedUrlRequest { /** *The ID for the Amazon Web Services account that contains the dashboard that you're * embedding.
* @public */ AwsAccountId: string | undefined; /** *The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
* @public */ DashboardId: string | undefined; /** *The authentication method that the user uses to sign in.
* @public */ IdentityType: EmbeddingIdentityType | undefined; /** *How many minutes the session is valid. The session lifetime must be 15-600 * minutes.
* @public */ SessionLifetimeInMinutes?: number | undefined; /** *Remove the undo/redo button on the embedded dashboard. The default is FALSE, which * enables the undo/redo button.
* @public */ UndoRedoDisabled?: boolean | undefined; /** *Remove the reset button on the embedded dashboard. The default is FALSE, which enables * the reset button.
* @public */ ResetDisabled?: boolean | undefined; /** *Adds persistence of state for the user session in an embedded dashboard. Persistence
* applies to the sheet and the parameter settings. These are control settings that the
* dashboard subscriber (Amazon Quick Sight reader) chooses while viewing the dashboard. If
* this is set to TRUE, the settings are the same when the subscriber reopens
* the same dashboard URL. The state is stored in Amazon Quick Sight, not in a browser
* cookie. If this is set to FALSE, the state of the user session is not persisted. The
* default is FALSE.
The Amazon Quick user's Amazon Resource Name (ARN), for use with
* QUICKSIGHT identity type. You can use this for any Amazon Quick users in your account (readers, authors, or admins) authenticated as one of the
* following:
Active Directory (AD) users or group members
*Invited nonfederated users
*IAM users and IAM role-based sessions * authenticated through Federated Single Sign-On using SAML, OpenID Connect, or * IAM federation.
*Omit this parameter for users in the third group – IAM users and IAM * role-based sessions.
* @public */ UserArn?: string | undefined; /** *The Amazon Quick Sight namespace that contains the dashboard IDs in this request. If
* you're not using a custom namespace, set Namespace = default.
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 Quick 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.
Output returned from the GetDashboardEmbedUrl operation.
A single-use URL that you can put into your server-side webpage to embed your
* dashboard. This URL is valid for 5 minutes. The API operation provides the URL with an
* auth_code value that enables one (and only one) sign-on to a user
* session that is valid for 10 hours.
The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface GetFlowMetadataInput { /** *The ID of the Amazon Web Services account that contains the flow that you are getting metadata for.
* @public */ AwsAccountId: string | undefined; /** *The unique identifier of the flow.
* @public */ FlowId: string | undefined; } /** * @public */ export interface GetFlowMetadataOutput { /** *The Amazon Resource Name (ARN) of the flow.
* @public */ Arn: string | undefined; /** *The unique identifier of the flow.
* @public */ FlowId: string | undefined; /** *A display name for the flow.
* @public */ Name: string | undefined; /** *The description for the flow.
* @public */ Description?: string | undefined; /** *The publish state for the flow. Valid values are DRAFT, PUBLISHED,
* or PENDING_APPROVAL.
The number of users who have used the flow.
* @public */ UserCount?: number | undefined; /** *The number of runs done for the flow.
* @public */ RunCount?: number | undefined; /** *The time this flow was created.
* @public */ CreatedTime: Date | undefined; /** *The last time this flow was modified.
* @public */ LastUpdatedTime?: Date | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface GetFlowPermissionsInput { /** *The ID of the Amazon Web Services account that contains the flow that you are getting permissions for.
* @public */ AwsAccountId: string | undefined; /** *The unique identifier of the flow to get permissions from.
* @public */ FlowId: string | undefined; } /** * @public */ export interface GetFlowPermissionsOutput { /** *The Amazon Resource Name (ARN) of the flow you are getting permissions against.
* @public */ Arn: string | undefined; /** *The unique identifier of the flow with permissions.
* @public */ FlowId: string | undefined; /** *A structure that contains the permissions for the flow.
* @public */ Permissions: Permission[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** *A structure that contains information to identify a user.
* @public */ export type UserIdentifier = UserIdentifier.EmailMember | UserIdentifier.UserArnMember | UserIdentifier.UserNameMember | UserIdentifier.$UnknownMember; /** * @public */ export declare namespace UserIdentifier { /** *The name of the user that you want to get identity context for.
* @public */ interface UserNameMember { UserName: string; Email?: never; UserArn?: never; $unknown?: never; } /** *The email address of the user that you want to get identity context for.
* @public */ interface EmailMember { UserName?: never; Email: string; UserArn?: never; $unknown?: never; } /** *The Amazon Resource Name (ARN) of the user that you want to get identity context for.
* @public */ interface UserArnMember { UserName?: never; Email?: never; UserArn: string; $unknown?: never; } /** * @public */ interface $UnknownMember { UserName?: never; Email?: never; UserArn?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface Visitor///////////////////////// * /////////////////////////
* @public */ export interface GetIdentityContextRequest { /** *The ID for the Amazon Web Services account that the user whose identity context you want to retrieve is in. Currently, you use the ID for the Amazon Web Services account that contains your Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The identifier for the user whose identity context you want to retrieve.
* @public */ UserIdentifier: UserIdentifier | undefined; /** *The namespace of the user that you want to get identity context for. This parameter is required when the UserIdentifier is specified using Email or UserName.
* @public */ Namespace?: string | undefined; /** *The timestamp at which the session will expire.
* @public */ SessionExpiresAt?: Date | undefined; /** *The region in which the context is to be used. Use this parameter to obtain an identity context for cross-region use.
*The specified region must meet the following conditions:
*The region must be in the same Amazon Web Services partition as the region you are calling from. Cross-partition requests are not supported. For example, you cannot specify a region in the aws-cn partition when calling from a region in the aws partition.
It must be a valid Amazon QuickSight supported region.
*The calling customer account must be enabled in the specified context region.
*This parameter is not supported when calling from an opt-in region.
*The HTTP status of the request.
* @public */ Status: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId: string | undefined; /** *The identity context information for the user. This is an identity token that should be used as the ContextAssertion parameter in the STS AssumeRole API call to obtain identity enhanced Amazon Web Services credentials.
* @public */ Context?: string | undefined; } /** * @public */ export interface GetSessionEmbedUrlRequest { /** *The ID for the Amazon Web Services account associated with your Amazon Quick Sight * subscription.
* @public */ AwsAccountId: string | undefined; /** *The URL you use to access the embedded session. The entry point URL is constrained to * the following paths:
*
* /start
*
* /start/analyses
*
* /start/dashboards
*
* /start/favorites
*
* /dashboards/DashboardId
* - where
* DashboardId is the actual ID key from the Amazon Quick Sight
* console URL of the dashboard
* /analyses/AnalysisId
* - where
* AnalysisId is the actual ID key from the Amazon Quick Sight
* console URL of the analysis
How many minutes the session is valid. The session lifetime must be 15-600 * minutes.
* @public */ SessionLifetimeInMinutes?: number | undefined; /** *The Amazon Quick user's Amazon Resource Name (ARN), for use with
* QUICKSIGHT identity type. You can use this for any type of Amazon Quick users in your account (readers, authors, or admins). They need to be
* authenticated as one of the following:
Active Directory (AD) users or group members
*Invited nonfederated users
*IAM users and IAM role-based sessions * authenticated through Federated Single Sign-On using SAML, OpenID Connect, or * IAM federation
*Omit this parameter for users in the third group, IAM users and IAM role-based sessions.
* @public */ UserArn?: string | undefined; } /** * @public */ export interface GetSessionEmbedUrlResponse { /** *A single-use URL that you can put into your server-side web page to embed your Quick session. This URL is valid for 5 minutes. The API operation provides the
* URL with an auth_code value that enables one (and only one) sign-on to a
* user session that is valid for 10 hours.
The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** *A GroupSearchFilter object that you want to apply to your search.
The comparison operator that you want to use as a filter, for example "Operator":
* "StartsWith". Currently, the only supported operator is
* StartsWith.
The name of the value that you want to use as a filter, for example "Name":
* "GROUP_NAME". Currently, the only supported name is
* GROUP_NAME.
The value of the named item, in this case GROUP_NAME, that you want to use as a filter.
IAM policy assignment summary.
* @public */ export interface IAMPolicyAssignmentSummary { /** *Assignment name.
* @public */ AssignmentName?: string | undefined; /** *Assignment status.
* @public */ AssignmentStatus?: AssignmentStatus | undefined; } /** *A filter to apply when searching knowledge bases.
* @public */ export interface KnowledgeBaseSearchFilter { /** *The name of the field to filter on.
* @public */ name: KnowledgeBaseSearchFilterName | undefined; /** *The comparison operator to use for the filter.
* @public */ operator: KnowledgeBaseSearchOperator | undefined; /** *The value to filter on.
* @public */ value: string | undefined; } /** *The sort configuration for searching knowledge bases.
* @public */ export interface KnowledgeBaseSortBy { /** *The field to sort by.
* @public */ sortByField: KnowledgeBaseSortByField | undefined; /** *The sort order (ascending or descending).
* @public */ sortOrder: SortOrder | undefined; } /** *A summary of a knowledge base, including its identifier, name, status, and metadata.
* @public */ export interface KnowledgeBaseSummary { /** *The Amazon Resource Name (ARN) of the knowledge base.
* @public */ KnowledgeBaseArn: string | undefined; /** *The unique identifier for the knowledge base.
* @public */ KnowledgeBaseId: string | undefined; /** *The name of the knowledge base.
* @public */ Name: string | undefined; /** *The status of the knowledge base.
* @public */ Status: DataSetStatus | undefined; /** *The ARN of the data source associated with the knowledge base.
* @public */ DataSourceArn: string | undefined; /** *The type of the knowledge base.
* @public */ Type?: string | undefined; /** *The date and time that the knowledge base was created.
* @public */ CreatedAt?: Date | undefined; /** *The date and time that the knowledge base was last updated.
* @public */ UpdatedAt?: Date | undefined; /** *The size of the knowledge base in bytes.
* @public */ KnowledgeBaseSizeBytes?: number | undefined; /** *The number of documents in the knowledge base.
* @public */ DocumentCount?: number | undefined; /** *The ARN of the primary owner of the knowledge base.
* @public */ PrimaryOwnerArn?: string | undefined; /** *The username of the primary owner of the knowledge base.
* @public */ PrimaryOwnerUsername?: string | undefined; } /** * @public */ export interface ListActionConnectorsRequest { /** *The Amazon Web Services account ID for which to list action connectors.
* @public */ AwsAccountId: string | undefined; /** *The maximum number of action connectors to return in a single response. Valid range is 1 to 100.
* @public */ MaxResults?: number | undefined; /** *A pagination token to retrieve the next set of results. Use the token returned from a previous call to continue listing action connectors.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListActionConnectorsResponse { /** *A list of action connector summaries containing basic information about each connector.
* @public */ ActionConnectorSummaries: ActionConnectorSummary[] | undefined; /** *A pagination token to retrieve the next set of results. If null, there are no more results to retrieve.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status code of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListAgentsRequest { /** *The ID of the Amazon Web Services account that contains the agents.
* @public */ AwsAccountId: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListAgentsResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *A list of agent summaries.
* @public */ AgentSummaries: AgentSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListAnalysesRequest { /** *The ID of the Amazon Web Services account that contains the analyses.
* @public */ AwsAccountId: string | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListAnalysesResponse { /** *Metadata describing each of the analyses that are listed.
* @public */ AnalysisSummaryList?: AnalysisSummary[] | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface ListAssetBundleExportJobsRequest { /** *The ID of the Amazon Web Services account that the export jobs were executed in.
* @public */ AwsAccountId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListAssetBundleExportJobsResponse { /** *A list of export job summaries.
* @public */ AssetBundleExportJobSummaryList?: AssetBundleExportJobSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListAssetBundleImportJobsRequest { /** *The ID of the Amazon Web Services account that the import jobs were executed in.
* @public */ AwsAccountId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListAssetBundleImportJobsResponse { /** *A list of import job summaries.
* @public */ AssetBundleImportJobSummaryList?: AssetBundleImportJobSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the response.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListBrandsRequest { /** *The ID of the Amazon Web Services account that owns the brands that you want to list.
* @public */ AwsAccountId: string | undefined; /** *The maximum number of results to be returned in a single request.
* @public */ MaxResults?: number | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListBrandsResponse { /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *A list of all brands in your Amazon Web Services account. This structure provides basic * information about each brand.
* @public */ Brands?: BrandSummary[] | undefined; } /** * @public */ export interface ListCustomPermissionsRequest { /** *The ID of the Amazon Web Services account that contains the custom permissions profiles that you want to list.
* @public */ AwsAccountId: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListCustomPermissionsResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *A list of custom permissions profiles.
* @public */ CustomPermissionsList?: CustomPermissions[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface ListDashboardsRequest { /** *The ID of the Amazon Web Services account that contains the dashboards that you're * listing.
* @public */ AwsAccountId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListDashboardsResponse { /** *A structure that contains all of the dashboards in your Amazon Web Services account. * This structure provides basic information about the dashboards.
* @public */ DashboardSummaryList?: DashboardSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface ListDashboardVersionsRequest { /** *The ID of the Amazon Web Services account that contains the dashboard that you're * listing versions for.
* @public */ AwsAccountId: string | undefined; /** *The ID for the dashboard.
* @public */ DashboardId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListDashboardVersionsResponse { /** *A structure that contains information about each version of the dashboard.
* @public */ DashboardVersionSummaryList?: DashboardVersionSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface ListDataSetsRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListDataSetsResponse { /** *The list of dataset summaries.
* @public */ DataSetSummaries?: DataSetSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListDataSourcesRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListDataSourcesResponse { /** *A list of data sources.
* @public */ DataSources?: DataSource[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListFlowsInput { /** *The ID of the Amazon Web Services account that contains the flow list that you are getting.
* @public */ AwsAccountId: string | undefined; /** *The token to request the next set of results, or null if you want to retrieve the first set.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListFlowsOutput { /** *A structure that contains all of the flows in your Amazon Web Services account. This structure * provides basic information about the flows.
* @public */ FlowSummaryList?: FlowSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListFolderMembersRequest { /** *The ID for the Amazon Web Services account that contains the folder.
* @public */ AwsAccountId: string | undefined; /** *The ID of the folder.
* @public */ FolderId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListFolderMembersResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.
* @public */ FolderMemberList?: MemberIdArnPair[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface ListFoldersRequest { /** *The ID for the Amazon Web Services account that contains the folder.
* @public */ AwsAccountId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListFoldersResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.
* @public */ FolderSummaryList?: FolderSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface ListFoldersForResourceRequest { /** *The ID for the Amazon Web Services account that contains the resource.
* @public */ AwsAccountId: string | undefined; /** *The Amazon Resource Name (ARN) the resource whose folders you need to list.
* @public */ ResourceArn: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListFoldersForResourceResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *A list that contains the Amazon Resource Names (ARNs) of all folders that the resource is a member of.
* @public */ Folders?: string[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface ListGroupMembershipsRequest { /** *The name of the group that you want to see a membership list of.
* @public */ GroupName: string | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return from this request.
* @public */ MaxResults?: number | undefined; /** *The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace of the group that you want a list of users from.
* @public */ Namespace: string | undefined; } /** * @public */ export interface ListGroupMembershipsResponse { /** *The list of the members of the group.
* @public */ GroupMemberList?: GroupMember[] | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListGroupsRequest { /** *The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; /** *The namespace that you want a list of groups from.
* @public */ Namespace: string | undefined; } /** * @public */ export interface ListGroupsResponse { /** *The list of the groups.
* @public */ GroupList?: Group[] | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListIAMPolicyAssignmentsRequest { /** *The ID of the Amazon Web Services account that contains these IAM policy * assignments.
* @public */ AwsAccountId: string | undefined; /** *The status of the assignments.
* @public */ AssignmentStatus?: AssignmentStatus | undefined; /** *The namespace for the assignments.
* @public */ Namespace: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListIAMPolicyAssignmentsResponse { /** *Information describing the IAM policy assignments.
* @public */ IAMPolicyAssignments?: IAMPolicyAssignmentSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListIAMPolicyAssignmentsForUserRequest { /** *The ID of the Amazon Web Services account that contains the assignments.
* @public */ AwsAccountId: string | undefined; /** *The name of the user.
* @public */ UserName: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; /** *The namespace of the assignment.
* @public */ Namespace: string | undefined; } /** * @public */ export interface ListIAMPolicyAssignmentsForUserResponse { /** *The active assignments for this user.
* @public */ ActiveAssignments?: ActiveIAMPolicyAssignment[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListIdentityPropagationConfigsRequest { /** *The ID of the Amazon Web Services account that contain the identity propagation configurations of.
* @public */ AwsAccountId: string | undefined; /** *The maximum number of results to be returned.
* @public */ MaxResults?: number | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListIdentityPropagationConfigsResponse { /** *A list of services and their authorized targets that the Quick Sight IAM Identity Center application can access.
* @public */ Services?: AuthorizedTargetsByService[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface ListIngestionsRequest { /** *The ID of the dataset used in the ingestion.
* @public */ DataSetId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListIngestionsResponse { /** *A list of the ingestions.
* @public */ Ingestions?: Ingestion[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListKnowledgeBasesRequest { /** *The ID of the Amazon Web Services account that contains the knowledge base.
* @public */ AwsAccountId: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListKnowledgeBasesResponse { /** *A list of knowledge base summaries.
* @public */ KnowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListNamespacesRequest { /** *The ID for the Amazon Web Services account that contains the Quick Sight namespaces that you want to list.
* @public */ AwsAccountId: string | undefined; /** *A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.
The maximum number of results to return.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListNamespacesResponse { /** *The information about the namespaces in this Amazon Web Services account. The response includes * the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and * identity store.
* @public */ Namespaces?: NamespaceInfoV2[] | undefined; /** *A unique pagination token that can be used in a subsequent request. Receiving NextToken in your response inticates that there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.
The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListOAuthClientApplicationsRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; } /** *A summary of an OAuthClientApplication.
* @public */ export interface OAuthClientApplicationSummary { /** *The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ OAuthClientApplicationId?: string | undefined; /** *The display name of the OAuthClientApplication.
* @public */ Name?: string | undefined; /** *The OAuth client authentication type used by the OAuthClientApplication. Valid values are TOKEN.
The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.
VPC connection properties.
* @public */ IdentityProviderVpcConnectionProperties?: VpcConnectionProperties | undefined; /** *The time that the OAuthClientApplication was created.
* @public */ CreatedTime?: Date | undefined; /** *The time that the OAuthClientApplication was last updated.
* @public */ LastUpdatedTime?: Date | undefined; /** *The Amazon Resource Name (ARN) of the OAuthClientApplication.
* @public */ Arn?: string | undefined; } /** * @public */ export interface ListOAuthClientApplicationsResponse { /** *A list of OAuthClientApplication summaries.
* @public */ OAuthClientApplications?: OAuthClientApplicationSummary[] | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListRefreshSchedulesRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the dataset.
* @public */ DataSetId: string | undefined; } /** * @public */ export interface ListRefreshSchedulesResponse { /** *The list of refresh schedules for the dataset.
* @public */ RefreshSchedules?: RefreshSchedule[] | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface ListRoleMembershipsRequest { /** *The name of the role.
* @public */ Role: Role | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; /** *The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace that includes the role.
* @public */ Namespace: string | undefined; } /** * @public */ export interface ListRoleMembershipsResponse { /** *The list of groups associated with a role
* @public */ MembersList?: string[] | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListSelfUpgradesRequest { /** *The ID of the Amazon Web Services account that contains the self-upgrade requests.
* @public */ AwsAccountId: string | undefined; /** *The Quick namespace for the self-upgrade requests.
* @public */ Namespace: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; } /** *Details of a self-upgrade request.
* @public */ export interface SelfUpgradeRequestDetail { /** *The ID of the self-upgrade request.
* @public */ UpgradeRequestId?: string | undefined; /** *The username of the user who initiated the self-upgrade request.
* @public */ UserName?: string | undefined; /** *The original role of the user before the upgrade.
* @public */ OriginalRole?: UserRole | undefined; /** *The role that the user is requesting to upgrade to.
* @public */ RequestedRole?: UserRole | undefined; /** *An optional note explaining the reason for the self-upgrade request.
* @public */ RequestNote?: string | undefined; /** *The time when the self-upgrade request was created.
* @public */ CreationTime?: number | undefined; /** *The status of the self-upgrade request.
* @public */ RequestStatus?: SelfUpgradeRequestStatus | undefined; /** *The time of the last update attempt for the self-upgrade request.
* @public */ lastUpdateAttemptTime?: number | undefined; /** *The reason for the last update failure, if applicable.
* @public */ lastUpdateFailureReason?: string | undefined; } /** * @public */ export interface ListSelfUpgradesResponse { /** *A list of self-upgrade request details.
* @public */ SelfUpgradeRequestDetails?: SelfUpgradeRequestDetail[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListSpaceResourcesRequest { /** *The ID of the Amazon Web Services account that contains the space.
* @public */ AwsAccountId: string | undefined; /** *The ID of the space that you want to list resources for.
* @public */ SpaceId: string | undefined; } /** *A summary of a resource in a space.
* @public */ export interface SpaceResourceSummary { /** *The type of the resource.
* @public */ ResourceType: SpaceQuickSightResourceType | undefined; /** *The details of the resource.
* @public */ ResourceDetails: SpaceQuickSightResourceDetails | undefined; /** *The name of the resource.
* @public */ ResourceName?: string | undefined; /** *The date and time that the resource was last updated.
* @public */ UpdatedAt?: Date | undefined; } /** * @public */ export interface ListSpaceResourcesResponse { /** *The ID of the space.
* @public */ spaceId: string | undefined; /** *The ARN of the space.
* @public */ spaceArn?: string | undefined; /** *A list of resource summaries in the space.
* @public */ SpaceResources: SpaceResourceSummary[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface ListSpacesRequest { /** *The ID of the Amazon Web Services account that contains the spaces.
* @public */ AwsAccountId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; } /** *A summary of an Amazon QuickSight space.
* @public */ export interface SpaceSummary { /** *The ID of the space.
* @public */ spaceId: string | undefined; /** *The ARN of the space.
* @public */ spaceArn?: string | undefined; /** *The display name of the space.
* @public */ name?: string | undefined; /** *The description of the space.
* @public */ description?: string | undefined; /** *The date and time that the space was last updated.
* @public */ updatedAt?: Date | undefined; /** *The total consumed source size in bytes.
* @public */ consumedSourceSize?: number | undefined; /** *The number of consumed source documents.
* @public */ consumedSourceDocCount?: number | undefined; /** *The date and time that the space was created.
* @public */ createdAt?: Date | undefined; /** *The user who created the space.
* @public */ createdBy?: string | undefined; /** *The ARN of the user who created the space.
* @public */ createdByArn?: string | undefined; /** *The number of resources in the space.
* @public */ resourcesCount?: number | undefined; } /** * @public */ export interface ListSpacesResponse { /** *The ID of the space.
* @public */ spaceId: string | undefined; /** *The ARN of the space.
* @public */ spaceArn?: string | undefined; /** *A list of space summaries.
* @public */ SpaceSummaries: SpaceSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface ListTagsForResourceRequest { /** *The Amazon Resource Name (ARN) of the resource that you want a list of tags * for.
* @public */ ResourceArn: string | undefined; } /** * @public */ export interface ListTagsForResourceResponse { /** *Contains a map of the key-value pairs for the resource tag or tags assigned to the * resource.
* @public */ Tags?: Tag[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListTemplateAliasesRequest { /** *The ID of the Amazon Web Services account that contains the template aliases that you're listing.
* @public */ AwsAccountId: string | undefined; /** *The ID for the template.
* @public */ TemplateId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListTemplateAliasesResponse { /** *A structure containing the list of the template's aliases.
* @public */ TemplateAliasList?: TemplateAlias[] | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListTemplatesRequest { /** *The ID of the Amazon Web Services account that contains the templates that you're listing.
* @public */ AwsAccountId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** *The template summary.
* @public */ export interface TemplateSummary { /** *A summary of a template.
* @public */ Arn?: string | undefined; /** *The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TemplateId?: string | undefined; /** *A display name for the template.
* @public */ Name?: string | undefined; /** *A structure containing a list of version numbers for the template summary.
* @public */ LatestVersionNumber?: number | undefined; /** *The last time that this template was created.
* @public */ CreatedTime?: Date | undefined; /** *The last time that this template was updated.
* @public */ LastUpdatedTime?: Date | undefined; } /** * @public */ export interface ListTemplatesResponse { /** *A structure containing information about the templates in the list.
* @public */ TemplateSummaryList?: TemplateSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface ListTemplateVersionsRequest { /** *The ID of the Amazon Web Services account that contains the templates that you're listing.
* @public */ AwsAccountId: string | undefined; /** *The ID for the template.
* @public */ TemplateId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** *The template version.
* @public */ export interface TemplateVersionSummary { /** *The Amazon Resource Name (ARN) of the template version.
* @public */ Arn?: string | undefined; /** *The version number of the template version.
* @public */ VersionNumber?: number | undefined; /** *The time that this template version was created.
* @public */ CreatedTime?: Date | undefined; /** *The status of the template version.
* @public */ Status?: ResourceStatus | undefined; /** *The description of the template version.
* @public */ Description?: string | undefined; } /** * @public */ export interface ListTemplateVersionsResponse { /** *A structure containing a list of all the versions of the specified template.
* @public */ TemplateVersionSummaryList?: TemplateVersionSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface ListThemeAliasesRequest { /** *The ID of the Amazon Web Services account that contains the theme aliases that you're listing.
* @public */ AwsAccountId: string | undefined; /** *The ID for the theme.
* @public */ ThemeId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListThemeAliasesResponse { /** *A structure containing the list of the theme's aliases.
* @public */ ThemeAliasList?: ThemeAlias[] | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface ListThemesRequest { /** *The ID of the Amazon Web Services account that contains the themes that you're listing.
* @public */ AwsAccountId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; /** *The type of themes that you want to list. Valid options include the following:
*
* ALL (default)- Display all existing themes.
* CUSTOM - Display only the themes created by people using Amazon Quick Sight.
* QUICKSIGHT - Display only the starting themes defined by Quick Sight.
The theme summary.
* @public */ export interface ThemeSummary { /** *The Amazon Resource Name (ARN) of the resource.
* @public */ Arn?: string | undefined; /** *the display name for the theme.
* @public */ Name?: string | undefined; /** *The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ ThemeId?: string | undefined; /** *The latest version number for the theme.
* @public */ LatestVersionNumber?: number | undefined; /** *The date and time that this theme was created.
* @public */ CreatedTime?: Date | undefined; /** *The last date and time that this theme was updated.
* @public */ LastUpdatedTime?: Date | undefined; } /** * @public */ export interface ListThemesResponse { /** *Information about the themes in the list.
* @public */ ThemeSummaryList?: ThemeSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface ListThemeVersionsRequest { /** *The ID of the Amazon Web Services account that contains the themes that you're listing.
* @public */ AwsAccountId: string | undefined; /** *The ID for the theme.
* @public */ ThemeId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** *The theme version.
* @public */ export interface ThemeVersionSummary { /** *The version number of the theme version.
* @public */ VersionNumber?: number | undefined; /** *The Amazon Resource Name (ARN) of the theme version.
* @public */ Arn?: string | undefined; /** *The description of the theme version.
* @public */ Description?: string | undefined; /** *The date and time that this theme version was created.
* @public */ CreatedTime?: Date | undefined; /** *The status of the theme version.
* @public */ Status?: ResourceStatus | undefined; } /** * @public */ export interface ListThemeVersionsResponse { /** *A structure containing a list of all the versions of the specified theme.
* @public */ ThemeVersionSummaryList?: ThemeVersionSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface ListTopicRefreshSchedulesRequest { /** *The ID of the Amazon Web Services account that contains the topic whose refresh schedule * you want described.
* @public */ AwsAccountId: string | undefined; /** *The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId: string | undefined; } /** *A summary of the refresh schedule details for a dataset.
* @public */ export interface TopicRefreshScheduleSummary { /** *The ID of the dataset.
* @public */ DatasetId?: string | undefined; /** *The Amazon Resource Name (ARN) of the dataset.
* @public */ DatasetArn?: string | undefined; /** *The name of the dataset.
* @public */ DatasetName?: string | undefined; /** *The definition of a refresh schedule.
* @public */ RefreshSchedule?: TopicRefreshSchedule | undefined; } /** * @public */ export interface ListTopicRefreshSchedulesResponse { /** *The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId?: string | undefined; /** *The Amazon Resource Name (ARN) of the topic.
* @public */ TopicArn?: string | undefined; /** *The list of topic refresh schedules.
* @public */ RefreshSchedules?: TopicRefreshScheduleSummary[] | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface ListTopicReviewedAnswersRequest { /** *The ID of the Amazon Web Services account that containd the reviewed answers that you want listed.
* @public */ AwsAccountId: string | undefined; /** *The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId: string | undefined; } /** * @public */ export interface ListTopicsRequest { /** *The ID of the Amazon Web Services account that contains the topics that you want to * list.
* @public */ AwsAccountId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** *A topic summary.
* @public */ export interface TopicSummary { /** *The Amazon Resource Name (ARN) of the topic.
* @public */ Arn?: string | undefined; /** *The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
* @public */ TopicId?: string | undefined; /** *The name of the topic.
* @public */ Name?: string | undefined; /** *The user experience version of the topic.
* @public */ UserExperienceVersion?: TopicUserExperienceVersion | undefined; } /** * @public */ export interface ListTopicsResponse { /** *A list of topic summaries.
* @public */ TopicsSummaries?: TopicSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListUserGroupsRequest { /** *The Amazon Quick Sight user name that you want to list group memberships for.
* @public */ UserName: string | undefined; /** *The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account * that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace. Currently, you should set this to default.
A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return from this request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface ListUserGroupsResponse { /** *The list of groups the user is a member of.
* @public */ GroupList?: Group[] | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface ListUsersRequest { /** *The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return from this request.
* @public */ MaxResults?: number | undefined; /** *The namespace. Currently, you should set this to default.
The list of users.
* @public */ UserList?: User[] | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** *A filter that matches users by username or email prefix.
* @public */ export interface UserNameOrEmailFilter { /** *The prefix to match against username or email (starts-with match).
* @public */ prefix: string | undefined; } /** *A filter for user index capacity queries. Only one filter type can be specified per request.
* @public */ export type UserIndexCapacityFilter = UserIndexCapacityFilter.TotalCapacityBytesMember | UserIndexCapacityFilter.UserNameOrEmailMember | UserIndexCapacityFilter.$UnknownMember; /** * @public */ export declare namespace UserIndexCapacityFilter { /** *Filter users by username or email prefix.
* @public */ interface UserNameOrEmailMember { userNameOrEmail: UserNameOrEmailFilter; totalCapacityBytes?: never; $unknown?: never; } /** *Filter users by total capacity range in bytes.
* @public */ interface TotalCapacityBytesMember { userNameOrEmail?: never; totalCapacityBytes: CapacityBytesRangeFilter; $unknown?: never; } /** * @public */ interface $UnknownMember { userNameOrEmail?: never; totalCapacityBytes?: never; $unknown: [string, any]; } /** * @deprecated unused in schema-serde mode. * */ interface VisitorThe ID of the Amazon Web Services account that contains the index capacity data.
* @public */ awsAccountId: string | undefined; /** *The namespace to scope the user search to. Required when the userNameOrEmail filter is present.
* @public */ namespace?: string | undefined; /** *Filters to apply. Only one filter is supported per request. The userNameOrEmail and totalCapacityBytes filters are mutually exclusive.
* @public */ filters?: UserIndexCapacityFilter[] | undefined; /** *The field to sort results by.
* @public */ sortBy?: UserIndexCapacitySortBy | undefined; /** *The sort order for results. Defaults to DESC if not specified.
* @public */ sortOrder?: UserIndexCapacitySortOrder | undefined; /** *The maximum number of results to return per page.
* @public */ maxResults?: number | undefined; /** *The token for the next set of results, received from a previous call.
* @public */ nextToken?: string | undefined; } /** *A summary of a user's index capacity consumption.
* @public */ export interface UserIndexCapacity { /** *The ARN of the user.
* @public */ userArn?: string | undefined; /** *The username of the user.
* @public */ userName?: string | undefined; /** *The email address of the user.
* @public */ email?: string | undefined; /** *The role of the user.
* @public */ role?: string | undefined; /** *The total index capacity consumed by the user in bytes.
* @public */ totalCapacityBytes?: number | undefined; /** *The total index capacity consumed by the user's knowledge bases in bytes.
* @public */ totalKBCapacityBytes?: number | undefined; /** *The total index capacity consumed by the user's spaces in bytes.
* @public */ totalSpaceCapacityBytes?: number | undefined; /** *The number of knowledge bases owned by the user.
* @public */ kbCount?: number | undefined; /** *The number of spaces owned by the user.
* @public */ spaceCount?: number | undefined; } /** * @public */ export interface ListUsersIndexCapacityResponse { /** *The list of users with their index capacity metrics.
* @public */ users?: UserIndexCapacity[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ nextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ requestId?: string | undefined; } /** * @public */ export interface ListVPCConnectionsRequest { /** *The Amazon Web Services account ID of the account that contains the VPC connections * that you want to list.
* @public */ AwsAccountId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** *The summary metadata that describes a VPC connection.
* @public */ export interface VPCConnectionSummary { /** *The ID of the VPC connection that * you're * creating. This ID is a unique identifier for each Amazon Web Services Region in an * Amazon Web Services account.
* @public */ VPCConnectionId?: string | undefined; /** *The Amazon Resource Name (ARN) of the VPC connection.
* @public */ Arn?: string | undefined; /** *The display name for the VPC connection.
* @public */ Name?: string | undefined; /** *The Amazon EC2 VPC ID associated with the VPC connection.
* @public */ VPCId?: string | undefined; /** *The Amazon EC2 security group IDs associated with the VPC connection.
* @public */ SecurityGroupIds?: string[] | undefined; /** *A list of IP addresses of DNS resolver endpoints for the VPC connection.
* @public */ DnsResolvers?: string[] | undefined; /** *The status of the VPC connection.
* @public */ Status?: VPCConnectionResourceStatus | undefined; /** *The availability status of the VPC connection.
* @public */ AvailabilityStatus?: VPCConnectionAvailabilityStatus | undefined; /** *A list of network interfaces.
* @public */ NetworkInterfaces?: NetworkInterface[] | undefined; /** *The ARN of the IAM role associated * with the VPC connection.
* @public */ RoleArn?: string | undefined; /** *The time that the VPC connection was created.
* @public */ CreatedTime?: Date | undefined; /** *The time that the VPC connection was last updated.
* @public */ LastUpdatedTime?: Date | undefined; } /** * @public */ export interface ListVPCConnectionsResponse { /** *A VPCConnectionSummaries object that returns a summary of VPC connection
* objects.
The token for the next set of results, or null if there are no more * results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface PredictQAResultsRequest { /** *The ID of the Amazon Web Services account that the user wants to execute Predict QA results in.
* @public */ AwsAccountId: string | undefined; /** *The query text to be used to predict QA results.
* @public */ QueryText: string | undefined; /** *Indicates whether Q indicies are included or excluded.
* @public */ IncludeQuickSightQIndex?: IncludeQuickSightQIndex | undefined; /** *Indicates whether generated answers are included or excluded.
* @public */ IncludeGeneratedAnswer?: IncludeGeneratedAnswer | undefined; /** *The number of maximum topics to be considered to predict QA results.
* @public */ MaxTopicsToConsider?: number | undefined; } /** *The QA result that is made from the DashboardVisual or GeneratedAnswer.
The type of QA result.
* @public */ ResultType?: QAResultType | undefined; /** *The representation of a dashboard visual result.
* @public */ DashboardVisual?: DashboardVisualResult | undefined; /** *The representation of a generated answer result.
* @public */ GeneratedAnswer?: GeneratedAnswerResult | undefined; } /** * @public */ export interface PredictQAResultsResponse { /** *The primary visual response.
* @public */ PrimaryResult?: QAResult | undefined; /** *Additional visual responses.
* @public */ AdditionalResults?: QAResult[] | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface PutDataSetRefreshPropertiesRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The ID of the dataset.
* @public */ DataSetId: string | undefined; /** *The dataset refresh properties.
* @public */ DataSetRefreshProperties: DataSetRefreshProperties | undefined; } /** * @public */ export interface PutDataSetRefreshPropertiesResponse { /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface RegisterUserRequest { /** *The identity type that your Quick Sight account uses to manage the identity of users.
* @public */ IdentityType: IdentityType | undefined; /** *The email address of the user that you want to register.
* @public */ Email: string | undefined; /** *The Amazon Quick Sight role for the user. The user role can be one of the * following:
*
* READER: A user who has read-only access to dashboards.
* AUTHOR: A user who can create data sources, datasets, analyses, and
* dashboards.
* ADMIN: A user who is an author, who can also manage Amazon Quick Sight
* settings.
* READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can build stories with Amazon Q, and can generate executive summaries from dashboards.
* AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.
* ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon Quick Sight administrative settings. Admin Pro users are billed at Author Pro pricing.
* RESTRICTED_READER: This role isn't currently available for
* use.
* RESTRICTED_AUTHOR: This role isn't currently available for
* use.
The ARN of the IAM user or role that you are registering with Amazon Quick Sight.
* @public */ IamArn?: string | undefined; /** *You need to use this parameter only when you register one or more users using an assumed
* IAM role. You don't need to provide the session name for other scenarios, for example when
* you are registering an IAM user or an Amazon Quick Sight user. You can register multiple
* users using the same IAM role if each user has a different session name. For more
* information on assuming IAM roles, see
* assume-role
* in the CLI Reference.
*
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *The namespace. Currently, you should set this to default.
The Amazon Quick Sight user name that you want to create for the user you are * registering.
* @public */ UserName?: string | undefined; /** *(Enterprise edition only) The name of the custom permissions profile that you want to * assign to this user. Customized permissions allows you to control a user's access by * restricting access the following operations:
*Create and update data sources
*Create and update datasets
*Create and update email reports
*Subscribe to email reports
*To add custom permissions to an existing user, use
* UpdateUser
* instead.
A set of custom permissions includes any combination of these restrictions. Currently,
* you need to create the profile names for custom permission sets by using the Quick Sight
* console. Then, you use the RegisterUser API operation to assign the named set of
* permissions to a Quick Sight user.
Quick Sight custom permissions are applied through IAM policies. Therefore, they * override the permissions typically granted by assigning Quick Sight users to one of the * default security cohorts in Quick Sight (admin, author, reader, admin pro, author pro, reader pro).
*This feature is available only to Quick Sight Enterprise edition subscriptions.
* @public */ CustomPermissionsName?: string | undefined; /** *The type of supported external login provider that provides identity to let a user federate into Amazon Quick Sight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.
*
* COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.
* CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
* into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should
* only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
The identity ID for a user in the external login provider.
* @public */ ExternalLoginId?: string | undefined; /** *The tags to associate with the user.
* @public */ Tags?: Tag[] | undefined; } /** * @public */ export interface RegisterUserResponse { /** *The user's user name.
* @public */ User?: User | undefined; /** *The URL the user visits to complete registration and provide a password. This is
* returned only for users with an identity type of QUICKSIGHT.
The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface RestoreAnalysisRequest { /** *The ID of the Amazon Web Services account that contains the analysis.
* @public */ AwsAccountId: string | undefined; /** *The ID of the analysis that you're restoring.
* @public */ AnalysisId: string | undefined; /** *A boolean value that determines if the analysis will be restored to folders that it previously resided in. A True value restores analysis back to all folders that it previously resided in. A False value restores the analysis but does not restore the analysis back to all previously resided folders. Restoring a restricted analysis requires this parameter to be set to True.
The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Resource Name (ARN) of the analysis that you're restoring.
* @public */ Arn?: string | undefined; /** *The ID of the analysis that you're restoring. *
* @public */ AnalysisId?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *A list of folder arns thatthe analysis failed to be restored to.
* @public */ RestorationFailedFolderArns?: string[] | undefined; } /** * @public */ export interface SearchActionConnectorsRequest { /** *The Amazon Web Services account ID in which to search for action connectors.
* @public */ AwsAccountId: string | undefined; /** *The maximum number of action connectors to return in a single response. Valid range is 1 to 100.
* @public */ MaxResults?: number | undefined; /** *A pagination token to retrieve the next set of results. Use the token returned from a previous call to continue searching.
* @public */ NextToken?: string | undefined; /** *The search filters to apply. You can filter by connector name, type, or user permissions. Maximum of one filter is supported.
* @public */ Filters: ActionConnectorSearchFilter[] | undefined; } /** * @public */ export interface SearchActionConnectorsResponse { /** *A pagination token to retrieve the next set of results. If null, there are no more results to retrieve.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status code of the request.
* @public */ Status?: number | undefined; /** *A list of action connector summaries that match the search criteria.
* @public */ ActionConnectorSummaries?: ActionConnectorSummary[] | undefined; } /** * @public */ export interface SearchAgentsRequest { /** *The ID of the Amazon Web Services account that contains the agents.
* @public */ AwsAccountId: string | undefined; /** *The filters to apply when searching agents.
* @public */ Filters: AgentSearchFilter[] | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; } /** * @public */ export interface SearchAgentsResponse { /** *A list of agent summaries.
* @public */ AgentSummaries?: AgentSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface SearchAnalysesRequest { /** *The ID of the Amazon Web Services account that contains the analyses that you're searching * for.
* @public */ AwsAccountId: string | undefined; /** *The structure for the search filters that you want to apply to your search.
* @public */ Filters: AnalysisSearchFilter[] | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface SearchAnalysesResponse { /** *Metadata describing the analyses that you searched for.
* @public */ AnalysisSummaryList?: AnalysisSummary[] | undefined; /** *A pagination token that can be used in a subsequent request. *
* @public */ NextToken?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface SearchDashboardsRequest { /** *The ID of the Amazon Web Services account that contains the user whose dashboards * you're searching for.
* @public */ AwsAccountId: string | undefined; /** *The filters to apply to the search. Currently, you can search only by user name, for
* example, "Filters": [ \{ "Name": "QUICKSIGHT_USER", "Operator": "StringEquals",
* "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" \}
* ]
*
The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface SearchDashboardsResponse { /** *The list of dashboards owned by the user specified in Filters in your
* request.
The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface SearchDataSetsRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The filters to apply to the search.
* @public */ Filters: DataSetSearchFilter[] | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface SearchDataSetsResponse { /** *A DataSetSummaries object that returns a summary of a dataset.
A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface SearchDataSourcesRequest { /** *The Amazon Web Services account ID.
* @public */ AwsAccountId: string | undefined; /** *The filters to apply to the search.
* @public */ Filters: DataSourceSearchFilter[] | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface SearchDataSourcesResponse { /** *A DataSourceSummaries object that returns a summary of a data
* source.
A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** *A structure that contains the filter information when searching flows.
* @public */ export interface SearchFlowsFilter { /** *The name of the value that you want to use as a filter, for example "Name":
* "DIRECT_QUICKSIGHT_SOLE_OWNER".
Valid values are defined as follows:
*
* assetName: Any flows whose names have a substring match to this value will be returned.
* assetDescription: Any flows whose descriptions have a substring match to this value will be returned.
* DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.
* DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered.
* DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered.
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".
The value of the named item, in this case DIRECT_QUICKSIGHT_SOLE_OWNER, that you want
* to use as a filter, for example "Value". An example is
* "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
The ID of the Amazon Web Services account where you are searching for flows from.
* @public */ AwsAccountId: string | undefined; /** *The filters applied to the search when searching for flows in the Amazon Web Services account.
* @public */ Filters: SearchFlowsFilter[] | undefined; /** *The token to request the next set of results, or null if you want to retrieve the first set.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface SearchFlowsOutput { /** *The list of flows found against the search.
* @public */ FlowSummaryList: FlowSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface SearchFoldersRequest { /** *The ID for the Amazon Web Services account that contains the folder.
* @public */ AwsAccountId: string | undefined; /** *The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ \{ "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" \} ].
The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface SearchFoldersResponse { /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.
* @public */ FolderSummaryList?: FolderSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface SearchGroupsRequest { /** *The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the * Amazon Web Services account that contains your Amazon Quick Sight account.
* @public */ AwsAccountId: string | undefined; /** *A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return from this request.
* @public */ MaxResults?: number | undefined; /** *The namespace that you want to search.
* @public */ Namespace: string | undefined; /** *The structure for the search filters that you want to apply to your search.
* @public */ Filters: GroupSearchFilter[] | undefined; } /** * @public */ export interface SearchGroupsResponse { /** *A list of groups in a specified namespace that match the filters you set in your SearchGroups request.
A pagination token that can be used in a subsequent request.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** * @public */ export interface SearchKnowledgeBasesRequest { /** *The ID of the Amazon Web Services account that contains the knowledge base.
* @public */ AwsAccountId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; /** *The filters to apply when searching knowledge bases.
* @public */ Filters?: KnowledgeBaseSearchFilter[] | undefined; /** *The sort configuration for the search results.
* @public */ SortBy?: KnowledgeBaseSortBy | undefined; } /** * @public */ export interface SearchKnowledgeBasesResponse { /** *A list of knowledge base summaries.
* @public */ KnowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; } /** *A filter to use when searching for spaces.
* @public */ export interface SpaceQuicksightSearchFilter { /** *The name of the filter field to use.
* @public */ name: SpaceQuickSightSearchFilterName | undefined; /** *The comparison operator to use for the filter.
* @public */ operator: SpaceSearchOperator | undefined; /** *The value to use for the filter.
* @public */ value: string | undefined; } /** * @public */ export interface SearchSpacesRequest { /** *The ID of the Amazon Web Services account that contains the spaces.
* @public */ AwsAccountId: string | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to return.
* @public */ MaxResults?: number | undefined; /** *The filters to apply to the search.
* @public */ Filters: SpaceQuicksightSearchFilter[] | undefined; } /** * @public */ export interface SearchSpacesResponse { /** *The ID of the space.
* @public */ spaceId: string | undefined; /** *The ARN of the space.
* @public */ spaceArn?: string | undefined; /** *A list of space summaries that match the search criteria.
* @public */ SpaceSummaries: SpaceSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** *The filter that is used to search for a topic.
* @public */ export interface TopicSearchFilter { /** *The operator like equals or like.
* @public */ Operator: TopicFilterOperator | undefined; /** *The name of the topic search filter.
* @public */ Name: TopicFilterAttribute | undefined; /** *The value of the topic search filter.
* @public */ Value: string | undefined; } /** * @public */ export interface SearchTopicsRequest { /** *The ID of the Amazon Web Services account that contains the topic that you want to find.
* @public */ AwsAccountId: string | undefined; /** *The filters that you want to use to search for the topic.
* @public */ Filters: TopicSearchFilter[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The maximum number of results to be returned per request.
* @public */ MaxResults?: number | undefined; } /** * @public */ export interface SearchTopicsResponse { /** *A list of topic summaries that is returned by the search topic request.
* @public */ TopicSummaryList?: TopicSummary[] | undefined; /** *The token for the next set of results, or null if there are no more results.
* @public */ NextToken?: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** * @public */ export interface StartAssetBundleExportJobRequest { /** *The ID of the Amazon Web Services account to export assets from.
* @public */ AwsAccountId: string | undefined; /** *The ID of the job. This ID is unique while the job is running. After the job is * completed, you can reuse this ID for another job.
* @public */ AssetBundleExportJobId: string | undefined; /** *An array of resource ARNs to export. The following resources are supported.
*
* Analysis
*
* Dashboard
*
* DataSet
*
* DataSource
*
* RefreshSchedule
*
* Theme
*
* VPCConnection
*
The API caller must have the necessary permissions in their IAM role to * access each resource before the resources can be exported.
* @public */ ResourceArns: string[] | undefined; /** *A Boolean that determines whether all dependencies of each resource ARN are recursively
* exported with the job. For example, say you provided a Dashboard ARN to the
* ResourceArns parameter. If you set IncludeAllDependencies to
* TRUE, any theme, dataset, and data source resource that is a dependency of
* the dashboard is also exported.
The export data format.
* @public */ ExportFormat: AssetBundleExportFormat | undefined; /** *An optional collection of structures that generate CloudFormation parameters to * override the existing resource property values when the resource is exported to a new * CloudFormation template.
*Use this field if the ExportFormat field of a
* StartAssetBundleExportJobRequest API call is set to
* CLOUDFORMATION_JSON.
A Boolean that determines whether all permissions for each resource ARN are exported
* with the job. If you set IncludePermissions to TRUE, any
* permissions associated with each resource are exported.
A Boolean that determines whether all tags for each resource ARN are exported with the
* job. If you set IncludeTags to TRUE, any tags associated with
* each resource are exported.
An optional parameter that determines which validation strategy to use for the export
* job. If StrictModeForAllResources is set to TRUE, strict
* validation for every error is enforced. If it is set to FALSE, validation is
* skipped for specific UI errors that are shown as warnings. The default value for
* StrictModeForAllResources is FALSE.
A Boolean that determines if the exported asset carries over information about the * folders that the asset is a member of.
* @public */ IncludeFolderMemberships?: boolean | undefined; /** *A setting that indicates whether you want to include folder assets. You can also use * this setting to recusrsively include all subfolders of an exported folder.
* @public */ IncludeFolderMembers?: IncludeFolderMembers | undefined; } /** * @public */ export interface StartAssetBundleExportJobResponse { /** *The Amazon Resource Name (ARN) for the export job.
* @public */ Arn?: string | undefined; /** *The ID of the job. This ID is unique while the job is running. After the job is * completed, you can reuse this ID for another job.
* @public */ AssetBundleExportJobId?: string | undefined; /** *The Amazon Web Services response ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the response.
* @public */ Status?: number | undefined; } /** * @public */ export interface StartAssetBundleImportJobRequest { /** *The ID of the Amazon Web Services account to import assets into.
* @public */ AwsAccountId: string | undefined; /** *The ID of the job. This ID is unique while the job is running. After the job is * completed, you can reuse this ID for another job.
* @public */ AssetBundleImportJobId: string | undefined; /** *The source of the asset bundle zip file that contains the data that you want to import.
* The file must be in QUICKSIGHT_JSON format.
Optional overrides that are applied to the resource configuration before import.
* @public */ OverrideParameters?: AssetBundleImportJobOverrideParameters | undefined; /** *The failure action for the import job.
*If you choose ROLLBACK, failed import jobs will attempt to undo any asset
* changes caused by the failed job.
If you choose DO_NOTHING, failed import jobs will not attempt to roll back
* any asset changes caused by the failed job, possibly keeping the Amazon Quick Sight account
* in an inconsistent state.
Optional permission overrides that are applied to the resource configuration before * import.
* @public */ OverridePermissions?: AssetBundleImportJobOverridePermissions | undefined; /** *Optional tag overrides that are applied to the resource configuration before * import.
* @public */ OverrideTags?: AssetBundleImportJobOverrideTags | undefined; /** *An optional validation strategy override for all analyses and dashboards that is applied * to the resource configuration before import.
* @public */ OverrideValidationStrategy?: AssetBundleImportJobOverrideValidationStrategy | undefined; } /** * @public */ export interface StartAssetBundleImportJobResponse { /** *The Amazon Resource Name (ARN) for the import job.
* @public */ Arn?: string | undefined; /** *The ID of the job. This ID is unique while the job is running. After the job is * completed, you can reuse this ID for another job.
* @public */ AssetBundleImportJobId?: string | undefined; /** *The Amazon Web Services response ID for this operation.
* @public */ RequestId?: string | undefined; /** *The HTTP status of the response.
* @public */ Status?: number | undefined; } /** * @public */ export interface StartAutomationJobRequest { /** *The ID of the Amazon Web Services account that contains the automation.
* @public */ AwsAccountId: string | undefined; /** *The ID of the automation group that contains the automation to run.
* @public */ AutomationGroupId: string | undefined; /** *The ID of the automation to run.
* @public */ AutomationId: string | undefined; /** *The input payload for the automation job, provided as a JSON string.
* @public */ InputPayload?: string | undefined; } /** * @public */ export interface StartAutomationJobResponse { /** *The Amazon Resource Name (ARN) of the automation job.
* @public */ Arn: string | undefined; /** *The ID of the automation job that was started.
* @public */ JobId: string | undefined; /** *The HTTP status of the request.
* @public */ Status?: number | undefined; /** *The Amazon Web Services request ID for this operation.
* @public */ RequestId?: string | undefined; } /** *A structure that contains information on the anonymous user configuration.
* @public */ export interface SnapshotAnonymousUser { /** *The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a DataSet$RowLevelPermissionTagConfiguration API call.
These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon Quick Sight, see Using Row-Level Security (RLS) with Tagsin the Amazon Quick User Guide.
* @public */ RowLevelPermissionTags?: SessionTag[] | undefined; }