Documentation
¶
Overview ¶
Package quicksight provides the API client, operations, and parameter types for Amazon QuickSight.
Amazon Quick API Reference ¶
Amazon Quick Sight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon Quick Sight.
Index ¶
- Constants
- Variables
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AuthResolverParameters
- type AuthSchemeResolver
- type BatchCreateTopicReviewedAnswerInput
- type BatchCreateTopicReviewedAnswerOutput
- type BatchDeleteKnowledgeBaseInput
- type BatchDeleteKnowledgeBaseOutput
- type BatchDeleteTopicReviewedAnswerInput
- type BatchDeleteTopicReviewedAnswerOutput
- type BatchDescribeUserLimitsInput
- type BatchDescribeUserLimitsOutput
- type CancelIngestionInput
- type CancelIngestionOutput
- type Client
- func (c *Client) BatchCreateTopicReviewedAnswer(ctx context.Context, params *BatchCreateTopicReviewedAnswerInput, ...) (*BatchCreateTopicReviewedAnswerOutput, error)
- func (c *Client) BatchDeleteKnowledgeBase(ctx context.Context, params *BatchDeleteKnowledgeBaseInput, ...) (*BatchDeleteKnowledgeBaseOutput, error)
- func (c *Client) BatchDeleteTopicReviewedAnswer(ctx context.Context, params *BatchDeleteTopicReviewedAnswerInput, ...) (*BatchDeleteTopicReviewedAnswerOutput, error)
- func (c *Client) BatchDescribeUserLimits(ctx context.Context, params *BatchDescribeUserLimitsInput, ...) (*BatchDescribeUserLimitsOutput, error)
- func (c *Client) CancelIngestion(ctx context.Context, params *CancelIngestionInput, optFns ...func(*Options)) (*CancelIngestionOutput, error)
- func (c *Client) CreateAccountCustomization(ctx context.Context, params *CreateAccountCustomizationInput, ...) (*CreateAccountCustomizationOutput, error)
- func (c *Client) CreateAccountSubscription(ctx context.Context, params *CreateAccountSubscriptionInput, ...) (*CreateAccountSubscriptionOutput, error)
- func (c *Client) CreateActionConnector(ctx context.Context, params *CreateActionConnectorInput, ...) (*CreateActionConnectorOutput, error)
- func (c *Client) CreateAgent(ctx context.Context, params *CreateAgentInput, optFns ...func(*Options)) (*CreateAgentOutput, error)
- func (c *Client) CreateAnalysis(ctx context.Context, params *CreateAnalysisInput, optFns ...func(*Options)) (*CreateAnalysisOutput, error)
- func (c *Client) CreateApprovalPolicy(ctx context.Context, params *CreateApprovalPolicyInput, ...) (*CreateApprovalPolicyOutput, error)
- func (c *Client) CreateBrand(ctx context.Context, params *CreateBrandInput, optFns ...func(*Options)) (*CreateBrandOutput, error)
- func (c *Client) CreateCustomPermissions(ctx context.Context, params *CreateCustomPermissionsInput, ...) (*CreateCustomPermissionsOutput, error)
- func (c *Client) CreateDashboard(ctx context.Context, params *CreateDashboardInput, optFns ...func(*Options)) (*CreateDashboardOutput, error)
- func (c *Client) CreateDataSet(ctx context.Context, params *CreateDataSetInput, optFns ...func(*Options)) (*CreateDataSetOutput, error)
- func (c *Client) CreateDataSource(ctx context.Context, params *CreateDataSourceInput, optFns ...func(*Options)) (*CreateDataSourceOutput, error)
- func (c *Client) CreateDlpSetting(ctx context.Context, params *CreateDlpSettingInput, optFns ...func(*Options)) (*CreateDlpSettingOutput, error)
- func (c *Client) CreateFlow(ctx context.Context, params *CreateFlowInput, optFns ...func(*Options)) (*CreateFlowOutput, error)
- func (c *Client) CreateFolder(ctx context.Context, params *CreateFolderInput, optFns ...func(*Options)) (*CreateFolderOutput, error)
- func (c *Client) CreateFolderMembership(ctx context.Context, params *CreateFolderMembershipInput, ...) (*CreateFolderMembershipOutput, error)
- func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error)
- func (c *Client) CreateGroupMembership(ctx context.Context, params *CreateGroupMembershipInput, ...) (*CreateGroupMembershipOutput, error)
- func (c *Client) CreateIAMPolicyAssignment(ctx context.Context, params *CreateIAMPolicyAssignmentInput, ...) (*CreateIAMPolicyAssignmentOutput, error)
- func (c *Client) CreateIngestion(ctx context.Context, params *CreateIngestionInput, optFns ...func(*Options)) (*CreateIngestionOutput, error)
- func (c *Client) CreateKnowledgeBase(ctx context.Context, params *CreateKnowledgeBaseInput, ...) (*CreateKnowledgeBaseOutput, error)
- func (c *Client) CreateLimitsProfile(ctx context.Context, params *CreateLimitsProfileInput, ...) (*CreateLimitsProfileOutput, error)
- func (c *Client) CreateNamespace(ctx context.Context, params *CreateNamespaceInput, optFns ...func(*Options)) (*CreateNamespaceOutput, error)
- func (c *Client) CreateOAuthClientApplication(ctx context.Context, params *CreateOAuthClientApplicationInput, ...) (*CreateOAuthClientApplicationOutput, error)
- func (c *Client) CreateRefreshSchedule(ctx context.Context, params *CreateRefreshScheduleInput, ...) (*CreateRefreshScheduleOutput, error)
- func (c *Client) CreateRoleMembership(ctx context.Context, params *CreateRoleMembershipInput, ...) (*CreateRoleMembershipOutput, error)
- func (c *Client) CreateSpace(ctx context.Context, params *CreateSpaceInput, optFns ...func(*Options)) (*CreateSpaceOutput, error)
- func (c *Client) CreateTemplate(ctx context.Context, params *CreateTemplateInput, optFns ...func(*Options)) (*CreateTemplateOutput, error)
- func (c *Client) CreateTemplateAlias(ctx context.Context, params *CreateTemplateAliasInput, ...) (*CreateTemplateAliasOutput, error)
- func (c *Client) CreateTheme(ctx context.Context, params *CreateThemeInput, optFns ...func(*Options)) (*CreateThemeOutput, error)
- func (c *Client) CreateThemeAlias(ctx context.Context, params *CreateThemeAliasInput, optFns ...func(*Options)) (*CreateThemeAliasOutput, error)
- func (c *Client) CreateTopic(ctx context.Context, params *CreateTopicInput, optFns ...func(*Options)) (*CreateTopicOutput, error)
- func (c *Client) CreateTopicRefreshSchedule(ctx context.Context, params *CreateTopicRefreshScheduleInput, ...) (*CreateTopicRefreshScheduleOutput, error)
- func (c *Client) CreateTopicV2(ctx context.Context, params *CreateTopicV2Input, optFns ...func(*Options)) (*CreateTopicV2Output, error)
- func (c *Client) CreateVPCConnection(ctx context.Context, params *CreateVPCConnectionInput, ...) (*CreateVPCConnectionOutput, error)
- func (c *Client) DeleteAccountCustomPermission(ctx context.Context, params *DeleteAccountCustomPermissionInput, ...) (*DeleteAccountCustomPermissionOutput, error)
- func (c *Client) DeleteAccountCustomization(ctx context.Context, params *DeleteAccountCustomizationInput, ...) (*DeleteAccountCustomizationOutput, error)
- func (c *Client) DeleteAccountSubscription(ctx context.Context, params *DeleteAccountSubscriptionInput, ...) (*DeleteAccountSubscriptionOutput, error)
- func (c *Client) DeleteActionConnector(ctx context.Context, params *DeleteActionConnectorInput, ...) (*DeleteActionConnectorOutput, error)
- func (c *Client) DeleteAgent(ctx context.Context, params *DeleteAgentInput, optFns ...func(*Options)) (*DeleteAgentOutput, error)
- func (c *Client) DeleteAnalysis(ctx context.Context, params *DeleteAnalysisInput, optFns ...func(*Options)) (*DeleteAnalysisOutput, error)
- func (c *Client) DeleteApp(ctx context.Context, params *DeleteAppInput, optFns ...func(*Options)) (*DeleteAppOutput, error)
- func (c *Client) DeleteApprovalPolicy(ctx context.Context, params *DeleteApprovalPolicyInput, ...) (*DeleteApprovalPolicyOutput, error)
- func (c *Client) DeleteBrand(ctx context.Context, params *DeleteBrandInput, optFns ...func(*Options)) (*DeleteBrandOutput, error)
- func (c *Client) DeleteBrandAssignment(ctx context.Context, params *DeleteBrandAssignmentInput, ...) (*DeleteBrandAssignmentOutput, error)
- func (c *Client) DeleteCustomPermissions(ctx context.Context, params *DeleteCustomPermissionsInput, ...) (*DeleteCustomPermissionsOutput, error)
- func (c *Client) DeleteDashboard(ctx context.Context, params *DeleteDashboardInput, optFns ...func(*Options)) (*DeleteDashboardOutput, error)
- func (c *Client) DeleteDataSet(ctx context.Context, params *DeleteDataSetInput, optFns ...func(*Options)) (*DeleteDataSetOutput, error)
- func (c *Client) DeleteDataSetRefreshProperties(ctx context.Context, params *DeleteDataSetRefreshPropertiesInput, ...) (*DeleteDataSetRefreshPropertiesOutput, error)
- func (c *Client) DeleteDataSource(ctx context.Context, params *DeleteDataSourceInput, optFns ...func(*Options)) (*DeleteDataSourceOutput, error)
- func (c *Client) DeleteDefaultQBusinessApplication(ctx context.Context, params *DeleteDefaultQBusinessApplicationInput, ...) (*DeleteDefaultQBusinessApplicationOutput, error)
- func (c *Client) DeleteDlpSetting(ctx context.Context, params *DeleteDlpSettingInput, optFns ...func(*Options)) (*DeleteDlpSettingOutput, error)
- func (c *Client) DeleteFlow(ctx context.Context, params *DeleteFlowInput, optFns ...func(*Options)) (*DeleteFlowOutput, error)
- func (c *Client) DeleteFolder(ctx context.Context, params *DeleteFolderInput, optFns ...func(*Options)) (*DeleteFolderOutput, error)
- func (c *Client) DeleteFolderMembership(ctx context.Context, params *DeleteFolderMembershipInput, ...) (*DeleteFolderMembershipOutput, error)
- func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error)
- func (c *Client) DeleteGroupMembership(ctx context.Context, params *DeleteGroupMembershipInput, ...) (*DeleteGroupMembershipOutput, error)
- func (c *Client) DeleteIAMPolicyAssignment(ctx context.Context, params *DeleteIAMPolicyAssignmentInput, ...) (*DeleteIAMPolicyAssignmentOutput, error)
- func (c *Client) DeleteIdentityPropagationConfig(ctx context.Context, params *DeleteIdentityPropagationConfigInput, ...) (*DeleteIdentityPropagationConfigOutput, error)
- func (c *Client) DeleteKnowledgeBase(ctx context.Context, params *DeleteKnowledgeBaseInput, ...) (*DeleteKnowledgeBaseOutput, error)
- func (c *Client) DeleteLimitsProfile(ctx context.Context, params *DeleteLimitsProfileInput, ...) (*DeleteLimitsProfileOutput, error)
- func (c *Client) DeleteNamespace(ctx context.Context, params *DeleteNamespaceInput, optFns ...func(*Options)) (*DeleteNamespaceOutput, error)
- func (c *Client) DeleteOAuthClientApplication(ctx context.Context, params *DeleteOAuthClientApplicationInput, ...) (*DeleteOAuthClientApplicationOutput, error)
- func (c *Client) DeleteRefreshSchedule(ctx context.Context, params *DeleteRefreshScheduleInput, ...) (*DeleteRefreshScheduleOutput, error)
- func (c *Client) DeleteRoleCustomPermission(ctx context.Context, params *DeleteRoleCustomPermissionInput, ...) (*DeleteRoleCustomPermissionOutput, error)
- func (c *Client) DeleteRoleMembership(ctx context.Context, params *DeleteRoleMembershipInput, ...) (*DeleteRoleMembershipOutput, error)
- func (c *Client) DeleteSpace(ctx context.Context, params *DeleteSpaceInput, optFns ...func(*Options)) (*DeleteSpaceOutput, error)
- func (c *Client) DeleteTemplate(ctx context.Context, params *DeleteTemplateInput, optFns ...func(*Options)) (*DeleteTemplateOutput, error)
- func (c *Client) DeleteTemplateAlias(ctx context.Context, params *DeleteTemplateAliasInput, ...) (*DeleteTemplateAliasOutput, error)
- func (c *Client) DeleteTheme(ctx context.Context, params *DeleteThemeInput, optFns ...func(*Options)) (*DeleteThemeOutput, error)
- func (c *Client) DeleteThemeAlias(ctx context.Context, params *DeleteThemeAliasInput, optFns ...func(*Options)) (*DeleteThemeAliasOutput, error)
- func (c *Client) DeleteTopic(ctx context.Context, params *DeleteTopicInput, optFns ...func(*Options)) (*DeleteTopicOutput, error)
- func (c *Client) DeleteTopicRefreshSchedule(ctx context.Context, params *DeleteTopicRefreshScheduleInput, ...) (*DeleteTopicRefreshScheduleOutput, error)
- func (c *Client) DeleteTopicV2(ctx context.Context, params *DeleteTopicV2Input, optFns ...func(*Options)) (*DeleteTopicV2Output, error)
- func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)
- func (c *Client) DeleteUserByPrincipalId(ctx context.Context, params *DeleteUserByPrincipalIdInput, ...) (*DeleteUserByPrincipalIdOutput, error)
- func (c *Client) DeleteUserCustomPermission(ctx context.Context, params *DeleteUserCustomPermissionInput, ...) (*DeleteUserCustomPermissionOutput, error)
- func (c *Client) DeleteVPCConnection(ctx context.Context, params *DeleteVPCConnectionInput, ...) (*DeleteVPCConnectionOutput, error)
- func (c *Client) DescribeAccountCustomPermission(ctx context.Context, params *DescribeAccountCustomPermissionInput, ...) (*DescribeAccountCustomPermissionOutput, error)
- func (c *Client) DescribeAccountCustomization(ctx context.Context, params *DescribeAccountCustomizationInput, ...) (*DescribeAccountCustomizationOutput, error)
- func (c *Client) DescribeAccountSettings(ctx context.Context, params *DescribeAccountSettingsInput, ...) (*DescribeAccountSettingsOutput, error)
- func (c *Client) DescribeAccountSubscription(ctx context.Context, params *DescribeAccountSubscriptionInput, ...) (*DescribeAccountSubscriptionOutput, error)
- func (c *Client) DescribeActionConnector(ctx context.Context, params *DescribeActionConnectorInput, ...) (*DescribeActionConnectorOutput, error)
- func (c *Client) DescribeActionConnectorPermissions(ctx context.Context, params *DescribeActionConnectorPermissionsInput, ...) (*DescribeActionConnectorPermissionsOutput, error)
- func (c *Client) DescribeAgent(ctx context.Context, params *DescribeAgentInput, optFns ...func(*Options)) (*DescribeAgentOutput, error)
- func (c *Client) DescribeAgentPermissions(ctx context.Context, params *DescribeAgentPermissionsInput, ...) (*DescribeAgentPermissionsOutput, error)
- func (c *Client) DescribeAnalysis(ctx context.Context, params *DescribeAnalysisInput, optFns ...func(*Options)) (*DescribeAnalysisOutput, error)
- func (c *Client) DescribeAnalysisDefinition(ctx context.Context, params *DescribeAnalysisDefinitionInput, ...) (*DescribeAnalysisDefinitionOutput, error)
- func (c *Client) DescribeAnalysisPermissions(ctx context.Context, params *DescribeAnalysisPermissionsInput, ...) (*DescribeAnalysisPermissionsOutput, error)
- func (c *Client) DescribeApp(ctx context.Context, params *DescribeAppInput, optFns ...func(*Options)) (*DescribeAppOutput, error)
- func (c *Client) DescribeAppPermissions(ctx context.Context, params *DescribeAppPermissionsInput, ...) (*DescribeAppPermissionsOutput, error)
- func (c *Client) DescribeApprovalPolicy(ctx context.Context, params *DescribeApprovalPolicyInput, ...) (*DescribeApprovalPolicyOutput, error)
- func (c *Client) DescribeAssetBundleExportJob(ctx context.Context, params *DescribeAssetBundleExportJobInput, ...) (*DescribeAssetBundleExportJobOutput, error)
- func (c *Client) DescribeAssetBundleImportJob(ctx context.Context, params *DescribeAssetBundleImportJobInput, ...) (*DescribeAssetBundleImportJobOutput, error)
- func (c *Client) DescribeAutomationJob(ctx context.Context, params *DescribeAutomationJobInput, ...) (*DescribeAutomationJobOutput, error)
- func (c *Client) DescribeBrand(ctx context.Context, params *DescribeBrandInput, optFns ...func(*Options)) (*DescribeBrandOutput, error)
- func (c *Client) DescribeBrandAssignment(ctx context.Context, params *DescribeBrandAssignmentInput, ...) (*DescribeBrandAssignmentOutput, error)
- func (c *Client) DescribeBrandPublishedVersion(ctx context.Context, params *DescribeBrandPublishedVersionInput, ...) (*DescribeBrandPublishedVersionOutput, error)
- func (c *Client) DescribeCustomPermissions(ctx context.Context, params *DescribeCustomPermissionsInput, ...) (*DescribeCustomPermissionsOutput, error)
- func (c *Client) DescribeDashboard(ctx context.Context, params *DescribeDashboardInput, optFns ...func(*Options)) (*DescribeDashboardOutput, error)
- func (c *Client) DescribeDashboardDefinition(ctx context.Context, params *DescribeDashboardDefinitionInput, ...) (*DescribeDashboardDefinitionOutput, error)
- func (c *Client) DescribeDashboardPermissions(ctx context.Context, params *DescribeDashboardPermissionsInput, ...) (*DescribeDashboardPermissionsOutput, error)
- func (c *Client) DescribeDashboardSnapshotJob(ctx context.Context, params *DescribeDashboardSnapshotJobInput, ...) (*DescribeDashboardSnapshotJobOutput, error)
- func (c *Client) DescribeDashboardSnapshotJobResult(ctx context.Context, params *DescribeDashboardSnapshotJobResultInput, ...) (*DescribeDashboardSnapshotJobResultOutput, error)
- func (c *Client) DescribeDashboardsQAConfiguration(ctx context.Context, params *DescribeDashboardsQAConfigurationInput, ...) (*DescribeDashboardsQAConfigurationOutput, error)
- func (c *Client) DescribeDataSet(ctx context.Context, params *DescribeDataSetInput, optFns ...func(*Options)) (*DescribeDataSetOutput, error)
- func (c *Client) DescribeDataSetPermissions(ctx context.Context, params *DescribeDataSetPermissionsInput, ...) (*DescribeDataSetPermissionsOutput, error)
- func (c *Client) DescribeDataSetRefreshProperties(ctx context.Context, params *DescribeDataSetRefreshPropertiesInput, ...) (*DescribeDataSetRefreshPropertiesOutput, error)
- func (c *Client) DescribeDataSource(ctx context.Context, params *DescribeDataSourceInput, optFns ...func(*Options)) (*DescribeDataSourceOutput, error)
- func (c *Client) DescribeDataSourcePermissions(ctx context.Context, params *DescribeDataSourcePermissionsInput, ...) (*DescribeDataSourcePermissionsOutput, error)
- func (c *Client) DescribeDefaultQBusinessApplication(ctx context.Context, params *DescribeDefaultQBusinessApplicationInput, ...) (*DescribeDefaultQBusinessApplicationOutput, error)
- func (c *Client) DescribeDlpSetting(ctx context.Context, params *DescribeDlpSettingInput, optFns ...func(*Options)) (*DescribeDlpSettingOutput, error)
- func (c *Client) DescribeFlow(ctx context.Context, params *DescribeFlowInput, optFns ...func(*Options)) (*DescribeFlowOutput, error)
- func (c *Client) DescribeFolder(ctx context.Context, params *DescribeFolderInput, optFns ...func(*Options)) (*DescribeFolderOutput, error)
- func (c *Client) DescribeFolderPermissions(ctx context.Context, params *DescribeFolderPermissionsInput, ...) (*DescribeFolderPermissionsOutput, error)
- func (c *Client) DescribeFolderResolvedPermissions(ctx context.Context, params *DescribeFolderResolvedPermissionsInput, ...) (*DescribeFolderResolvedPermissionsOutput, error)
- func (c *Client) DescribeGroup(ctx context.Context, params *DescribeGroupInput, optFns ...func(*Options)) (*DescribeGroupOutput, error)
- func (c *Client) DescribeGroupMembership(ctx context.Context, params *DescribeGroupMembershipInput, ...) (*DescribeGroupMembershipOutput, error)
- func (c *Client) DescribeIAMPolicyAssignment(ctx context.Context, params *DescribeIAMPolicyAssignmentInput, ...) (*DescribeIAMPolicyAssignmentOutput, error)
- func (c *Client) DescribeIngestion(ctx context.Context, params *DescribeIngestionInput, optFns ...func(*Options)) (*DescribeIngestionOutput, error)
- func (c *Client) DescribeIpRestriction(ctx context.Context, params *DescribeIpRestrictionInput, ...) (*DescribeIpRestrictionOutput, error)
- func (c *Client) DescribeKeyRegistration(ctx context.Context, params *DescribeKeyRegistrationInput, ...) (*DescribeKeyRegistrationOutput, error)
- func (c *Client) DescribeKnowledgeBase(ctx context.Context, params *DescribeKnowledgeBaseInput, ...) (*DescribeKnowledgeBaseOutput, error)
- func (c *Client) DescribeKnowledgeBasePermissions(ctx context.Context, params *DescribeKnowledgeBasePermissionsInput, ...) (*DescribeKnowledgeBasePermissionsOutput, error)
- func (c *Client) DescribeLimitsProfile(ctx context.Context, params *DescribeLimitsProfileInput, ...) (*DescribeLimitsProfileOutput, error)
- func (c *Client) DescribeNamespace(ctx context.Context, params *DescribeNamespaceInput, optFns ...func(*Options)) (*DescribeNamespaceOutput, error)
- func (c *Client) DescribeOAuthClientApplication(ctx context.Context, params *DescribeOAuthClientApplicationInput, ...) (*DescribeOAuthClientApplicationOutput, error)
- func (c *Client) DescribeQPersonalizationConfiguration(ctx context.Context, params *DescribeQPersonalizationConfigurationInput, ...) (*DescribeQPersonalizationConfigurationOutput, error)
- func (c *Client) DescribeQuickSightQSearchConfiguration(ctx context.Context, params *DescribeQuickSightQSearchConfigurationInput, ...) (*DescribeQuickSightQSearchConfigurationOutput, error)
- func (c *Client) DescribeRefreshSchedule(ctx context.Context, params *DescribeRefreshScheduleInput, ...) (*DescribeRefreshScheduleOutput, error)
- func (c *Client) DescribeResourcePermissions(ctx context.Context, params *DescribeResourcePermissionsInput, ...) (*DescribeResourcePermissionsOutput, error)
- func (c *Client) DescribeRoleCustomPermission(ctx context.Context, params *DescribeRoleCustomPermissionInput, ...) (*DescribeRoleCustomPermissionOutput, error)
- func (c *Client) DescribeSelfUpgradeConfiguration(ctx context.Context, params *DescribeSelfUpgradeConfigurationInput, ...) (*DescribeSelfUpgradeConfigurationOutput, error)
- func (c *Client) DescribeSpace(ctx context.Context, params *DescribeSpaceInput, optFns ...func(*Options)) (*DescribeSpaceOutput, error)
- func (c *Client) DescribeSpacePermissions(ctx context.Context, params *DescribeSpacePermissionsInput, ...) (*DescribeSpacePermissionsOutput, error)
- func (c *Client) DescribeTemplate(ctx context.Context, params *DescribeTemplateInput, optFns ...func(*Options)) (*DescribeTemplateOutput, error)
- func (c *Client) DescribeTemplateAlias(ctx context.Context, params *DescribeTemplateAliasInput, ...) (*DescribeTemplateAliasOutput, error)
- func (c *Client) DescribeTemplateDefinition(ctx context.Context, params *DescribeTemplateDefinitionInput, ...) (*DescribeTemplateDefinitionOutput, error)
- func (c *Client) DescribeTemplatePermissions(ctx context.Context, params *DescribeTemplatePermissionsInput, ...) (*DescribeTemplatePermissionsOutput, error)
- func (c *Client) DescribeTheme(ctx context.Context, params *DescribeThemeInput, optFns ...func(*Options)) (*DescribeThemeOutput, error)
- func (c *Client) DescribeThemeAlias(ctx context.Context, params *DescribeThemeAliasInput, optFns ...func(*Options)) (*DescribeThemeAliasOutput, error)
- func (c *Client) DescribeThemePermissions(ctx context.Context, params *DescribeThemePermissionsInput, ...) (*DescribeThemePermissionsOutput, error)
- func (c *Client) DescribeTopic(ctx context.Context, params *DescribeTopicInput, optFns ...func(*Options)) (*DescribeTopicOutput, error)
- func (c *Client) DescribeTopicPermissions(ctx context.Context, params *DescribeTopicPermissionsInput, ...) (*DescribeTopicPermissionsOutput, error)
- func (c *Client) DescribeTopicPermissionsV2(ctx context.Context, params *DescribeTopicPermissionsV2Input, ...) (*DescribeTopicPermissionsV2Output, error)
- func (c *Client) DescribeTopicRefresh(ctx context.Context, params *DescribeTopicRefreshInput, ...) (*DescribeTopicRefreshOutput, error)
- func (c *Client) DescribeTopicRefreshSchedule(ctx context.Context, params *DescribeTopicRefreshScheduleInput, ...) (*DescribeTopicRefreshScheduleOutput, error)
- func (c *Client) DescribeTopicV2(ctx context.Context, params *DescribeTopicV2Input, optFns ...func(*Options)) (*DescribeTopicV2Output, error)
- func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, optFns ...func(*Options)) (*DescribeUserOutput, error)
- func (c *Client) DescribeVPCConnection(ctx context.Context, params *DescribeVPCConnectionInput, ...) (*DescribeVPCConnectionOutput, error)
- func (c *Client) GenerateEmbedUrlForAnonymousUser(ctx context.Context, params *GenerateEmbedUrlForAnonymousUserInput, ...) (*GenerateEmbedUrlForAnonymousUserOutput, error)
- func (c *Client) GenerateEmbedUrlForRegisteredUser(ctx context.Context, params *GenerateEmbedUrlForRegisteredUserInput, ...) (*GenerateEmbedUrlForRegisteredUserOutput, error)
- func (c *Client) GenerateEmbedUrlForRegisteredUserWithIdentity(ctx context.Context, ...) (*GenerateEmbedUrlForRegisteredUserWithIdentityOutput, error)
- func (c *Client) GetDashboardEmbedUrl(ctx context.Context, params *GetDashboardEmbedUrlInput, ...) (*GetDashboardEmbedUrlOutput, error)
- func (c *Client) GetFlowMetadata(ctx context.Context, params *GetFlowMetadataInput, optFns ...func(*Options)) (*GetFlowMetadataOutput, error)
- func (c *Client) GetFlowPermissions(ctx context.Context, params *GetFlowPermissionsInput, optFns ...func(*Options)) (*GetFlowPermissionsOutput, error)
- func (c *Client) GetIdentityContext(ctx context.Context, params *GetIdentityContextInput, optFns ...func(*Options)) (*GetIdentityContextOutput, error)
- func (c *Client) GetSessionEmbedUrl(ctx context.Context, params *GetSessionEmbedUrlInput, optFns ...func(*Options)) (*GetSessionEmbedUrlOutput, error)
- func (c *Client) ListActionConnectors(ctx context.Context, params *ListActionConnectorsInput, ...) (*ListActionConnectorsOutput, error)
- func (c *Client) ListAgents(ctx context.Context, params *ListAgentsInput, optFns ...func(*Options)) (*ListAgentsOutput, error)
- func (c *Client) ListAnalyses(ctx context.Context, params *ListAnalysesInput, optFns ...func(*Options)) (*ListAnalysesOutput, error)
- func (c *Client) ListApprovalPolicies(ctx context.Context, params *ListApprovalPoliciesInput, ...) (*ListApprovalPoliciesOutput, error)
- func (c *Client) ListApps(ctx context.Context, params *ListAppsInput, optFns ...func(*Options)) (*ListAppsOutput, error)
- func (c *Client) ListAssetBundleExportJobs(ctx context.Context, params *ListAssetBundleExportJobsInput, ...) (*ListAssetBundleExportJobsOutput, error)
- func (c *Client) ListAssetBundleImportJobs(ctx context.Context, params *ListAssetBundleImportJobsInput, ...) (*ListAssetBundleImportJobsOutput, error)
- func (c *Client) ListBrands(ctx context.Context, params *ListBrandsInput, optFns ...func(*Options)) (*ListBrandsOutput, error)
- func (c *Client) ListCustomPermissions(ctx context.Context, params *ListCustomPermissionsInput, ...) (*ListCustomPermissionsOutput, error)
- func (c *Client) ListDashboardVersions(ctx context.Context, params *ListDashboardVersionsInput, ...) (*ListDashboardVersionsOutput, error)
- func (c *Client) ListDashboards(ctx context.Context, params *ListDashboardsInput, optFns ...func(*Options)) (*ListDashboardsOutput, error)
- func (c *Client) ListDataSets(ctx context.Context, params *ListDataSetsInput, optFns ...func(*Options)) (*ListDataSetsOutput, error)
- func (c *Client) ListDataSources(ctx context.Context, params *ListDataSourcesInput, optFns ...func(*Options)) (*ListDataSourcesOutput, error)
- func (c *Client) ListDlpSettings(ctx context.Context, params *ListDlpSettingsInput, optFns ...func(*Options)) (*ListDlpSettingsOutput, error)
- func (c *Client) ListFlows(ctx context.Context, params *ListFlowsInput, optFns ...func(*Options)) (*ListFlowsOutput, error)
- func (c *Client) ListFolderMembers(ctx context.Context, params *ListFolderMembersInput, optFns ...func(*Options)) (*ListFolderMembersOutput, error)
- func (c *Client) ListFolders(ctx context.Context, params *ListFoldersInput, optFns ...func(*Options)) (*ListFoldersOutput, error)
- func (c *Client) ListFoldersForResource(ctx context.Context, params *ListFoldersForResourceInput, ...) (*ListFoldersForResourceOutput, error)
- func (c *Client) ListGroupMemberships(ctx context.Context, params *ListGroupMembershipsInput, ...) (*ListGroupMembershipsOutput, error)
- func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error)
- func (c *Client) ListIAMPolicyAssignments(ctx context.Context, params *ListIAMPolicyAssignmentsInput, ...) (*ListIAMPolicyAssignmentsOutput, error)
- func (c *Client) ListIAMPolicyAssignmentsForUser(ctx context.Context, params *ListIAMPolicyAssignmentsForUserInput, ...) (*ListIAMPolicyAssignmentsForUserOutput, error)
- func (c *Client) ListIdentityPropagationConfigs(ctx context.Context, params *ListIdentityPropagationConfigsInput, ...) (*ListIdentityPropagationConfigsOutput, error)
- func (c *Client) ListIngestions(ctx context.Context, params *ListIngestionsInput, optFns ...func(*Options)) (*ListIngestionsOutput, error)
- func (c *Client) ListKnowledgeBases(ctx context.Context, params *ListKnowledgeBasesInput, optFns ...func(*Options)) (*ListKnowledgeBasesOutput, error)
- func (c *Client) ListLimitsProfiles(ctx context.Context, params *ListLimitsProfilesInput, optFns ...func(*Options)) (*ListLimitsProfilesOutput, error)
- func (c *Client) ListNamespaces(ctx context.Context, params *ListNamespacesInput, optFns ...func(*Options)) (*ListNamespacesOutput, error)
- func (c *Client) ListOAuthClientApplications(ctx context.Context, params *ListOAuthClientApplicationsInput, ...) (*ListOAuthClientApplicationsOutput, error)
- func (c *Client) ListRefreshSchedules(ctx context.Context, params *ListRefreshSchedulesInput, ...) (*ListRefreshSchedulesOutput, error)
- func (c *Client) ListRoleMemberships(ctx context.Context, params *ListRoleMembershipsInput, ...) (*ListRoleMembershipsOutput, error)
- func (c *Client) ListSelfUpgrades(ctx context.Context, params *ListSelfUpgradesInput, optFns ...func(*Options)) (*ListSelfUpgradesOutput, error)
- func (c *Client) ListSpaceResources(ctx context.Context, params *ListSpaceResourcesInput, optFns ...func(*Options)) (*ListSpaceResourcesOutput, error)
- func (c *Client) ListSpaces(ctx context.Context, params *ListSpacesInput, optFns ...func(*Options)) (*ListSpacesOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*ListTagsForResourceOutput, error)
- func (c *Client) ListTemplateAliases(ctx context.Context, params *ListTemplateAliasesInput, ...) (*ListTemplateAliasesOutput, error)
- func (c *Client) ListTemplateVersions(ctx context.Context, params *ListTemplateVersionsInput, ...) (*ListTemplateVersionsOutput, error)
- func (c *Client) ListTemplates(ctx context.Context, params *ListTemplatesInput, optFns ...func(*Options)) (*ListTemplatesOutput, error)
- func (c *Client) ListThemeAliases(ctx context.Context, params *ListThemeAliasesInput, optFns ...func(*Options)) (*ListThemeAliasesOutput, error)
- func (c *Client) ListThemeVersions(ctx context.Context, params *ListThemeVersionsInput, optFns ...func(*Options)) (*ListThemeVersionsOutput, error)
- func (c *Client) ListThemes(ctx context.Context, params *ListThemesInput, optFns ...func(*Options)) (*ListThemesOutput, error)
- func (c *Client) ListTopicRefreshSchedules(ctx context.Context, params *ListTopicRefreshSchedulesInput, ...) (*ListTopicRefreshSchedulesOutput, error)
- func (c *Client) ListTopicReviewedAnswers(ctx context.Context, params *ListTopicReviewedAnswersInput, ...) (*ListTopicReviewedAnswersOutput, error)
- func (c *Client) ListTopics(ctx context.Context, params *ListTopicsInput, optFns ...func(*Options)) (*ListTopicsOutput, error)
- func (c *Client) ListTopicsV2(ctx context.Context, params *ListTopicsV2Input, optFns ...func(*Options)) (*ListTopicsV2Output, error)
- func (c *Client) ListUserGroups(ctx context.Context, params *ListUserGroupsInput, optFns ...func(*Options)) (*ListUserGroupsOutput, error)
- func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error)
- func (c *Client) ListUsersIndexCapacity(ctx context.Context, params *ListUsersIndexCapacityInput, ...) (*ListUsersIndexCapacityOutput, error)
- func (c *Client) ListVPCConnections(ctx context.Context, params *ListVPCConnectionsInput, optFns ...func(*Options)) (*ListVPCConnectionsOutput, error)
- func (c *Client) Options() Options
- func (c *Client) PredictQAResults(ctx context.Context, params *PredictQAResultsInput, optFns ...func(*Options)) (*PredictQAResultsOutput, error)
- func (c *Client) PutDataSetRefreshProperties(ctx context.Context, params *PutDataSetRefreshPropertiesInput, ...) (*PutDataSetRefreshPropertiesOutput, error)
- func (c *Client) RegisterUser(ctx context.Context, params *RegisterUserInput, optFns ...func(*Options)) (*RegisterUserOutput, error)
- func (c *Client) RestoreAnalysis(ctx context.Context, params *RestoreAnalysisInput, optFns ...func(*Options)) (*RestoreAnalysisOutput, error)
- func (c *Client) SearchActionConnectors(ctx context.Context, params *SearchActionConnectorsInput, ...) (*SearchActionConnectorsOutput, error)
- func (c *Client) SearchAgents(ctx context.Context, params *SearchAgentsInput, optFns ...func(*Options)) (*SearchAgentsOutput, error)
- func (c *Client) SearchAnalyses(ctx context.Context, params *SearchAnalysesInput, optFns ...func(*Options)) (*SearchAnalysesOutput, error)
- func (c *Client) SearchApps(ctx context.Context, params *SearchAppsInput, optFns ...func(*Options)) (*SearchAppsOutput, error)
- func (c *Client) SearchDashboards(ctx context.Context, params *SearchDashboardsInput, optFns ...func(*Options)) (*SearchDashboardsOutput, error)
- func (c *Client) SearchDataSets(ctx context.Context, params *SearchDataSetsInput, optFns ...func(*Options)) (*SearchDataSetsOutput, error)
- func (c *Client) SearchDataSources(ctx context.Context, params *SearchDataSourcesInput, optFns ...func(*Options)) (*SearchDataSourcesOutput, error)
- func (c *Client) SearchFlows(ctx context.Context, params *SearchFlowsInput, optFns ...func(*Options)) (*SearchFlowsOutput, error)
- func (c *Client) SearchFolders(ctx context.Context, params *SearchFoldersInput, optFns ...func(*Options)) (*SearchFoldersOutput, error)
- func (c *Client) SearchGroups(ctx context.Context, params *SearchGroupsInput, optFns ...func(*Options)) (*SearchGroupsOutput, error)
- func (c *Client) SearchKnowledgeBases(ctx context.Context, params *SearchKnowledgeBasesInput, ...) (*SearchKnowledgeBasesOutput, error)
- func (c *Client) SearchSpaces(ctx context.Context, params *SearchSpacesInput, optFns ...func(*Options)) (*SearchSpacesOutput, error)
- func (c *Client) SearchTopics(ctx context.Context, params *SearchTopicsInput, optFns ...func(*Options)) (*SearchTopicsOutput, error)
- func (c *Client) SearchTopicsV2(ctx context.Context, params *SearchTopicsV2Input, optFns ...func(*Options)) (*SearchTopicsV2Output, error)
- func (c *Client) StartAssetBundleExportJob(ctx context.Context, params *StartAssetBundleExportJobInput, ...) (*StartAssetBundleExportJobOutput, error)
- func (c *Client) StartAssetBundleImportJob(ctx context.Context, params *StartAssetBundleImportJobInput, ...) (*StartAssetBundleImportJobOutput, error)
- func (c *Client) StartAutomationJob(ctx context.Context, params *StartAutomationJobInput, optFns ...func(*Options)) (*StartAutomationJobOutput, error)
- func (c *Client) StartDashboardSnapshotJob(ctx context.Context, params *StartDashboardSnapshotJobInput, ...) (*StartDashboardSnapshotJobOutput, error)
- func (c *Client) StartDashboardSnapshotJobSchedule(ctx context.Context, params *StartDashboardSnapshotJobScheduleInput, ...) (*StartDashboardSnapshotJobScheduleOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateAccountCustomPermission(ctx context.Context, params *UpdateAccountCustomPermissionInput, ...) (*UpdateAccountCustomPermissionOutput, error)
- func (c *Client) UpdateAccountCustomization(ctx context.Context, params *UpdateAccountCustomizationInput, ...) (*UpdateAccountCustomizationOutput, error)
- func (c *Client) UpdateAccountSettings(ctx context.Context, params *UpdateAccountSettingsInput, ...) (*UpdateAccountSettingsOutput, error)
- func (c *Client) UpdateActionConnector(ctx context.Context, params *UpdateActionConnectorInput, ...) (*UpdateActionConnectorOutput, error)
- func (c *Client) UpdateActionConnectorPermissions(ctx context.Context, params *UpdateActionConnectorPermissionsInput, ...) (*UpdateActionConnectorPermissionsOutput, error)
- func (c *Client) UpdateAgent(ctx context.Context, params *UpdateAgentInput, optFns ...func(*Options)) (*UpdateAgentOutput, error)
- func (c *Client) UpdateAgentPermissions(ctx context.Context, params *UpdateAgentPermissionsInput, ...) (*UpdateAgentPermissionsOutput, error)
- func (c *Client) UpdateAnalysis(ctx context.Context, params *UpdateAnalysisInput, optFns ...func(*Options)) (*UpdateAnalysisOutput, error)
- func (c *Client) UpdateAnalysisPermissions(ctx context.Context, params *UpdateAnalysisPermissionsInput, ...) (*UpdateAnalysisPermissionsOutput, error)
- func (c *Client) UpdateAppPermissions(ctx context.Context, params *UpdateAppPermissionsInput, ...) (*UpdateAppPermissionsOutput, error)
- func (c *Client) UpdateApplicationWithTokenExchangeGrant(ctx context.Context, params *UpdateApplicationWithTokenExchangeGrantInput, ...) (*UpdateApplicationWithTokenExchangeGrantOutput, error)
- func (c *Client) UpdateApprovalPolicy(ctx context.Context, params *UpdateApprovalPolicyInput, ...) (*UpdateApprovalPolicyOutput, error)
- func (c *Client) UpdateBrand(ctx context.Context, params *UpdateBrandInput, optFns ...func(*Options)) (*UpdateBrandOutput, error)
- func (c *Client) UpdateBrandAssignment(ctx context.Context, params *UpdateBrandAssignmentInput, ...) (*UpdateBrandAssignmentOutput, error)
- func (c *Client) UpdateBrandPublishedVersion(ctx context.Context, params *UpdateBrandPublishedVersionInput, ...) (*UpdateBrandPublishedVersionOutput, error)
- func (c *Client) UpdateCustomPermissions(ctx context.Context, params *UpdateCustomPermissionsInput, ...) (*UpdateCustomPermissionsOutput, error)
- func (c *Client) UpdateDashboard(ctx context.Context, params *UpdateDashboardInput, optFns ...func(*Options)) (*UpdateDashboardOutput, error)
- func (c *Client) UpdateDashboardLinks(ctx context.Context, params *UpdateDashboardLinksInput, ...) (*UpdateDashboardLinksOutput, error)
- func (c *Client) UpdateDashboardPermissions(ctx context.Context, params *UpdateDashboardPermissionsInput, ...) (*UpdateDashboardPermissionsOutput, error)
- func (c *Client) UpdateDashboardPublishedVersion(ctx context.Context, params *UpdateDashboardPublishedVersionInput, ...) (*UpdateDashboardPublishedVersionOutput, error)
- func (c *Client) UpdateDashboardsQAConfiguration(ctx context.Context, params *UpdateDashboardsQAConfigurationInput, ...) (*UpdateDashboardsQAConfigurationOutput, error)
- func (c *Client) UpdateDataSet(ctx context.Context, params *UpdateDataSetInput, optFns ...func(*Options)) (*UpdateDataSetOutput, error)
- func (c *Client) UpdateDataSetPermissions(ctx context.Context, params *UpdateDataSetPermissionsInput, ...) (*UpdateDataSetPermissionsOutput, error)
- func (c *Client) UpdateDataSource(ctx context.Context, params *UpdateDataSourceInput, optFns ...func(*Options)) (*UpdateDataSourceOutput, error)
- func (c *Client) UpdateDataSourcePermissions(ctx context.Context, params *UpdateDataSourcePermissionsInput, ...) (*UpdateDataSourcePermissionsOutput, error)
- func (c *Client) UpdateDefaultQBusinessApplication(ctx context.Context, params *UpdateDefaultQBusinessApplicationInput, ...) (*UpdateDefaultQBusinessApplicationOutput, error)
- func (c *Client) UpdateDlpSetting(ctx context.Context, params *UpdateDlpSettingInput, optFns ...func(*Options)) (*UpdateDlpSettingOutput, error)
- func (c *Client) UpdateFlow(ctx context.Context, params *UpdateFlowInput, optFns ...func(*Options)) (*UpdateFlowOutput, error)
- func (c *Client) UpdateFlowPermissions(ctx context.Context, params *UpdateFlowPermissionsInput, ...) (*UpdateFlowPermissionsOutput, error)
- func (c *Client) UpdateFolder(ctx context.Context, params *UpdateFolderInput, optFns ...func(*Options)) (*UpdateFolderOutput, error)
- func (c *Client) UpdateFolderPermissions(ctx context.Context, params *UpdateFolderPermissionsInput, ...) (*UpdateFolderPermissionsOutput, error)
- func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error)
- func (c *Client) UpdateIAMPolicyAssignment(ctx context.Context, params *UpdateIAMPolicyAssignmentInput, ...) (*UpdateIAMPolicyAssignmentOutput, error)
- func (c *Client) UpdateIdentityPropagationConfig(ctx context.Context, params *UpdateIdentityPropagationConfigInput, ...) (*UpdateIdentityPropagationConfigOutput, error)
- func (c *Client) UpdateIpRestriction(ctx context.Context, params *UpdateIpRestrictionInput, ...) (*UpdateIpRestrictionOutput, error)
- func (c *Client) UpdateKeyRegistration(ctx context.Context, params *UpdateKeyRegistrationInput, ...) (*UpdateKeyRegistrationOutput, error)
- func (c *Client) UpdateKnowledgeBase(ctx context.Context, params *UpdateKnowledgeBaseInput, ...) (*UpdateKnowledgeBaseOutput, error)
- func (c *Client) UpdateKnowledgeBasePermissions(ctx context.Context, params *UpdateKnowledgeBasePermissionsInput, ...) (*UpdateKnowledgeBasePermissionsOutput, error)
- func (c *Client) UpdateLimitsProfile(ctx context.Context, params *UpdateLimitsProfileInput, ...) (*UpdateLimitsProfileOutput, error)
- func (c *Client) UpdateOAuthClientApplication(ctx context.Context, params *UpdateOAuthClientApplicationInput, ...) (*UpdateOAuthClientApplicationOutput, error)
- func (c *Client) UpdatePublicSharingSettings(ctx context.Context, params *UpdatePublicSharingSettingsInput, ...) (*UpdatePublicSharingSettingsOutput, error)
- func (c *Client) UpdateQPersonalizationConfiguration(ctx context.Context, params *UpdateQPersonalizationConfigurationInput, ...) (*UpdateQPersonalizationConfigurationOutput, error)
- func (c *Client) UpdateQuickSightQSearchConfiguration(ctx context.Context, params *UpdateQuickSightQSearchConfigurationInput, ...) (*UpdateQuickSightQSearchConfigurationOutput, error)
- func (c *Client) UpdateRefreshSchedule(ctx context.Context, params *UpdateRefreshScheduleInput, ...) (*UpdateRefreshScheduleOutput, error)
- func (c *Client) UpdateResourcePermissions(ctx context.Context, params *UpdateResourcePermissionsInput, ...) (*UpdateResourcePermissionsOutput, error)
- func (c *Client) UpdateRoleCustomPermission(ctx context.Context, params *UpdateRoleCustomPermissionInput, ...) (*UpdateRoleCustomPermissionOutput, error)
- func (c *Client) UpdateSPICECapacityConfiguration(ctx context.Context, params *UpdateSPICECapacityConfigurationInput, ...) (*UpdateSPICECapacityConfigurationOutput, error)
- func (c *Client) UpdateSelfUpgrade(ctx context.Context, params *UpdateSelfUpgradeInput, optFns ...func(*Options)) (*UpdateSelfUpgradeOutput, error)
- func (c *Client) UpdateSelfUpgradeConfiguration(ctx context.Context, params *UpdateSelfUpgradeConfigurationInput, ...) (*UpdateSelfUpgradeConfigurationOutput, error)
- func (c *Client) UpdateSpace(ctx context.Context, params *UpdateSpaceInput, optFns ...func(*Options)) (*UpdateSpaceOutput, error)
- func (c *Client) UpdateSpacePermissions(ctx context.Context, params *UpdateSpacePermissionsInput, ...) (*UpdateSpacePermissionsOutput, error)
- func (c *Client) UpdateSpaceResources(ctx context.Context, params *UpdateSpaceResourcesInput, ...) (*UpdateSpaceResourcesOutput, error)
- func (c *Client) UpdateTemplate(ctx context.Context, params *UpdateTemplateInput, optFns ...func(*Options)) (*UpdateTemplateOutput, error)
- func (c *Client) UpdateTemplateAlias(ctx context.Context, params *UpdateTemplateAliasInput, ...) (*UpdateTemplateAliasOutput, error)
- func (c *Client) UpdateTemplatePermissions(ctx context.Context, params *UpdateTemplatePermissionsInput, ...) (*UpdateTemplatePermissionsOutput, error)
- func (c *Client) UpdateTheme(ctx context.Context, params *UpdateThemeInput, optFns ...func(*Options)) (*UpdateThemeOutput, error)
- func (c *Client) UpdateThemeAlias(ctx context.Context, params *UpdateThemeAliasInput, optFns ...func(*Options)) (*UpdateThemeAliasOutput, error)
- func (c *Client) UpdateThemePermissions(ctx context.Context, params *UpdateThemePermissionsInput, ...) (*UpdateThemePermissionsOutput, error)
- func (c *Client) UpdateTopic(ctx context.Context, params *UpdateTopicInput, optFns ...func(*Options)) (*UpdateTopicOutput, error)
- func (c *Client) UpdateTopicPermissions(ctx context.Context, params *UpdateTopicPermissionsInput, ...) (*UpdateTopicPermissionsOutput, error)
- func (c *Client) UpdateTopicPermissionsV2(ctx context.Context, params *UpdateTopicPermissionsV2Input, ...) (*UpdateTopicPermissionsV2Output, error)
- func (c *Client) UpdateTopicRefreshSchedule(ctx context.Context, params *UpdateTopicRefreshScheduleInput, ...) (*UpdateTopicRefreshScheduleOutput, error)
- func (c *Client) UpdateTopicV2(ctx context.Context, params *UpdateTopicV2Input, optFns ...func(*Options)) (*UpdateTopicV2Output, error)
- func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error)
- func (c *Client) UpdateUserCustomPermission(ctx context.Context, params *UpdateUserCustomPermissionInput, ...) (*UpdateUserCustomPermissionOutput, error)
- func (c *Client) UpdateVPCConnection(ctx context.Context, params *UpdateVPCConnectionInput, ...) (*UpdateVPCConnectionOutput, error)
- type CreateAccountCustomizationInput
- type CreateAccountCustomizationOutput
- type CreateAccountSubscriptionInput
- type CreateAccountSubscriptionOutput
- type CreateActionConnectorInput
- type CreateActionConnectorOutput
- type CreateAgentInput
- type CreateAgentOutput
- type CreateAnalysisInput
- type CreateAnalysisOutput
- type CreateApprovalPolicyInput
- type CreateApprovalPolicyOutput
- type CreateBrandInput
- type CreateBrandOutput
- type CreateCustomPermissionsInput
- type CreateCustomPermissionsOutput
- type CreateDashboardInput
- type CreateDashboardOutput
- type CreateDataSetInput
- type CreateDataSetOutput
- type CreateDataSourceInput
- type CreateDataSourceOutput
- type CreateDlpSettingInput
- type CreateDlpSettingOutput
- type CreateFlowInput
- type CreateFlowOutput
- type CreateFolderInput
- type CreateFolderMembershipInput
- type CreateFolderMembershipOutput
- type CreateFolderOutput
- type CreateGroupInput
- type CreateGroupMembershipInput
- type CreateGroupMembershipOutput
- type CreateGroupOutput
- type CreateIAMPolicyAssignmentInput
- type CreateIAMPolicyAssignmentOutput
- type CreateIngestionInput
- type CreateIngestionOutput
- type CreateKnowledgeBaseInput
- type CreateKnowledgeBaseOutput
- type CreateLimitsProfileInput
- type CreateLimitsProfileOutput
- type CreateNamespaceInput
- type CreateNamespaceOutput
- type CreateOAuthClientApplicationInput
- type CreateOAuthClientApplicationOutput
- type CreateRefreshScheduleInput
- type CreateRefreshScheduleOutput
- type CreateRoleMembershipInput
- type CreateRoleMembershipOutput
- type CreateSpaceInput
- type CreateSpaceOutput
- type CreateTemplateAliasInput
- type CreateTemplateAliasOutput
- type CreateTemplateInput
- type CreateTemplateOutput
- type CreateThemeAliasInput
- type CreateThemeAliasOutput
- type CreateThemeInput
- type CreateThemeOutput
- type CreateTopicInput
- type CreateTopicOutput
- type CreateTopicRefreshScheduleInput
- type CreateTopicRefreshScheduleOutput
- type CreateTopicV2Input
- type CreateTopicV2Output
- type CreateVPCConnectionInput
- type CreateVPCConnectionOutput
- type DeleteAccountCustomPermissionInput
- type DeleteAccountCustomPermissionOutput
- type DeleteAccountCustomizationInput
- type DeleteAccountCustomizationOutput
- type DeleteAccountSubscriptionInput
- type DeleteAccountSubscriptionOutput
- type DeleteActionConnectorInput
- type DeleteActionConnectorOutput
- type DeleteAgentInput
- type DeleteAgentOutput
- type DeleteAnalysisInput
- type DeleteAnalysisOutput
- type DeleteAppInput
- type DeleteAppOutput
- type DeleteApprovalPolicyInput
- type DeleteApprovalPolicyOutput
- type DeleteBrandAssignmentInput
- type DeleteBrandAssignmentOutput
- type DeleteBrandInput
- type DeleteBrandOutput
- type DeleteCustomPermissionsInput
- type DeleteCustomPermissionsOutput
- type DeleteDashboardInput
- type DeleteDashboardOutput
- type DeleteDataSetInput
- type DeleteDataSetOutput
- type DeleteDataSetRefreshPropertiesInput
- type DeleteDataSetRefreshPropertiesOutput
- type DeleteDataSourceInput
- type DeleteDataSourceOutput
- type DeleteDefaultQBusinessApplicationInput
- type DeleteDefaultQBusinessApplicationOutput
- type DeleteDlpSettingInput
- type DeleteDlpSettingOutput
- type DeleteFlowInput
- type DeleteFlowOutput
- type DeleteFolderInput
- type DeleteFolderMembershipInput
- type DeleteFolderMembershipOutput
- type DeleteFolderOutput
- type DeleteGroupInput
- type DeleteGroupMembershipInput
- type DeleteGroupMembershipOutput
- type DeleteGroupOutput
- type DeleteIAMPolicyAssignmentInput
- type DeleteIAMPolicyAssignmentOutput
- type DeleteIdentityPropagationConfigInput
- type DeleteIdentityPropagationConfigOutput
- type DeleteKnowledgeBaseInput
- type DeleteKnowledgeBaseOutput
- type DeleteLimitsProfileInput
- type DeleteLimitsProfileOutput
- type DeleteNamespaceInput
- type DeleteNamespaceOutput
- type DeleteOAuthClientApplicationInput
- type DeleteOAuthClientApplicationOutput
- type DeleteRefreshScheduleInput
- type DeleteRefreshScheduleOutput
- type DeleteRoleCustomPermissionInput
- type DeleteRoleCustomPermissionOutput
- type DeleteRoleMembershipInput
- type DeleteRoleMembershipOutput
- type DeleteSpaceInput
- type DeleteSpaceOutput
- type DeleteTemplateAliasInput
- type DeleteTemplateAliasOutput
- type DeleteTemplateInput
- type DeleteTemplateOutput
- type DeleteThemeAliasInput
- type DeleteThemeAliasOutput
- type DeleteThemeInput
- type DeleteThemeOutput
- type DeleteTopicInput
- type DeleteTopicOutput
- type DeleteTopicRefreshScheduleInput
- type DeleteTopicRefreshScheduleOutput
- type DeleteTopicV2Input
- type DeleteTopicV2Output
- type DeleteUserByPrincipalIdInput
- type DeleteUserByPrincipalIdOutput
- type DeleteUserCustomPermissionInput
- type DeleteUserCustomPermissionOutput
- type DeleteUserInput
- type DeleteUserOutput
- type DeleteVPCConnectionInput
- type DeleteVPCConnectionOutput
- type DescribeAccountCustomPermissionInput
- type DescribeAccountCustomPermissionOutput
- type DescribeAccountCustomizationInput
- type DescribeAccountCustomizationOutput
- type DescribeAccountSettingsInput
- type DescribeAccountSettingsOutput
- type DescribeAccountSubscriptionInput
- type DescribeAccountSubscriptionOutput
- type DescribeActionConnectorInput
- type DescribeActionConnectorOutput
- type DescribeActionConnectorPermissionsInput
- type DescribeActionConnectorPermissionsOutput
- type DescribeAgentInput
- type DescribeAgentOutput
- type DescribeAgentPermissionsInput
- type DescribeAgentPermissionsOutput
- type DescribeAnalysisDefinitionInput
- type DescribeAnalysisDefinitionOutput
- type DescribeAnalysisInput
- type DescribeAnalysisOutput
- type DescribeAnalysisPermissionsInput
- type DescribeAnalysisPermissionsOutput
- type DescribeAppInput
- type DescribeAppOutput
- type DescribeAppPermissionsInput
- type DescribeAppPermissionsOutput
- type DescribeApprovalPolicyInput
- type DescribeApprovalPolicyOutput
- type DescribeAssetBundleExportJobInput
- type DescribeAssetBundleExportJobOutput
- type DescribeAssetBundleImportJobInput
- type DescribeAssetBundleImportJobOutput
- type DescribeAutomationJobInput
- type DescribeAutomationJobOutput
- type DescribeBrandAssignmentInput
- type DescribeBrandAssignmentOutput
- type DescribeBrandInput
- type DescribeBrandOutput
- type DescribeBrandPublishedVersionInput
- type DescribeBrandPublishedVersionOutput
- type DescribeCustomPermissionsInput
- type DescribeCustomPermissionsOutput
- type DescribeDashboardDefinitionInput
- type DescribeDashboardDefinitionOutput
- type DescribeDashboardInput
- type DescribeDashboardOutput
- type DescribeDashboardPermissionsInput
- type DescribeDashboardPermissionsOutput
- type DescribeDashboardSnapshotJobInput
- type DescribeDashboardSnapshotJobOutput
- type DescribeDashboardSnapshotJobResultInput
- type DescribeDashboardSnapshotJobResultOutput
- type DescribeDashboardsQAConfigurationInput
- type DescribeDashboardsQAConfigurationOutput
- type DescribeDataSetInput
- type DescribeDataSetOutput
- type DescribeDataSetPermissionsInput
- type DescribeDataSetPermissionsOutput
- type DescribeDataSetRefreshPropertiesInput
- type DescribeDataSetRefreshPropertiesOutput
- type DescribeDataSourceInput
- type DescribeDataSourceOutput
- type DescribeDataSourcePermissionsInput
- type DescribeDataSourcePermissionsOutput
- type DescribeDefaultQBusinessApplicationInput
- type DescribeDefaultQBusinessApplicationOutput
- type DescribeDlpSettingInput
- type DescribeDlpSettingOutput
- type DescribeFlowInput
- type DescribeFlowOutput
- type DescribeFolderInput
- type DescribeFolderOutput
- type DescribeFolderPermissionsAPIClient
- type DescribeFolderPermissionsInput
- type DescribeFolderPermissionsOutput
- type DescribeFolderPermissionsPaginator
- type DescribeFolderPermissionsPaginatorOptions
- type DescribeFolderResolvedPermissionsAPIClient
- type DescribeFolderResolvedPermissionsInput
- type DescribeFolderResolvedPermissionsOutput
- type DescribeFolderResolvedPermissionsPaginator
- type DescribeFolderResolvedPermissionsPaginatorOptions
- type DescribeGroupInput
- type DescribeGroupMembershipInput
- type DescribeGroupMembershipOutput
- type DescribeGroupOutput
- type DescribeIAMPolicyAssignmentInput
- type DescribeIAMPolicyAssignmentOutput
- type DescribeIngestionInput
- type DescribeIngestionOutput
- type DescribeIpRestrictionInput
- type DescribeIpRestrictionOutput
- type DescribeKeyRegistrationInput
- type DescribeKeyRegistrationOutput
- type DescribeKnowledgeBaseInput
- type DescribeKnowledgeBaseOutput
- type DescribeKnowledgeBasePermissionsInput
- type DescribeKnowledgeBasePermissionsOutput
- type DescribeLimitsProfileInput
- type DescribeLimitsProfileOutput
- type DescribeNamespaceInput
- type DescribeNamespaceOutput
- type DescribeOAuthClientApplicationInput
- type DescribeOAuthClientApplicationOutput
- type DescribeQPersonalizationConfigurationInput
- type DescribeQPersonalizationConfigurationOutput
- type DescribeQuickSightQSearchConfigurationInput
- type DescribeQuickSightQSearchConfigurationOutput
- type DescribeRefreshScheduleInput
- type DescribeRefreshScheduleOutput
- type DescribeResourcePermissionsInput
- type DescribeResourcePermissionsOutput
- type DescribeRoleCustomPermissionInput
- type DescribeRoleCustomPermissionOutput
- type DescribeSelfUpgradeConfigurationInput
- type DescribeSelfUpgradeConfigurationOutput
- type DescribeSpaceInput
- type DescribeSpaceOutput
- type DescribeSpacePermissionsInput
- type DescribeSpacePermissionsOutput
- type DescribeTemplateAliasInput
- type DescribeTemplateAliasOutput
- type DescribeTemplateDefinitionInput
- type DescribeTemplateDefinitionOutput
- type DescribeTemplateInput
- type DescribeTemplateOutput
- type DescribeTemplatePermissionsInput
- type DescribeTemplatePermissionsOutput
- type DescribeThemeAliasInput
- type DescribeThemeAliasOutput
- type DescribeThemeInput
- type DescribeThemeOutput
- type DescribeThemePermissionsInput
- type DescribeThemePermissionsOutput
- type DescribeTopicInput
- type DescribeTopicOutput
- type DescribeTopicPermissionsInput
- type DescribeTopicPermissionsOutput
- type DescribeTopicPermissionsV2Input
- type DescribeTopicPermissionsV2Output
- type DescribeTopicRefreshInput
- type DescribeTopicRefreshOutput
- type DescribeTopicRefreshScheduleInput
- type DescribeTopicRefreshScheduleOutput
- type DescribeTopicV2Input
- type DescribeTopicV2Output
- type DescribeUserInput
- type DescribeUserOutput
- type DescribeVPCConnectionInput
- type DescribeVPCConnectionOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type GenerateEmbedUrlForAnonymousUserInput
- type GenerateEmbedUrlForAnonymousUserOutput
- type GenerateEmbedUrlForRegisteredUserInput
- type GenerateEmbedUrlForRegisteredUserOutput
- type GenerateEmbedUrlForRegisteredUserWithIdentityInput
- type GenerateEmbedUrlForRegisteredUserWithIdentityOutput
- func (v *GenerateEmbedUrlForRegisteredUserWithIdentityOutput) Deserialize(d smithy.ShapeDeserializer) error
- func (v *GenerateEmbedUrlForRegisteredUserWithIdentityOutput) Serialize(s smithy.ShapeSerializer)
- func (v *GenerateEmbedUrlForRegisteredUserWithIdentityOutput) SerializeMembers(s smithy.ShapeSerializer)
- type GetDashboardEmbedUrlInput
- type GetDashboardEmbedUrlOutput
- type GetFlowMetadataInput
- type GetFlowMetadataOutput
- type GetFlowPermissionsInput
- type GetFlowPermissionsOutput
- type GetIdentityContextInput
- type GetIdentityContextOutput
- type GetSessionEmbedUrlInput
- type GetSessionEmbedUrlOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListActionConnectorsAPIClient
- type ListActionConnectorsInput
- type ListActionConnectorsOutput
- type ListActionConnectorsPaginator
- type ListActionConnectorsPaginatorOptions
- type ListAgentsInput
- type ListAgentsOutput
- type ListAnalysesAPIClient
- type ListAnalysesInput
- type ListAnalysesOutput
- type ListAnalysesPaginator
- type ListAnalysesPaginatorOptions
- type ListApprovalPoliciesAPIClient
- type ListApprovalPoliciesInput
- type ListApprovalPoliciesOutput
- type ListApprovalPoliciesPaginator
- type ListApprovalPoliciesPaginatorOptions
- type ListAppsAPIClient
- type ListAppsInput
- type ListAppsOutput
- type ListAppsPaginator
- type ListAppsPaginatorOptions
- type ListAssetBundleExportJobsAPIClient
- type ListAssetBundleExportJobsInput
- type ListAssetBundleExportJobsOutput
- type ListAssetBundleExportJobsPaginator
- type ListAssetBundleExportJobsPaginatorOptions
- type ListAssetBundleImportJobsAPIClient
- type ListAssetBundleImportJobsInput
- type ListAssetBundleImportJobsOutput
- type ListAssetBundleImportJobsPaginator
- type ListAssetBundleImportJobsPaginatorOptions
- type ListBrandsAPIClient
- type ListBrandsInput
- type ListBrandsOutput
- type ListBrandsPaginator
- type ListBrandsPaginatorOptions
- type ListCustomPermissionsAPIClient
- type ListCustomPermissionsInput
- type ListCustomPermissionsOutput
- type ListCustomPermissionsPaginator
- type ListCustomPermissionsPaginatorOptions
- type ListDashboardVersionsAPIClient
- type ListDashboardVersionsInput
- type ListDashboardVersionsOutput
- type ListDashboardVersionsPaginator
- type ListDashboardVersionsPaginatorOptions
- type ListDashboardsAPIClient
- type ListDashboardsInput
- type ListDashboardsOutput
- type ListDashboardsPaginator
- type ListDashboardsPaginatorOptions
- type ListDataSetsAPIClient
- type ListDataSetsInput
- type ListDataSetsOutput
- type ListDataSetsPaginator
- type ListDataSetsPaginatorOptions
- type ListDataSourcesAPIClient
- type ListDataSourcesInput
- type ListDataSourcesOutput
- type ListDataSourcesPaginator
- type ListDataSourcesPaginatorOptions
- type ListDlpSettingsAPIClient
- type ListDlpSettingsInput
- type ListDlpSettingsOutput
- type ListDlpSettingsPaginator
- type ListDlpSettingsPaginatorOptions
- type ListFlowsAPIClient
- type ListFlowsInput
- type ListFlowsOutput
- type ListFlowsPaginator
- type ListFlowsPaginatorOptions
- type ListFolderMembersAPIClient
- type ListFolderMembersInput
- type ListFolderMembersOutput
- type ListFolderMembersPaginator
- type ListFolderMembersPaginatorOptions
- type ListFoldersAPIClient
- type ListFoldersForResourceAPIClient
- type ListFoldersForResourceInput
- type ListFoldersForResourceOutput
- type ListFoldersForResourcePaginator
- type ListFoldersForResourcePaginatorOptions
- type ListFoldersInput
- type ListFoldersOutput
- type ListFoldersPaginator
- type ListFoldersPaginatorOptions
- type ListGroupMembershipsAPIClient
- type ListGroupMembershipsInput
- type ListGroupMembershipsOutput
- type ListGroupMembershipsPaginator
- type ListGroupMembershipsPaginatorOptions
- type ListGroupsAPIClient
- type ListGroupsInput
- type ListGroupsOutput
- type ListGroupsPaginator
- type ListGroupsPaginatorOptions
- type ListIAMPolicyAssignmentsAPIClient
- type ListIAMPolicyAssignmentsForUserAPIClient
- type ListIAMPolicyAssignmentsForUserInput
- type ListIAMPolicyAssignmentsForUserOutput
- type ListIAMPolicyAssignmentsForUserPaginator
- type ListIAMPolicyAssignmentsForUserPaginatorOptions
- type ListIAMPolicyAssignmentsInput
- type ListIAMPolicyAssignmentsOutput
- type ListIAMPolicyAssignmentsPaginator
- type ListIAMPolicyAssignmentsPaginatorOptions
- type ListIdentityPropagationConfigsInput
- type ListIdentityPropagationConfigsOutput
- type ListIngestionsAPIClient
- type ListIngestionsInput
- type ListIngestionsOutput
- type ListIngestionsPaginator
- type ListIngestionsPaginatorOptions
- type ListKnowledgeBasesAPIClient
- type ListKnowledgeBasesInput
- type ListKnowledgeBasesOutput
- type ListKnowledgeBasesPaginator
- type ListKnowledgeBasesPaginatorOptions
- type ListLimitsProfilesAPIClient
- type ListLimitsProfilesInput
- type ListLimitsProfilesOutput
- type ListLimitsProfilesPaginator
- type ListLimitsProfilesPaginatorOptions
- type ListNamespacesAPIClient
- type ListNamespacesInput
- type ListNamespacesOutput
- type ListNamespacesPaginator
- type ListNamespacesPaginatorOptions
- type ListOAuthClientApplicationsAPIClient
- type ListOAuthClientApplicationsInput
- type ListOAuthClientApplicationsOutput
- type ListOAuthClientApplicationsPaginator
- type ListOAuthClientApplicationsPaginatorOptions
- type ListRefreshSchedulesInput
- type ListRefreshSchedulesOutput
- type ListRoleMembershipsAPIClient
- type ListRoleMembershipsInput
- type ListRoleMembershipsOutput
- type ListRoleMembershipsPaginator
- type ListRoleMembershipsPaginatorOptions
- type ListSelfUpgradesInput
- type ListSelfUpgradesOutput
- type ListSpaceResourcesInput
- type ListSpaceResourcesOutput
- type ListSpacesInput
- type ListSpacesOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTemplateAliasesAPIClient
- type ListTemplateAliasesInput
- type ListTemplateAliasesOutput
- type ListTemplateAliasesPaginator
- type ListTemplateAliasesPaginatorOptions
- type ListTemplateVersionsAPIClient
- type ListTemplateVersionsInput
- type ListTemplateVersionsOutput
- type ListTemplateVersionsPaginator
- type ListTemplateVersionsPaginatorOptions
- type ListTemplatesAPIClient
- type ListTemplatesInput
- type ListTemplatesOutput
- type ListTemplatesPaginator
- type ListTemplatesPaginatorOptions
- type ListThemeAliasesInput
- type ListThemeAliasesOutput
- type ListThemeVersionsAPIClient
- type ListThemeVersionsInput
- type ListThemeVersionsOutput
- type ListThemeVersionsPaginator
- type ListThemeVersionsPaginatorOptions
- type ListThemesAPIClient
- type ListThemesInput
- type ListThemesOutput
- type ListThemesPaginator
- type ListThemesPaginatorOptions
- type ListTopicRefreshSchedulesInput
- type ListTopicRefreshSchedulesOutput
- type ListTopicReviewedAnswersInput
- type ListTopicReviewedAnswersOutput
- type ListTopicsAPIClient
- type ListTopicsInput
- type ListTopicsOutput
- type ListTopicsPaginator
- type ListTopicsPaginatorOptions
- type ListTopicsV2APIClient
- type ListTopicsV2Input
- type ListTopicsV2Output
- type ListTopicsV2Paginator
- type ListTopicsV2PaginatorOptions
- type ListUserGroupsAPIClient
- type ListUserGroupsInput
- type ListUserGroupsOutput
- type ListUserGroupsPaginator
- type ListUserGroupsPaginatorOptions
- type ListUsersAPIClient
- type ListUsersIndexCapacityInput
- type ListUsersIndexCapacityOutput
- type ListUsersInput
- type ListUsersOutput
- type ListUsersPaginator
- type ListUsersPaginatorOptions
- type ListVPCConnectionsAPIClient
- type ListVPCConnectionsInput
- type ListVPCConnectionsOutput
- type ListVPCConnectionsPaginator
- type ListVPCConnectionsPaginatorOptions
- type Options
- type PredictQAResultsInput
- type PredictQAResultsOutput
- type PutDataSetRefreshPropertiesInput
- type PutDataSetRefreshPropertiesOutput
- type RegisterUserInput
- type RegisterUserOutput
- type ResolveEndpoint
- type RestoreAnalysisInput
- type RestoreAnalysisOutput
- type SearchActionConnectorsAPIClient
- type SearchActionConnectorsInput
- type SearchActionConnectorsOutput
- type SearchActionConnectorsPaginator
- type SearchActionConnectorsPaginatorOptions
- type SearchAgentsInput
- type SearchAgentsOutput
- type SearchAnalysesAPIClient
- type SearchAnalysesInput
- type SearchAnalysesOutput
- type SearchAnalysesPaginator
- type SearchAnalysesPaginatorOptions
- type SearchAppsAPIClient
- type SearchAppsInput
- type SearchAppsOutput
- type SearchAppsPaginator
- type SearchAppsPaginatorOptions
- type SearchDashboardsAPIClient
- type SearchDashboardsInput
- type SearchDashboardsOutput
- type SearchDashboardsPaginator
- type SearchDashboardsPaginatorOptions
- type SearchDataSetsAPIClient
- type SearchDataSetsInput
- type SearchDataSetsOutput
- type SearchDataSetsPaginator
- type SearchDataSetsPaginatorOptions
- type SearchDataSourcesAPIClient
- type SearchDataSourcesInput
- type SearchDataSourcesOutput
- type SearchDataSourcesPaginator
- type SearchDataSourcesPaginatorOptions
- type SearchFlowsAPIClient
- type SearchFlowsInput
- type SearchFlowsOutput
- type SearchFlowsPaginator
- type SearchFlowsPaginatorOptions
- type SearchFoldersAPIClient
- type SearchFoldersInput
- type SearchFoldersOutput
- type SearchFoldersPaginator
- type SearchFoldersPaginatorOptions
- type SearchGroupsAPIClient
- type SearchGroupsInput
- type SearchGroupsOutput
- type SearchGroupsPaginator
- type SearchGroupsPaginatorOptions
- type SearchKnowledgeBasesAPIClient
- type SearchKnowledgeBasesInput
- type SearchKnowledgeBasesOutput
- type SearchKnowledgeBasesPaginator
- type SearchKnowledgeBasesPaginatorOptions
- type SearchSpacesInput
- type SearchSpacesOutput
- type SearchTopicsAPIClient
- type SearchTopicsInput
- type SearchTopicsOutput
- type SearchTopicsPaginator
- type SearchTopicsPaginatorOptions
- type SearchTopicsV2APIClient
- type SearchTopicsV2Input
- type SearchTopicsV2Output
- type SearchTopicsV2Paginator
- type SearchTopicsV2PaginatorOptions
- type StartAssetBundleExportJobInput
- type StartAssetBundleExportJobOutput
- type StartAssetBundleImportJobInput
- type StartAssetBundleImportJobOutput
- type StartAutomationJobInput
- type StartAutomationJobOutput
- type StartDashboardSnapshotJobInput
- type StartDashboardSnapshotJobOutput
- type StartDashboardSnapshotJobScheduleInput
- type StartDashboardSnapshotJobScheduleOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateAccountCustomPermissionInput
- type UpdateAccountCustomPermissionOutput
- type UpdateAccountCustomizationInput
- type UpdateAccountCustomizationOutput
- type UpdateAccountSettingsInput
- type UpdateAccountSettingsOutput
- type UpdateActionConnectorInput
- type UpdateActionConnectorOutput
- type UpdateActionConnectorPermissionsInput
- type UpdateActionConnectorPermissionsOutput
- type UpdateAgentInput
- type UpdateAgentOutput
- type UpdateAgentPermissionsInput
- type UpdateAgentPermissionsOutput
- type UpdateAnalysisInput
- type UpdateAnalysisOutput
- type UpdateAnalysisPermissionsInput
- type UpdateAnalysisPermissionsOutput
- type UpdateAppPermissionsInput
- type UpdateAppPermissionsOutput
- type UpdateApplicationWithTokenExchangeGrantInput
- type UpdateApplicationWithTokenExchangeGrantOutput
- type UpdateApprovalPolicyInput
- type UpdateApprovalPolicyOutput
- type UpdateBrandAssignmentInput
- type UpdateBrandAssignmentOutput
- type UpdateBrandInput
- type UpdateBrandOutput
- type UpdateBrandPublishedVersionInput
- type UpdateBrandPublishedVersionOutput
- type UpdateCustomPermissionsInput
- type UpdateCustomPermissionsOutput
- type UpdateDashboardInput
- type UpdateDashboardLinksInput
- type UpdateDashboardLinksOutput
- type UpdateDashboardOutput
- type UpdateDashboardPermissionsInput
- type UpdateDashboardPermissionsOutput
- type UpdateDashboardPublishedVersionInput
- type UpdateDashboardPublishedVersionOutput
- type UpdateDashboardsQAConfigurationInput
- type UpdateDashboardsQAConfigurationOutput
- type UpdateDataSetInput
- type UpdateDataSetOutput
- type UpdateDataSetPermissionsInput
- type UpdateDataSetPermissionsOutput
- type UpdateDataSourceInput
- type UpdateDataSourceOutput
- type UpdateDataSourcePermissionsInput
- type UpdateDataSourcePermissionsOutput
- type UpdateDefaultQBusinessApplicationInput
- type UpdateDefaultQBusinessApplicationOutput
- type UpdateDlpSettingInput
- type UpdateDlpSettingOutput
- type UpdateFlowInput
- type UpdateFlowOutput
- type UpdateFlowPermissionsInput
- type UpdateFlowPermissionsOutput
- type UpdateFolderInput
- type UpdateFolderOutput
- type UpdateFolderPermissionsInput
- type UpdateFolderPermissionsOutput
- type UpdateGroupInput
- type UpdateGroupOutput
- type UpdateIAMPolicyAssignmentInput
- type UpdateIAMPolicyAssignmentOutput
- type UpdateIdentityPropagationConfigInput
- type UpdateIdentityPropagationConfigOutput
- type UpdateIpRestrictionInput
- type UpdateIpRestrictionOutput
- type UpdateKeyRegistrationInput
- type UpdateKeyRegistrationOutput
- type UpdateKnowledgeBaseInput
- type UpdateKnowledgeBaseOutput
- type UpdateKnowledgeBasePermissionsInput
- type UpdateKnowledgeBasePermissionsOutput
- type UpdateLimitsProfileInput
- type UpdateLimitsProfileOutput
- type UpdateOAuthClientApplicationInput
- type UpdateOAuthClientApplicationOutput
- type UpdatePublicSharingSettingsInput
- type UpdatePublicSharingSettingsOutput
- type UpdateQPersonalizationConfigurationInput
- type UpdateQPersonalizationConfigurationOutput
- type UpdateQuickSightQSearchConfigurationInput
- type UpdateQuickSightQSearchConfigurationOutput
- type UpdateRefreshScheduleInput
- type UpdateRefreshScheduleOutput
- type UpdateResourcePermissionsInput
- type UpdateResourcePermissionsOutput
- type UpdateRoleCustomPermissionInput
- type UpdateRoleCustomPermissionOutput
- type UpdateSPICECapacityConfigurationInput
- type UpdateSPICECapacityConfigurationOutput
- type UpdateSelfUpgradeConfigurationInput
- type UpdateSelfUpgradeConfigurationOutput
- type UpdateSelfUpgradeInput
- type UpdateSelfUpgradeOutput
- type UpdateSpaceInput
- type UpdateSpaceOutput
- type UpdateSpacePermissionsInput
- type UpdateSpacePermissionsOutput
- type UpdateSpaceResourcesInput
- type UpdateSpaceResourcesOutput
- type UpdateTemplateAliasInput
- type UpdateTemplateAliasOutput
- type UpdateTemplateInput
- type UpdateTemplateOutput
- type UpdateTemplatePermissionsInput
- type UpdateTemplatePermissionsOutput
- type UpdateThemeAliasInput
- type UpdateThemeAliasOutput
- type UpdateThemeInput
- type UpdateThemeOutput
- type UpdateThemePermissionsInput
- type UpdateThemePermissionsOutput
- type UpdateTopicInput
- type UpdateTopicOutput
- type UpdateTopicPermissionsInput
- type UpdateTopicPermissionsOutput
- type UpdateTopicPermissionsV2Input
- type UpdateTopicPermissionsV2Output
- type UpdateTopicRefreshScheduleInput
- type UpdateTopicRefreshScheduleOutput
- type UpdateTopicV2Input
- type UpdateTopicV2Output
- type UpdateUserCustomPermissionInput
- type UpdateUserCustomPermissionOutput
- type UpdateUserInput
- type UpdateUserOutput
- type UpdateVPCConnectionInput
- type UpdateVPCConnectionOutput
Constants ¶
const ServiceAPIVersion = "2018-04-01"
const ServiceID = "QuickSight"
Variables ¶
var TypeRegistry = &smithy.TypeRegistry{ Entries: map[string]*smithy.TypeRegistryEntry{ "com.amazonaws.quicksight#AccessDeniedException": { Schema: schemas.AccessDeniedException, New: func() any { return &types.AccessDeniedException{} }, }, "com.amazonaws.quicksight#ConcurrentUpdatingException": { Schema: schemas.ConcurrentUpdatingException, New: func() any { return &types.ConcurrentUpdatingException{} }, }, "com.amazonaws.quicksight#ConflictException": { Schema: schemas.ConflictException, New: func() any { return &types.ConflictException{} }, }, "com.amazonaws.quicksight#CustomerManagedKeyUnavailableException": { Schema: schemas.CustomerManagedKeyUnavailableException, New: func() any { return &types.CustomerManagedKeyUnavailableException{} }, }, "com.amazonaws.quicksight#DomainNotWhitelistedException": { Schema: schemas.DomainNotWhitelistedException, New: func() any { return &types.DomainNotWhitelistedException{} }, }, "com.amazonaws.quicksight#IdentityTypeNotSupportedException": { Schema: schemas.IdentityTypeNotSupportedException, New: func() any { return &types.IdentityTypeNotSupportedException{} }, }, "com.amazonaws.quicksight#InternalFailureException": { Schema: schemas.InternalFailureException, New: func() any { return &types.InternalFailureException{} }, }, "com.amazonaws.quicksight#InternalServerException": { Schema: schemas.InternalServerException, New: func() any { return &types.InternalServerException{} }, }, "com.amazonaws.quicksight#InvalidDataSetParameterValueException": { Schema: schemas.InvalidDataSetParameterValueException, New: func() any { return &types.InvalidDataSetParameterValueException{} }, }, "com.amazonaws.quicksight#InvalidNextTokenException": { Schema: schemas.InvalidNextTokenException, New: func() any { return &types.InvalidNextTokenException{} }, }, "com.amazonaws.quicksight#InvalidParameterException": { Schema: schemas.InvalidParameterException, New: func() any { return &types.InvalidParameterException{} }, }, "com.amazonaws.quicksight#InvalidParameterValueException": { Schema: schemas.InvalidParameterValueException, New: func() any { return &types.InvalidParameterValueException{} }, }, "com.amazonaws.quicksight#InvalidRequestException": { Schema: schemas.InvalidRequestException, New: func() any { return &types.InvalidRequestException{} }, }, "com.amazonaws.quicksight#LimitExceededException": { Schema: schemas.LimitExceededException, New: func() any { return &types.LimitExceededException{} }, }, "com.amazonaws.quicksight#PreconditionNotMetException": { Schema: schemas.PreconditionNotMetException, New: func() any { return &types.PreconditionNotMetException{} }, }, "com.amazonaws.quicksight#QuickSightUserNotFoundException": { Schema: schemas.QuickSightUserNotFoundException, New: func() any { return &types.QuickSightUserNotFoundException{} }, }, "com.amazonaws.quicksight#ResourceExistsException": { Schema: schemas.ResourceExistsException, New: func() any { return &types.ResourceExistsException{} }, }, "com.amazonaws.quicksight#ResourceNotFoundException": { Schema: schemas.ResourceNotFoundException, New: func() any { return &types.ResourceNotFoundException{} }, }, "com.amazonaws.quicksight#ResourceUnavailableException": { Schema: schemas.ResourceUnavailableException, New: func() any { return &types.ResourceUnavailableException{} }, }, "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException": { Schema: schemas.SessionLifetimeInMinutesInvalidException, New: func() any { return &types.SessionLifetimeInMinutesInvalidException{} }, }, "com.amazonaws.quicksight#ThrottlingException": { Schema: schemas.ThrottlingException, New: func() any { return &types.ThrottlingException{} }, }, "com.amazonaws.quicksight#UnsupportedPricingPlanException": { Schema: schemas.UnsupportedPricingPlanException, New: func() any { return &types.UnsupportedPricingPlanException{} }, }, "com.amazonaws.quicksight#UnsupportedUserEditionException": { Schema: schemas.UnsupportedUserEditionException, New: func() any { return &types.UnsupportedUserEditionException{} }, }, }, }
TypeRegistry is the type registry for this service.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v1.0.0
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶ added in v1.40.0
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶ added in v1.50.2
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶ added in v1.50.2
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AuthResolverParameters ¶ added in v1.50.2
type AuthResolverParameters struct {
// The name of the operation being invoked.
Operation string
// The region in which the operation is being invoked.
Region string
}
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶ added in v1.50.2
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type BatchCreateTopicReviewedAnswerInput ¶ added in v1.68.0
type BatchCreateTopicReviewedAnswerInput struct {
// The definition of the Answers to be created.
//
// This member is required.
Answers []types.CreateTopicReviewedAnswer
// The ID of the Amazon Web Services account that you want to create a reviewed
// answer in.
//
// This member is required.
AwsAccountId *string
// The ID for the topic reviewed answer that you want to create. This ID is unique
// per Amazon Web Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
// contains filtered or unexported fields
}
func (*BatchCreateTopicReviewedAnswerInput) Serialize ¶ added in v1.131.0
func (v *BatchCreateTopicReviewedAnswerInput) Serialize(s smithy.ShapeSerializer)
func (*BatchCreateTopicReviewedAnswerInput) SerializeMembers ¶ added in v1.131.0
func (v *BatchCreateTopicReviewedAnswerInput) SerializeMembers(s smithy.ShapeSerializer)
type BatchCreateTopicReviewedAnswerOutput ¶ added in v1.68.0
type BatchCreateTopicReviewedAnswerOutput struct {
// The definition of Answers that are invalid and not created.
InvalidAnswers []types.InvalidTopicReviewedAnswer
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The definition of Answers that are successfully created.
SucceededAnswers []types.SucceededTopicReviewedAnswer
// The Amazon Resource Name (ARN) of the topic.
TopicArn *string
// The ID for the topic reviewed answer that you want to create. This ID is unique
// per Amazon Web Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*BatchCreateTopicReviewedAnswerOutput) Deserialize ¶ added in v1.131.0
func (v *BatchCreateTopicReviewedAnswerOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*BatchCreateTopicReviewedAnswerOutput) Serialize ¶ added in v1.131.0
func (v *BatchCreateTopicReviewedAnswerOutput) Serialize(s smithy.ShapeSerializer)
func (*BatchCreateTopicReviewedAnswerOutput) SerializeMembers ¶ added in v1.131.0
func (v *BatchCreateTopicReviewedAnswerOutput) SerializeMembers(s smithy.ShapeSerializer)
type BatchDeleteKnowledgeBaseInput ¶ added in v1.114.0
type BatchDeleteKnowledgeBaseInput struct {
// The ID of the Amazon Web Services account that contains the knowledge base.
//
// This member is required.
AwsAccountId *string
// A list of knowledge base identifiers to delete.
//
// This member is required.
KnowledgeBaseIds []string
// contains filtered or unexported fields
}
func (*BatchDeleteKnowledgeBaseInput) Serialize ¶ added in v1.131.0
func (v *BatchDeleteKnowledgeBaseInput) Serialize(s smithy.ShapeSerializer)
func (*BatchDeleteKnowledgeBaseInput) SerializeMembers ¶ added in v1.131.0
func (v *BatchDeleteKnowledgeBaseInput) SerializeMembers(s smithy.ShapeSerializer)
type BatchDeleteKnowledgeBaseOutput ¶ added in v1.114.0
type BatchDeleteKnowledgeBaseOutput struct {
// A list of knowledge bases that were successfully deleted.
//
// This member is required.
Deleted []types.BatchDeleteKnowledgeBaseSuccess
// A list of knowledge bases that failed to be deleted.
//
// This member is required.
Errors []types.BatchDeleteKnowledgeBaseFailure
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status *int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*BatchDeleteKnowledgeBaseOutput) Deserialize ¶ added in v1.131.0
func (v *BatchDeleteKnowledgeBaseOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*BatchDeleteKnowledgeBaseOutput) Serialize ¶ added in v1.131.0
func (v *BatchDeleteKnowledgeBaseOutput) Serialize(s smithy.ShapeSerializer)
func (*BatchDeleteKnowledgeBaseOutput) SerializeMembers ¶ added in v1.131.0
func (v *BatchDeleteKnowledgeBaseOutput) SerializeMembers(s smithy.ShapeSerializer)
type BatchDeleteTopicReviewedAnswerInput ¶ added in v1.68.0
type BatchDeleteTopicReviewedAnswerInput struct {
// The ID of the Amazon Web Services account that you want to delete a reviewed
// answers in.
//
// This member is required.
AwsAccountId *string
// The ID for the topic reviewed answer that you want to delete. This ID is unique
// per Amazon Web Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
// The Answer IDs of the Answers to be deleted.
AnswerIds []string
// contains filtered or unexported fields
}
func (*BatchDeleteTopicReviewedAnswerInput) Serialize ¶ added in v1.131.0
func (v *BatchDeleteTopicReviewedAnswerInput) Serialize(s smithy.ShapeSerializer)
func (*BatchDeleteTopicReviewedAnswerInput) SerializeMembers ¶ added in v1.131.0
func (v *BatchDeleteTopicReviewedAnswerInput) SerializeMembers(s smithy.ShapeSerializer)
type BatchDeleteTopicReviewedAnswerOutput ¶ added in v1.68.0
type BatchDeleteTopicReviewedAnswerOutput struct {
// The definition of Answers that are invalid and not deleted.
InvalidAnswers []types.InvalidTopicReviewedAnswer
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The definition of Answers that are successfully deleted.
SucceededAnswers []types.SucceededTopicReviewedAnswer
// The Amazon Resource Name (ARN) of the topic.
TopicArn *string
// The ID of the topic reviewed answer that you want to delete. This ID is unique
// per Amazon Web Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*BatchDeleteTopicReviewedAnswerOutput) Deserialize ¶ added in v1.131.0
func (v *BatchDeleteTopicReviewedAnswerOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*BatchDeleteTopicReviewedAnswerOutput) Serialize ¶ added in v1.131.0
func (v *BatchDeleteTopicReviewedAnswerOutput) Serialize(s smithy.ShapeSerializer)
func (*BatchDeleteTopicReviewedAnswerOutput) SerializeMembers ¶ added in v1.131.0
func (v *BatchDeleteTopicReviewedAnswerOutput) SerializeMembers(s smithy.ShapeSerializer)
type BatchDescribeUserLimitsInput ¶ added in v1.124.0
type BatchDescribeUserLimitsInput struct {
// The ID of the Amazon Web Services account that contains the users.
//
// This member is required.
AccountId *string
// An optional filter that limits the results to specific resource types. If you
// don't specify a value, the operation returns limits for all resource types.
ResourceTypes []types.ResourceType
// A list of users to describe limits for. Each entry contains a user name and
// namespace.
Users []types.UserLimitsEntry
// contains filtered or unexported fields
}
func (*BatchDescribeUserLimitsInput) Serialize ¶ added in v1.131.0
func (v *BatchDescribeUserLimitsInput) Serialize(s smithy.ShapeSerializer)
func (*BatchDescribeUserLimitsInput) SerializeMembers ¶ added in v1.131.0
func (v *BatchDescribeUserLimitsInput) SerializeMembers(s smithy.ShapeSerializer)
type BatchDescribeUserLimitsOutput ¶ added in v1.124.0
type BatchDescribeUserLimitsOutput struct {
// A list of errors for users whose limits could not be described.
//
// This member is required.
Errors []types.BatchDescribeUserLimitsError
// A list of user limits results. Each entry contains the effective limits for a
// user.
//
// This member is required.
UserLimits []types.UserLimits
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*BatchDescribeUserLimitsOutput) Deserialize ¶ added in v1.131.0
func (v *BatchDescribeUserLimitsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*BatchDescribeUserLimitsOutput) Serialize ¶ added in v1.131.0
func (v *BatchDescribeUserLimitsOutput) Serialize(s smithy.ShapeSerializer)
func (*BatchDescribeUserLimitsOutput) SerializeMembers ¶ added in v1.131.0
func (v *BatchDescribeUserLimitsOutput) SerializeMembers(s smithy.ShapeSerializer)
type CancelIngestionInput ¶
type CancelIngestionInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset used in the ingestion.
//
// This member is required.
DataSetId *string
// An ID for the ingestion.
//
// This member is required.
IngestionId *string
// contains filtered or unexported fields
}
func (*CancelIngestionInput) Serialize ¶ added in v1.131.0
func (v *CancelIngestionInput) Serialize(s smithy.ShapeSerializer)
func (*CancelIngestionInput) SerializeMembers ¶ added in v1.131.0
func (v *CancelIngestionInput) SerializeMembers(s smithy.ShapeSerializer)
type CancelIngestionOutput ¶
type CancelIngestionOutput struct {
// The Amazon Resource Name (ARN) for the data ingestion.
Arn *string
// An ID for the ingestion.
IngestionId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CancelIngestionOutput) Deserialize ¶ added in v1.131.0
func (v *CancelIngestionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CancelIngestionOutput) Serialize ¶ added in v1.131.0
func (v *CancelIngestionOutput) Serialize(s smithy.ShapeSerializer)
func (*CancelIngestionOutput) SerializeMembers ¶ added in v1.131.0
func (v *CancelIngestionOutput) SerializeMembers(s smithy.ShapeSerializer)
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon QuickSight.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) BatchCreateTopicReviewedAnswer ¶ added in v1.68.0
func (c *Client) BatchCreateTopicReviewedAnswer(ctx context.Context, params *BatchCreateTopicReviewedAnswerInput, optFns ...func(*Options)) (*BatchCreateTopicReviewedAnswerOutput, error)
Creates new reviewed answers for a Q Topic.
func (*Client) BatchDeleteKnowledgeBase ¶ added in v1.114.0
func (c *Client) BatchDeleteKnowledgeBase(ctx context.Context, params *BatchDeleteKnowledgeBaseInput, optFns ...func(*Options)) (*BatchDeleteKnowledgeBaseOutput, error)
Deletes one or more knowledge bases.
func (*Client) BatchDeleteTopicReviewedAnswer ¶ added in v1.68.0
func (c *Client) BatchDeleteTopicReviewedAnswer(ctx context.Context, params *BatchDeleteTopicReviewedAnswerInput, optFns ...func(*Options)) (*BatchDeleteTopicReviewedAnswerOutput, error)
Deletes reviewed answers for Q Topic.
func (*Client) BatchDescribeUserLimits ¶ added in v1.124.0
func (c *Client) BatchDescribeUserLimits(ctx context.Context, params *BatchDescribeUserLimitsInput, optFns ...func(*Options)) (*BatchDescribeUserLimitsOutput, error)
Describes the effective resource limits for one or more Amazon Quick Sight users, including the limits that apply to each user based on their profile assignments.
func (*Client) CancelIngestion ¶
func (c *Client) CancelIngestion(ctx context.Context, params *CancelIngestionInput, optFns ...func(*Options)) (*CancelIngestionOutput, error)
Cancels an ongoing ingestion of data into SPICE.
func (*Client) CreateAccountCustomization ¶
func (c *Client) CreateAccountCustomization(ctx context.Context, params *CreateAccountCustomizationInput, optFns ...func(*Options)) (*CreateAccountCustomizationOutput, error)
Creates Amazon Quick Sight customizations. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon Quick Sight by removing Amazon Quick Sight sample assets and videos for all new users, see Customizing Quick Sightin the Amazon Quick Sight User Guide.
You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissionsAPI operation. To share the theme, grant permissions by using the UpdateThemePermissionsAPI operation.
func (*Client) CreateAccountSubscription ¶ added in v1.23.0
func (c *Client) CreateAccountSubscription(ctx context.Context, params *CreateAccountSubscriptionInput, optFns ...func(*Options)) (*CreateAccountSubscriptionOutput, error)
Creates an Amazon Quick Sight account, or subscribes to Amazon Quick Sight Q.
The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK.
Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Servicesin the Amazon Quick Sight User Guide. The person who signs up for Amazon Quick Sight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon Quick Sightin the Amazon Quick Sight User Guide.
If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow . If either action is set to Deny , the Deny action prevails and your API call fails.
You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon Quick Sight, see Passing IAM roles to Amazon Quick Sightin the Amazon Quick Sight User Guide.
You can't set default resource access on the new account from the Amazon Quick Sight API. Instead, add default resource access from the Amazon Quick Sight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services servicesin the Amazon Quick Sight User Guide.
func (*Client) CreateActionConnector ¶ added in v1.95.0
func (c *Client) CreateActionConnector(ctx context.Context, params *CreateActionConnectorInput, optFns ...func(*Options)) (*CreateActionConnectorOutput, error)
Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.
func (*Client) CreateAgent ¶ added in v1.113.0
func (c *Client) CreateAgent(ctx context.Context, params *CreateAgentInput, optFns ...func(*Options)) (*CreateAgentOutput, error)
Creates an agent in Amazon QuickSight.
func (*Client) CreateAnalysis ¶ added in v0.29.0
func (c *Client) CreateAnalysis(ctx context.Context, params *CreateAnalysisInput, optFns ...func(*Options)) (*CreateAnalysisOutput, error)
Creates an analysis in Amazon Quick Sight. Analyses can be created either from a template or from an AnalysisDefinition .
func (*Client) CreateApprovalPolicy ¶ added in v1.124.0
func (c *Client) CreateApprovalPolicy(ctx context.Context, params *CreateApprovalPolicyInput, optFns ...func(*Options)) (*CreateApprovalPolicyOutput, error)
Creates an approval policy in Quick Sight.
func (*Client) CreateBrand ¶ added in v1.79.0
func (c *Client) CreateBrand(ctx context.Context, params *CreateBrandInput, optFns ...func(*Options)) (*CreateBrandOutput, error)
Creates an Quick Sight brand.
func (*Client) CreateCustomPermissions ¶ added in v1.79.0
func (c *Client) CreateCustomPermissions(ctx context.Context, params *CreateCustomPermissionsInput, optFns ...func(*Options)) (*CreateCustomPermissionsOutput, error)
Creates a custom permissions profile.
func (*Client) CreateDashboard ¶
func (c *Client) CreateDashboard(ctx context.Context, params *CreateDashboardInput, optFns ...func(*Options)) (*CreateDashboardOutput, error)
Creates a dashboard from either a template or directly with a DashboardDefinition . To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in Amazon Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
func (*Client) CreateDataSet ¶
func (c *Client) CreateDataSet(ctx context.Context, params *CreateDataSetInput, optFns ...func(*Options)) (*CreateDataSetOutput, error)
Creates a dataset.
func (*Client) CreateDataSource ¶
func (c *Client) CreateDataSource(ctx context.Context, params *CreateDataSourceInput, optFns ...func(*Options)) (*CreateDataSourceOutput, error)
Creates a data source.
func (*Client) CreateDlpSetting ¶ added in v1.124.0
func (c *Client) CreateDlpSetting(ctx context.Context, params *CreateDlpSettingInput, optFns ...func(*Options)) (*CreateDlpSettingOutput, error)
Creates a data loss prevention (DLP) setting configuration for an Amazon Web Services account. A DLP setting defines the DLP provider, the enforcement behavior, and the Quick capabilities that the setting applies to.
func (*Client) CreateFlow ¶ added in v1.113.0
func (c *Client) CreateFlow(ctx context.Context, params *CreateFlowInput, optFns ...func(*Options)) (*CreateFlowOutput, error)
Creates a new flow in the specified Amazon Web Services account. Creates both a DRAFT and PUBLISHED (auto-published) version.
This operation is idempotent. Supply a ClientToken to safely retry without creating duplicate resources.
func (*Client) CreateFolder ¶ added in v1.6.0
func (c *Client) CreateFolder(ctx context.Context, params *CreateFolderInput, optFns ...func(*Options)) (*CreateFolderOutput, error)
Creates an empty shared folder.
func (*Client) CreateFolderMembership ¶ added in v1.6.0
func (c *Client) CreateFolderMembership(ctx context.Context, params *CreateFolderMembershipInput, optFns ...func(*Options)) (*CreateFolderMembershipOutput, error)
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
func (*Client) CreateGroup ¶
func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error)
Use the CreateGroup operation to create a group in Quick Sight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support.
The permissions resource is arn:aws:quicksight:::group/default/ .
The response is a group object.
func (*Client) CreateGroupMembership ¶
func (c *Client) CreateGroupMembership(ctx context.Context, params *CreateGroupMembershipInput, optFns ...func(*Options)) (*CreateGroupMembershipOutput, error)
Adds an Amazon Quick Sight user to an Amazon Quick Sight group.
func (*Client) CreateIAMPolicyAssignment ¶
func (c *Client) CreateIAMPolicyAssignment(ctx context.Context, params *CreateIAMPolicyAssignmentInput, optFns ...func(*Options)) (*CreateIAMPolicyAssignmentOutput, error)
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon Quick Sight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
func (*Client) CreateIngestion ¶
func (c *Client) CreateIngestion(ctx context.Context, params *CreateIngestionInput, optFns ...func(*Options)) (*CreateIngestionOutput, error)
Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags?in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
func (*Client) CreateKnowledgeBase ¶ added in v1.118.0
func (c *Client) CreateKnowledgeBase(ctx context.Context, params *CreateKnowledgeBaseInput, optFns ...func(*Options)) (*CreateKnowledgeBaseOutput, error)
Creates a knowledge base from a specified data source. Supported data source connector types include:
S3_KNOWLEDGE_BASE – Uses an Amazon S3 bucket as the data source.
WEB_CRAWLER – Uses web pages indexed by the built-in web crawler as the data source.
GOOGLE_DRIVE – Uses Google Drive as the data source. Supports service account authentication only.
SHAREPOINT – Uses SharePoint as the data source. Supports two-legged OAuth only.
ONE_DRIVE – Uses OneDrive as the data source. Supports two-legged OAuth only.
func (*Client) CreateLimitsProfile ¶ added in v1.124.0
func (c *Client) CreateLimitsProfile(ctx context.Context, params *CreateLimitsProfileInput, optFns ...func(*Options)) (*CreateLimitsProfileOutput, error)
Creates a limits profile that defines resource usage limits for Amazon Quick Sight users.
func (*Client) CreateNamespace ¶
func (c *Client) CreateNamespace(ctx context.Context, params *CreateNamespaceInput, optFns ...func(*Options)) (*CreateNamespaceOutput, error)
(Enterprise edition only) Creates a new namespace for you to use with Amazon Quick Sight.
A namespace allows you to isolate the Quick Sight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Quick Sight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
func (*Client) CreateOAuthClientApplication ¶ added in v1.112.0
func (c *Client) CreateOAuthClientApplication(ctx context.Context, params *CreateOAuthClientApplicationInput, optFns ...func(*Options)) (*CreateOAuthClientApplicationOutput, error)
Creates an OAuthClientApplication.
func (*Client) CreateRefreshSchedule ¶ added in v1.34.0
func (c *Client) CreateRefreshSchedule(ctx context.Context, params *CreateRefreshScheduleInput, optFns ...func(*Options)) (*CreateRefreshScheduleOutput, error)
Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
func (*Client) CreateRoleMembership ¶ added in v1.51.0
func (c *Client) CreateRoleMembership(ctx context.Context, params *CreateRoleMembershipInput, optFns ...func(*Options)) (*CreateRoleMembershipOutput, error)
Use CreateRoleMembership to add an existing Quick Sight group to an existing role.
func (*Client) CreateSpace ¶ added in v1.113.0
func (c *Client) CreateSpace(ctx context.Context, params *CreateSpaceInput, optFns ...func(*Options)) (*CreateSpaceOutput, error)
Creates a new Amazon QuickSight space. A space is a collection of resources that can be used to organize and manage QuickSight assets.
func (*Client) CreateTemplate ¶
func (c *Client) CreateTemplate(ctx context.Context, params *CreateTemplateInput, optFns ...func(*Options)) (*CreateTemplateOutput, error)
Creates a template either from a TemplateDefinition or from an existing Quick Sight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.
A template is an entity in Quick Sight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the 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.
func (*Client) CreateTemplateAlias ¶
func (c *Client) CreateTemplateAlias(ctx context.Context, params *CreateTemplateAliasInput, optFns ...func(*Options)) (*CreateTemplateAliasOutput, error)
Creates a template alias for a template.
func (*Client) CreateTheme ¶
func (c *Client) CreateTheme(ctx context.Context, params *CreateThemeInput, optFns ...func(*Options)) (*CreateThemeOutput, error)
Creates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon Quick Sightin the Amazon Quick Sight User Guide.
func (*Client) CreateThemeAlias ¶
func (c *Client) CreateThemeAlias(ctx context.Context, params *CreateThemeAliasInput, optFns ...func(*Options)) (*CreateThemeAliasOutput, error)
Creates a theme alias for a theme.
func (*Client) CreateTopic ¶ added in v1.35.0
func (c *Client) CreateTopic(ctx context.Context, params *CreateTopicInput, optFns ...func(*Options)) (*CreateTopicOutput, error)
Creates a new Q topic.
func (*Client) CreateTopicRefreshSchedule ¶ added in v1.35.0
func (c *Client) CreateTopicRefreshSchedule(ctx context.Context, params *CreateTopicRefreshScheduleInput, optFns ...func(*Options)) (*CreateTopicRefreshScheduleOutput, error)
Creates a topic refresh schedule.
func (*Client) CreateTopicV2 ¶ added in v1.123.0
func (c *Client) CreateTopicV2(ctx context.Context, params *CreateTopicV2Input, optFns ...func(*Options)) (*CreateTopicV2Output, error)
Creates a new Q topic.
func (*Client) CreateVPCConnection ¶ added in v1.35.0
func (c *Client) CreateVPCConnection(ctx context.Context, params *CreateVPCConnectionInput, optFns ...func(*Options)) (*CreateVPCConnectionOutput, error)
Creates a new VPC connection.
func (*Client) DeleteAccountCustomPermission ¶ added in v1.94.0
func (c *Client) DeleteAccountCustomPermission(ctx context.Context, params *DeleteAccountCustomPermissionInput, optFns ...func(*Options)) (*DeleteAccountCustomPermissionOutput, error)
Unapplies a custom permissions profile from an account.
func (*Client) DeleteAccountCustomization ¶
func (c *Client) DeleteAccountCustomization(ctx context.Context, params *DeleteAccountCustomizationInput, optFns ...func(*Options)) (*DeleteAccountCustomizationOutput, error)
This API permanently deletes all Quick Sight customizations for the specified Amazon Web Services account and namespace. When you delete account customizations:
All customizations are removed including themes, branding, and visual settings
This action cannot be undone through the API
Users will see default Quick Sight styling after customizations are deleted
Before proceeding: Ensure you have backups of any custom themes or branding elements you may want to recreate.
Deletes all Amazon Quick Sight customizations for the specified Amazon Web Services account and Quick Sight namespace.
func (*Client) DeleteAccountSubscription ¶ added in v1.27.0
func (c *Client) DeleteAccountSubscription(ctx context.Context, params *DeleteAccountSubscriptionInput, optFns ...func(*Options)) (*DeleteAccountSubscriptionOutput, error)
Deleting your Quick Sight account subscription has permanent, irreversible consequences across all Amazon Web Services regions:
Global deletion – Running this operation from any single region will delete your Quick Sight account and all data in every Amazon Web Services region where you have Quick Sight resources.
Complete data loss – All dashboards, analyses, datasets, data sources, and custom visuals will be permanently deleted across all regions.
Embedded content failure – All embedded dashboards and visuals in your applications will immediately stop working and display errors to end users.
Shared resources removed – All shared dashboards, folders, and resources will become inaccessible to other users and external recipients.
User access terminated – All Quick Sight users in your account will lose access immediately, including authors, readers, and administrators.
No recovery possible – Once deleted, your Quick Sight account and all associated data cannot be restored.
Consider exporting critical dashboards and data before proceeding with account deletion.
Use the DeleteAccountSubscription operation to delete an Quick Sight account. This operation will result in an error message if you have configured your account termination protection settings to True . To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False , then make another call to the DeleteAccountSubscription API.
func (*Client) DeleteActionConnector ¶ added in v1.95.0
func (c *Client) DeleteActionConnector(ctx context.Context, params *DeleteActionConnectorInput, optFns ...func(*Options)) (*DeleteActionConnectorOutput, error)
Hard deletes an action connector, making it unrecoverable. This operation removes the connector and all its associated configurations. Any resources currently using this action connector will no longer be able to perform actions through it.
func (*Client) DeleteAgent ¶ added in v1.113.0
func (c *Client) DeleteAgent(ctx context.Context, params *DeleteAgentInput, optFns ...func(*Options)) (*DeleteAgentOutput, error)
Deletes an agent.
func (*Client) DeleteAnalysis ¶ added in v0.29.0
func (c *Client) DeleteAnalysis(ctx context.Context, params *DeleteAnalysisInput, optFns ...func(*Options)) (*DeleteAnalysisOutput, error)
Deletes an analysis from Amazon Quick Sight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon Quick Sight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon Quick Sight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the Amazon Quick Sight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
func (*Client) DeleteApp ¶ added in v1.127.0
func (c *Client) DeleteApp(ctx context.Context, params *DeleteAppInput, optFns ...func(*Options)) (*DeleteAppOutput, error)
Deletes an app.
func (*Client) DeleteApprovalPolicy ¶ added in v1.124.0
func (c *Client) DeleteApprovalPolicy(ctx context.Context, params *DeleteApprovalPolicyInput, optFns ...func(*Options)) (*DeleteApprovalPolicyOutput, error)
Deletes an approval policy in Quick Sight.
func (*Client) DeleteBrand ¶ added in v1.79.0
func (c *Client) DeleteBrand(ctx context.Context, params *DeleteBrandInput, optFns ...func(*Options)) (*DeleteBrandOutput, error)
This API permanently deletes the specified Quick Sight brand. When you delete a brand:
The brand and all its associated branding elements are permanently removed
Any applications or dashboards using this brand will revert to default styling
This action cannot be undone through the API
Before proceeding: Verify that the brand is no longer needed and consider the impact on any applications currently using this brand.
Deletes an Quick Sight brand.
func (*Client) DeleteBrandAssignment ¶ added in v1.79.0
func (c *Client) DeleteBrandAssignment(ctx context.Context, params *DeleteBrandAssignmentInput, optFns ...func(*Options)) (*DeleteBrandAssignmentOutput, error)
Deletes a brand assignment.
func (*Client) DeleteCustomPermissions ¶ added in v1.79.0
func (c *Client) DeleteCustomPermissions(ctx context.Context, params *DeleteCustomPermissionsInput, optFns ...func(*Options)) (*DeleteCustomPermissionsOutput, error)
Deletes a custom permissions profile.
func (*Client) DeleteDashboard ¶
func (c *Client) DeleteDashboard(ctx context.Context, params *DeleteDashboardInput, optFns ...func(*Options)) (*DeleteDashboardOutput, error)
Deletes a dashboard.
func (*Client) DeleteDataSet ¶
func (c *Client) DeleteDataSet(ctx context.Context, params *DeleteDataSetInput, optFns ...func(*Options)) (*DeleteDataSetOutput, error)
Deletes a dataset.
func (*Client) DeleteDataSetRefreshProperties ¶ added in v1.34.0
func (c *Client) DeleteDataSetRefreshProperties(ctx context.Context, params *DeleteDataSetRefreshPropertiesInput, optFns ...func(*Options)) (*DeleteDataSetRefreshPropertiesOutput, error)
Deletes the dataset refresh properties of the dataset.
func (*Client) DeleteDataSource ¶
func (c *Client) DeleteDataSource(ctx context.Context, params *DeleteDataSourceInput, optFns ...func(*Options)) (*DeleteDataSourceOutput, error)
Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
func (*Client) DeleteDefaultQBusinessApplication ¶ added in v1.81.0
func (c *Client) DeleteDefaultQBusinessApplication(ctx context.Context, params *DeleteDefaultQBusinessApplicationInput, optFns ...func(*Options)) (*DeleteDefaultQBusinessApplicationOutput, error)
Deletes a linked Amazon Q Business application from an Quick Sight account
func (*Client) DeleteDlpSetting ¶ added in v1.124.0
func (c *Client) DeleteDlpSetting(ctx context.Context, params *DeleteDlpSettingInput, optFns ...func(*Options)) (*DeleteDlpSettingOutput, error)
Deletes a DLP setting configuration from an Amazon Web Services account.
func (*Client) DeleteFlow ¶ added in v1.113.0
func (c *Client) DeleteFlow(ctx context.Context, params *DeleteFlowInput, optFns ...func(*Options)) (*DeleteFlowOutput, error)
Permanently deletes a flow from the specified Amazon Web Services account. This operation cannot be undone.
func (*Client) DeleteFolder ¶ added in v1.6.0
func (c *Client) DeleteFolder(ctx context.Context, params *DeleteFolderInput, optFns ...func(*Options)) (*DeleteFolderOutput, error)
Deletes an empty folder.
func (*Client) DeleteFolderMembership ¶ added in v1.6.0
func (c *Client) DeleteFolderMembership(ctx context.Context, params *DeleteFolderMembershipInput, optFns ...func(*Options)) (*DeleteFolderMembershipOutput, error)
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
func (*Client) DeleteGroup ¶
func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error)
Removes a user group from Amazon Quick Sight.
func (*Client) DeleteGroupMembership ¶
func (c *Client) DeleteGroupMembership(ctx context.Context, params *DeleteGroupMembershipInput, optFns ...func(*Options)) (*DeleteGroupMembershipOutput, error)
Removes a user from a group so that the user is no longer a member of the group.
func (*Client) DeleteIAMPolicyAssignment ¶
func (c *Client) DeleteIAMPolicyAssignment(ctx context.Context, params *DeleteIAMPolicyAssignmentInput, optFns ...func(*Options)) (*DeleteIAMPolicyAssignmentOutput, error)
Deletes an existing IAM policy assignment.
func (*Client) DeleteIdentityPropagationConfig ¶ added in v1.52.0
func (c *Client) DeleteIdentityPropagationConfig(ctx context.Context, params *DeleteIdentityPropagationConfigInput, optFns ...func(*Options)) (*DeleteIdentityPropagationConfigOutput, error)
Deletes all access scopes and authorized targets that are associated with a service from the Quick Sight IAM Identity Center application.
This operation is only supported for Quick Sight accounts that use IAM Identity Center.
func (*Client) DeleteKnowledgeBase ¶ added in v1.114.0
func (c *Client) DeleteKnowledgeBase(ctx context.Context, params *DeleteKnowledgeBaseInput, optFns ...func(*Options)) (*DeleteKnowledgeBaseOutput, error)
Deletes a knowledge base.
func (*Client) DeleteLimitsProfile ¶ added in v1.124.0
func (c *Client) DeleteLimitsProfile(ctx context.Context, params *DeleteLimitsProfileInput, optFns ...func(*Options)) (*DeleteLimitsProfileOutput, error)
Deletes a limits profile.
func (*Client) DeleteNamespace ¶
func (c *Client) DeleteNamespace(ctx context.Context, params *DeleteNamespaceInput, optFns ...func(*Options)) (*DeleteNamespaceOutput, error)
Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
func (*Client) DeleteOAuthClientApplication ¶ added in v1.112.0
func (c *Client) DeleteOAuthClientApplication(ctx context.Context, params *DeleteOAuthClientApplicationInput, optFns ...func(*Options)) (*DeleteOAuthClientApplicationOutput, error)
Deletes an OAuthClientApplication.
func (*Client) DeleteRefreshSchedule ¶ added in v1.34.0
func (c *Client) DeleteRefreshSchedule(ctx context.Context, params *DeleteRefreshScheduleInput, optFns ...func(*Options)) (*DeleteRefreshScheduleOutput, error)
Deletes a refresh schedule from a dataset.
func (*Client) DeleteRoleCustomPermission ¶ added in v1.51.0
func (c *Client) DeleteRoleCustomPermission(ctx context.Context, params *DeleteRoleCustomPermissionInput, optFns ...func(*Options)) (*DeleteRoleCustomPermissionOutput, error)
Removes custom permissions from the role.
func (*Client) DeleteRoleMembership ¶ added in v1.51.0
func (c *Client) DeleteRoleMembership(ctx context.Context, params *DeleteRoleMembershipInput, optFns ...func(*Options)) (*DeleteRoleMembershipOutput, error)
Removes a group from a role.
func (*Client) DeleteSpace ¶ added in v1.113.0
func (c *Client) DeleteSpace(ctx context.Context, params *DeleteSpaceInput, optFns ...func(*Options)) (*DeleteSpaceOutput, error)
Deletes an Amazon QuickSight space.
func (*Client) DeleteTemplate ¶
func (c *Client) DeleteTemplate(ctx context.Context, params *DeleteTemplateInput, optFns ...func(*Options)) (*DeleteTemplateOutput, error)
Deletes a template.
func (*Client) DeleteTemplateAlias ¶
func (c *Client) DeleteTemplateAlias(ctx context.Context, params *DeleteTemplateAliasInput, optFns ...func(*Options)) (*DeleteTemplateAliasOutput, error)
Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
func (*Client) DeleteTheme ¶
func (c *Client) DeleteTheme(ctx context.Context, params *DeleteThemeInput, optFns ...func(*Options)) (*DeleteThemeOutput, error)
Deletes a theme.
func (*Client) DeleteThemeAlias ¶
func (c *Client) DeleteThemeAlias(ctx context.Context, params *DeleteThemeAliasInput, optFns ...func(*Options)) (*DeleteThemeAliasOutput, error)
Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
func (*Client) DeleteTopic ¶ added in v1.35.0
func (c *Client) DeleteTopic(ctx context.Context, params *DeleteTopicInput, optFns ...func(*Options)) (*DeleteTopicOutput, error)
Deletes a topic.
func (*Client) DeleteTopicRefreshSchedule ¶ added in v1.35.0
func (c *Client) DeleteTopicRefreshSchedule(ctx context.Context, params *DeleteTopicRefreshScheduleInput, optFns ...func(*Options)) (*DeleteTopicRefreshScheduleOutput, error)
Deletes a topic refresh schedule.
func (*Client) DeleteTopicV2 ¶ added in v1.123.0
func (c *Client) DeleteTopicV2(ctx context.Context, params *DeleteTopicV2Input, optFns ...func(*Options)) (*DeleteTopicV2Output, error)
Deletes a Q topic.
func (*Client) DeleteUser ¶
func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)
Deletes the Amazon Quick Sight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.
func (*Client) DeleteUserByPrincipalId ¶
func (c *Client) DeleteUserByPrincipalId(ctx context.Context, params *DeleteUserByPrincipalIdInput, optFns ...func(*Options)) (*DeleteUserByPrincipalIdOutput, error)
Deletes a user identified by its principal ID.
func (*Client) DeleteUserCustomPermission ¶ added in v1.79.0
func (c *Client) DeleteUserCustomPermission(ctx context.Context, params *DeleteUserCustomPermissionInput, optFns ...func(*Options)) (*DeleteUserCustomPermissionOutput, error)
Deletes a custom permissions profile from a user.
func (*Client) DeleteVPCConnection ¶ added in v1.35.0
func (c *Client) DeleteVPCConnection(ctx context.Context, params *DeleteVPCConnectionInput, optFns ...func(*Options)) (*DeleteVPCConnectionOutput, error)
Deletes a VPC connection.
func (*Client) DescribeAccountCustomPermission ¶ added in v1.94.0
func (c *Client) DescribeAccountCustomPermission(ctx context.Context, params *DescribeAccountCustomPermissionInput, optFns ...func(*Options)) (*DescribeAccountCustomPermissionOutput, error)
Describes the custom permissions profile that is applied to an account.
func (*Client) DescribeAccountCustomization ¶
func (c *Client) DescribeAccountCustomization(ctx context.Context, params *DescribeAccountCustomizationInput, optFns ...func(*Options)) (*DescribeAccountCustomizationOutput, error)
Describes the customizations associated with the provided Amazon Web Services account and Amazon Quick Sight namespace. The Quick Sight console evaluates which customizations to apply by running this API operation with the Resolved flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Quick Sight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Quick Sight in any supported Amazon Web Services Region.
Amazon Web Services Region - You can sign in to Quick Sight in any Amazon Web Services Region. If you have a user directory, it resides in us-east-1, which is US East (N. Virginia). Generally speaking, these users have access to Quick Sight in any Amazon Web Services Region, unless they are constrained to a namespace.
To run the command in a different Amazon Web Services Region, you change your
Region settings. If you're using the CLI, you can use one of the following options: - Use [command line options]. - Use [named profiles]. - Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see [Configuring the CLI]. - Namespace - A Quick Sight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region. - Applied customizations - Quick Sight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account.
func (*Client) DescribeAccountSettings ¶
func (c *Client) DescribeAccountSettings(ctx context.Context, params *DescribeAccountSettingsInput, optFns ...func(*Options)) (*DescribeAccountSettingsOutput, error)
Describes the settings that were used when your Quick Sight subscription was first created in this Amazon Web Services account.
func (*Client) DescribeAccountSubscription ¶ added in v1.23.0
func (c *Client) DescribeAccountSubscription(ctx context.Context, params *DescribeAccountSubscriptionInput, optFns ...func(*Options)) (*DescribeAccountSubscriptionOutput, error)
Use the DescribeAccountSubscription operation to receive a description of an Quick Sight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.
func (*Client) DescribeActionConnector ¶ added in v1.95.0
func (c *Client) DescribeActionConnector(ctx context.Context, params *DescribeActionConnectorInput, optFns ...func(*Options)) (*DescribeActionConnectorOutput, error)
Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.
func (*Client) DescribeActionConnectorPermissions ¶ added in v1.95.0
func (c *Client) DescribeActionConnectorPermissions(ctx context.Context, params *DescribeActionConnectorPermissionsInput, optFns ...func(*Options)) (*DescribeActionConnectorPermissionsOutput, error)
Retrieves the permissions configuration for an action connector, showing which users, groups, and namespaces have access and what operations they can perform.
func (*Client) DescribeAgent ¶ added in v1.113.0
func (c *Client) DescribeAgent(ctx context.Context, params *DescribeAgentInput, optFns ...func(*Options)) (*DescribeAgentOutput, error)
Describes an agent.
func (*Client) DescribeAgentPermissions ¶ added in v1.113.0
func (c *Client) DescribeAgentPermissions(ctx context.Context, params *DescribeAgentPermissionsInput, optFns ...func(*Options)) (*DescribeAgentPermissionsOutput, error)
Describes the resource permissions for an agent.
func (*Client) DescribeAnalysis ¶ added in v0.29.0
func (c *Client) DescribeAnalysis(ctx context.Context, params *DescribeAnalysisInput, optFns ...func(*Options)) (*DescribeAnalysisOutput, error)
Provides a summary of the metadata for an analysis.
func (*Client) DescribeAnalysisDefinition ¶ added in v1.28.0
func (c *Client) DescribeAnalysisDefinition(ctx context.Context, params *DescribeAnalysisDefinitionInput, optFns ...func(*Options)) (*DescribeAnalysisDefinitionOutput, error)
Provides a detailed description of the definition of an analysis.
If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysisDescribeAnalysis instead.
func (*Client) DescribeAnalysisPermissions ¶ added in v0.29.0
func (c *Client) DescribeAnalysisPermissions(ctx context.Context, params *DescribeAnalysisPermissionsInput, optFns ...func(*Options)) (*DescribeAnalysisPermissionsOutput, error)
Provides the read and write permissions for an analysis.
func (*Client) DescribeApp ¶ added in v1.127.0
func (c *Client) DescribeApp(ctx context.Context, params *DescribeAppInput, optFns ...func(*Options)) (*DescribeAppOutput, error)
Describes an app.
func (*Client) DescribeAppPermissions ¶ added in v1.127.0
func (c *Client) DescribeAppPermissions(ctx context.Context, params *DescribeAppPermissionsInput, optFns ...func(*Options)) (*DescribeAppPermissionsOutput, error)
Describes the resource permissions for an app.
func (*Client) DescribeApprovalPolicy ¶ added in v1.124.0
func (c *Client) DescribeApprovalPolicy(ctx context.Context, params *DescribeApprovalPolicyInput, optFns ...func(*Options)) (*DescribeApprovalPolicyOutput, error)
Describes an approval policy in Quick Sight.
func (*Client) DescribeAssetBundleExportJob ¶ added in v1.36.0
func (c *Client) DescribeAssetBundleExportJob(ctx context.Context, params *DescribeAssetBundleExportJobInput, optFns ...func(*Options)) (*DescribeAssetBundleExportJobOutput, error)
Describes an existing export job.
Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.
Job descriptions are available for 14 days after the job starts.
func (*Client) DescribeAssetBundleImportJob ¶ added in v1.36.0
func (c *Client) DescribeAssetBundleImportJob(ctx context.Context, params *DescribeAssetBundleImportJobInput, optFns ...func(*Options)) (*DescribeAssetBundleImportJobOutput, error)
Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
func (*Client) DescribeAutomationJob ¶ added in v1.106.0
func (c *Client) DescribeAutomationJob(ctx context.Context, params *DescribeAutomationJobInput, optFns ...func(*Options)) (*DescribeAutomationJobOutput, error)
Retrieves the status and details of a specified automation job, including its status and outputs.
func (*Client) DescribeBrand ¶ added in v1.79.0
func (c *Client) DescribeBrand(ctx context.Context, params *DescribeBrandInput, optFns ...func(*Options)) (*DescribeBrandOutput, error)
Describes a brand.
func (*Client) DescribeBrandAssignment ¶ added in v1.79.0
func (c *Client) DescribeBrandAssignment(ctx context.Context, params *DescribeBrandAssignmentInput, optFns ...func(*Options)) (*DescribeBrandAssignmentOutput, error)
Describes a brand assignment.
func (*Client) DescribeBrandPublishedVersion ¶ added in v1.79.0
func (c *Client) DescribeBrandPublishedVersion(ctx context.Context, params *DescribeBrandPublishedVersionInput, optFns ...func(*Options)) (*DescribeBrandPublishedVersionOutput, error)
Describes the published version of the brand.
func (*Client) DescribeCustomPermissions ¶ added in v1.79.0
func (c *Client) DescribeCustomPermissions(ctx context.Context, params *DescribeCustomPermissionsInput, optFns ...func(*Options)) (*DescribeCustomPermissionsOutput, error)
Describes a custom permissions profile.
func (*Client) DescribeDashboard ¶
func (c *Client) DescribeDashboard(ctx context.Context, params *DescribeDashboardInput, optFns ...func(*Options)) (*DescribeDashboardOutput, error)
Provides a summary for a dashboard.
func (*Client) DescribeDashboardDefinition ¶ added in v1.28.0
func (c *Client) DescribeDashboardDefinition(ctx context.Context, params *DescribeDashboardDefinitionInput, optFns ...func(*Options)) (*DescribeDashboardDefinitionOutput, error)
Provides a detailed description of the definition of a dashboard.
If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboardDescribeDashboard instead.
func (*Client) DescribeDashboardPermissions ¶
func (c *Client) DescribeDashboardPermissions(ctx context.Context, params *DescribeDashboardPermissionsInput, optFns ...func(*Options)) (*DescribeDashboardPermissionsOutput, error)
Describes read and write permissions for a dashboard.
func (*Client) DescribeDashboardSnapshotJob ¶ added in v1.39.0
func (c *Client) DescribeDashboardSnapshotJob(ctx context.Context, params *DescribeDashboardSnapshotJobInput, optFns ...func(*Options)) (*DescribeDashboardSnapshotJobOutput, error)
Describes an existing snapshot job.
Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus .
Registered user support ¶
This API can be called as before to get status of a job started by the same Quick Sight user.
Possible error scenarios ¶
Request will fail with an Access Denied error in the following scenarios:
The credentials have expired.
Job has been started by a different user.
Impersonated Quick Sight user doesn't have access to the specified dashboard in the job.
func (*Client) DescribeDashboardSnapshotJobResult ¶ added in v1.39.0
func (c *Client) DescribeDashboardSnapshotJobResult(ctx context.Context, params *DescribeDashboardSnapshotJobResultInput, optFns ...func(*Options)) (*DescribeDashboardSnapshotJobResultOutput, error)
Describes the result of an existing snapshot job that has finished running.
A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call.
If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id has not reached a terminal state. .
Registered user support ¶
This API can be called as before to get the result of a job started by the same Quick Sight user. The result for the user will be returned in RegisteredUsers response attribute. The attribute will contain a list with at most one object in it.
Possible error scenarios ¶
The request fails with an Access Denied error in the following scenarios:
The credentials have expired.
The job was started by a different user.
The registered user doesn't have access to the specified dashboard.
The request succeeds but the job fails in the following scenarios:
DASHBOARD_ACCESS_DENIED - The registered user lost access to the dashboard.
CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in all selected formats.
The request succeeds but the response contains an error code in the following scenarios:
CAPABILITY_RESTRICTED - The registered user is restricted from exporting data in some selected formats.
RLS_CHANGED - Row-level security settings have changed. Re-run the job with current settings.
CLS_CHANGED - Column-level security settings have changed. Re-run the job with current settings.
DATASET_DELETED - The dataset has been deleted. Verify the dataset exists before re-running the job.
func (*Client) DescribeDashboardsQAConfiguration ¶ added in v1.80.0
func (c *Client) DescribeDashboardsQAConfiguration(ctx context.Context, params *DescribeDashboardsQAConfigurationInput, optFns ...func(*Options)) (*DescribeDashboardsQAConfigurationOutput, error)
Describes an existing dashboard QA configuration.
func (*Client) DescribeDataSet ¶
func (c *Client) DescribeDataSet(ctx context.Context, params *DescribeDataSetInput, optFns ...func(*Options)) (*DescribeDataSetOutput, error)
Describes a dataset.
func (*Client) DescribeDataSetPermissions ¶
func (c *Client) DescribeDataSetPermissions(ctx context.Context, params *DescribeDataSetPermissionsInput, optFns ...func(*Options)) (*DescribeDataSetPermissionsOutput, error)
Describes the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id .
func (*Client) DescribeDataSetRefreshProperties ¶ added in v1.34.0
func (c *Client) DescribeDataSetRefreshProperties(ctx context.Context, params *DescribeDataSetRefreshPropertiesInput, optFns ...func(*Options)) (*DescribeDataSetRefreshPropertiesOutput, error)
Describes the refresh properties of a dataset.
func (*Client) DescribeDataSource ¶
func (c *Client) DescribeDataSource(ctx context.Context, params *DescribeDataSourceInput, optFns ...func(*Options)) (*DescribeDataSourceOutput, error)
Describes a data source.
func (*Client) DescribeDataSourcePermissions ¶
func (c *Client) DescribeDataSourcePermissions(ctx context.Context, params *DescribeDataSourcePermissionsInput, optFns ...func(*Options)) (*DescribeDataSourcePermissionsOutput, error)
Describes the resource permissions for a data source.
func (*Client) DescribeDefaultQBusinessApplication ¶ added in v1.81.0
func (c *Client) DescribeDefaultQBusinessApplication(ctx context.Context, params *DescribeDefaultQBusinessApplicationInput, optFns ...func(*Options)) (*DescribeDefaultQBusinessApplicationOutput, error)
Describes a Amazon Q Business application that is linked to an Quick Sight account.
func (*Client) DescribeDlpSetting ¶ added in v1.124.0
func (c *Client) DescribeDlpSetting(ctx context.Context, params *DescribeDlpSettingInput, optFns ...func(*Options)) (*DescribeDlpSettingOutput, error)
Describes the full configuration of a DLP setting in an Amazon Web Services account.
func (*Client) DescribeFlow ¶ added in v1.113.0
func (c *Client) DescribeFlow(ctx context.Context, params *DescribeFlowInput, optFns ...func(*Options)) (*DescribeFlowOutput, error)
Returns the full details of a flow for the latest version of the requested publish state.
func (*Client) DescribeFolder ¶ added in v1.6.0
func (c *Client) DescribeFolder(ctx context.Context, params *DescribeFolderInput, optFns ...func(*Options)) (*DescribeFolderOutput, error)
Describes a folder.
func (*Client) DescribeFolderPermissions ¶ added in v1.6.0
func (c *Client) DescribeFolderPermissions(ctx context.Context, params *DescribeFolderPermissionsInput, optFns ...func(*Options)) (*DescribeFolderPermissionsOutput, error)
Describes permissions for a folder.
func (*Client) DescribeFolderResolvedPermissions ¶ added in v1.6.0
func (c *Client) DescribeFolderResolvedPermissions(ctx context.Context, params *DescribeFolderResolvedPermissionsInput, optFns ...func(*Options)) (*DescribeFolderResolvedPermissionsOutput, error)
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
func (*Client) DescribeGroup ¶
func (c *Client) DescribeGroup(ctx context.Context, params *DescribeGroupInput, optFns ...func(*Options)) (*DescribeGroupOutput, error)
Returns an Amazon Quick Sight group's description and Amazon Resource Name (ARN).
func (*Client) DescribeGroupMembership ¶ added in v1.21.0
func (c *Client) DescribeGroupMembership(ctx context.Context, params *DescribeGroupMembershipInput, optFns ...func(*Options)) (*DescribeGroupMembershipOutput, error)
Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.
func (*Client) DescribeIAMPolicyAssignment ¶
func (c *Client) DescribeIAMPolicyAssignment(ctx context.Context, params *DescribeIAMPolicyAssignmentInput, optFns ...func(*Options)) (*DescribeIAMPolicyAssignmentOutput, error)
Describes an existing IAM policy assignment, as specified by the assignment name.
func (*Client) DescribeIngestion ¶
func (c *Client) DescribeIngestion(ctx context.Context, params *DescribeIngestionInput, optFns ...func(*Options)) (*DescribeIngestionOutput, error)
Describes a SPICE ingestion.
func (*Client) DescribeIpRestriction ¶ added in v1.13.0
func (c *Client) DescribeIpRestriction(ctx context.Context, params *DescribeIpRestrictionInput, optFns ...func(*Options)) (*DescribeIpRestrictionOutput, error)
Provides a summary and status of IP rules.
func (*Client) DescribeKeyRegistration ¶ added in v1.64.0
func (c *Client) DescribeKeyRegistration(ctx context.Context, params *DescribeKeyRegistrationInput, optFns ...func(*Options)) (*DescribeKeyRegistrationOutput, error)
Describes all customer managed key registrations in a Quick Sight account.
func (*Client) DescribeKnowledgeBase ¶ added in v1.114.0
func (c *Client) DescribeKnowledgeBase(ctx context.Context, params *DescribeKnowledgeBaseInput, optFns ...func(*Options)) (*DescribeKnowledgeBaseOutput, error)
Describes a knowledge base.
func (*Client) DescribeKnowledgeBasePermissions ¶ added in v1.114.0
func (c *Client) DescribeKnowledgeBasePermissions(ctx context.Context, params *DescribeKnowledgeBasePermissionsInput, optFns ...func(*Options)) (*DescribeKnowledgeBasePermissionsOutput, error)
Describes the resource permissions for a knowledge base.
func (*Client) DescribeLimitsProfile ¶ added in v1.124.0
func (c *Client) DescribeLimitsProfile(ctx context.Context, params *DescribeLimitsProfileInput, optFns ...func(*Options)) (*DescribeLimitsProfileOutput, error)
Describes the properties of an existing limits profile.
func (*Client) DescribeNamespace ¶
func (c *Client) DescribeNamespace(ctx context.Context, params *DescribeNamespaceInput, optFns ...func(*Options)) (*DescribeNamespaceOutput, error)
Describes the current namespace.
func (*Client) DescribeOAuthClientApplication ¶ added in v1.112.0
func (c *Client) DescribeOAuthClientApplication(ctx context.Context, params *DescribeOAuthClientApplicationInput, optFns ...func(*Options)) (*DescribeOAuthClientApplicationOutput, error)
Describes an OAuthClientApplication.
func (*Client) DescribeQPersonalizationConfiguration ¶ added in v1.74.0
func (c *Client) DescribeQPersonalizationConfiguration(ctx context.Context, params *DescribeQPersonalizationConfigurationInput, optFns ...func(*Options)) (*DescribeQPersonalizationConfigurationOutput, error)
Describes a personalization configuration.
func (*Client) DescribeQuickSightQSearchConfiguration ¶ added in v1.81.0
func (c *Client) DescribeQuickSightQSearchConfiguration(ctx context.Context, params *DescribeQuickSightQSearchConfigurationInput, optFns ...func(*Options)) (*DescribeQuickSightQSearchConfigurationOutput, error)
Describes the state of a Quick Sight Q Search configuration.
func (*Client) DescribeRefreshSchedule ¶ added in v1.34.0
func (c *Client) DescribeRefreshSchedule(ctx context.Context, params *DescribeRefreshScheduleInput, optFns ...func(*Options)) (*DescribeRefreshScheduleOutput, error)
Provides a summary of a refresh schedule.
func (*Client) DescribeResourcePermissions ¶ added in v1.139.0
func (c *Client) DescribeResourcePermissions(ctx context.Context, params *DescribeResourcePermissionsInput, optFns ...func(*Options)) (*DescribeResourcePermissionsOutput, error)
Describes the service role configuration for your Amazon Quick Sight account.
Call this operation in the Amazon Web Services Region where your Amazon Quick Sight account is registered (the home Region).
func (*Client) DescribeRoleCustomPermission ¶ added in v1.51.0
func (c *Client) DescribeRoleCustomPermission(ctx context.Context, params *DescribeRoleCustomPermissionInput, optFns ...func(*Options)) (*DescribeRoleCustomPermissionOutput, error)
Describes all custom permissions that are mapped to a role.
func (*Client) DescribeSelfUpgradeConfiguration ¶ added in v1.100.0
func (c *Client) DescribeSelfUpgradeConfiguration(ctx context.Context, params *DescribeSelfUpgradeConfigurationInput, optFns ...func(*Options)) (*DescribeSelfUpgradeConfigurationOutput, error)
Describes the self-upgrade configuration for a Quick account.
func (*Client) DescribeSpace ¶ added in v1.113.0
func (c *Client) DescribeSpace(ctx context.Context, params *DescribeSpaceInput, optFns ...func(*Options)) (*DescribeSpaceOutput, error)
Describes an Amazon QuickSight space.
func (*Client) DescribeSpacePermissions ¶ added in v1.113.0
func (c *Client) DescribeSpacePermissions(ctx context.Context, params *DescribeSpacePermissionsInput, optFns ...func(*Options)) (*DescribeSpacePermissionsOutput, error)
Describes the permissions for an Amazon QuickSight space.
func (*Client) DescribeTemplate ¶
func (c *Client) DescribeTemplate(ctx context.Context, params *DescribeTemplateInput, optFns ...func(*Options)) (*DescribeTemplateOutput, error)
Describes a template's metadata.
func (*Client) DescribeTemplateAlias ¶
func (c *Client) DescribeTemplateAlias(ctx context.Context, params *DescribeTemplateAliasInput, optFns ...func(*Options)) (*DescribeTemplateAliasOutput, error)
Describes the template alias for a template.
func (*Client) DescribeTemplateDefinition ¶ added in v1.28.0
func (c *Client) DescribeTemplateDefinition(ctx context.Context, params *DescribeTemplateDefinitionInput, optFns ...func(*Options)) (*DescribeTemplateDefinitionOutput, error)
Provides a detailed description of the definition of a template.
If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplateDescribeTemplate instead.
func (*Client) DescribeTemplatePermissions ¶
func (c *Client) DescribeTemplatePermissions(ctx context.Context, params *DescribeTemplatePermissionsInput, optFns ...func(*Options)) (*DescribeTemplatePermissionsOutput, error)
Describes read and write permissions on a template.
func (*Client) DescribeTheme ¶
func (c *Client) DescribeTheme(ctx context.Context, params *DescribeThemeInput, optFns ...func(*Options)) (*DescribeThemeOutput, error)
Describes a theme.
func (*Client) DescribeThemeAlias ¶
func (c *Client) DescribeThemeAlias(ctx context.Context, params *DescribeThemeAliasInput, optFns ...func(*Options)) (*DescribeThemeAliasOutput, error)
Describes the alias for a theme.
func (*Client) DescribeThemePermissions ¶
func (c *Client) DescribeThemePermissions(ctx context.Context, params *DescribeThemePermissionsInput, optFns ...func(*Options)) (*DescribeThemePermissionsOutput, error)
Describes the read and write permissions for a theme.
func (*Client) DescribeTopic ¶ added in v1.35.0
func (c *Client) DescribeTopic(ctx context.Context, params *DescribeTopicInput, optFns ...func(*Options)) (*DescribeTopicOutput, error)
Describes a topic.
func (*Client) DescribeTopicPermissions ¶ added in v1.35.0
func (c *Client) DescribeTopicPermissions(ctx context.Context, params *DescribeTopicPermissionsInput, optFns ...func(*Options)) (*DescribeTopicPermissionsOutput, error)
Describes the permissions of a topic.
func (*Client) DescribeTopicPermissionsV2 ¶ added in v1.123.0
func (c *Client) DescribeTopicPermissionsV2(ctx context.Context, params *DescribeTopicPermissionsV2Input, optFns ...func(*Options)) (*DescribeTopicPermissionsV2Output, error)
Describes the permissions of a topic.
func (*Client) DescribeTopicRefresh ¶ added in v1.35.0
func (c *Client) DescribeTopicRefresh(ctx context.Context, params *DescribeTopicRefreshInput, optFns ...func(*Options)) (*DescribeTopicRefreshOutput, error)
Describes the status of a topic refresh.
func (*Client) DescribeTopicRefreshSchedule ¶ added in v1.35.0
func (c *Client) DescribeTopicRefreshSchedule(ctx context.Context, params *DescribeTopicRefreshScheduleInput, optFns ...func(*Options)) (*DescribeTopicRefreshScheduleOutput, error)
Deletes a topic refresh schedule.
func (*Client) DescribeTopicV2 ¶ added in v1.123.0
func (c *Client) DescribeTopicV2(ctx context.Context, params *DescribeTopicV2Input, optFns ...func(*Options)) (*DescribeTopicV2Output, error)
Describes a Q topic.
func (*Client) DescribeUser ¶
func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, optFns ...func(*Options)) (*DescribeUserOutput, error)
Returns information about a user, given the user name.
func (*Client) DescribeVPCConnection ¶ added in v1.35.0
func (c *Client) DescribeVPCConnection(ctx context.Context, params *DescribeVPCConnectionInput, optFns ...func(*Options)) (*DescribeVPCConnectionOutput, error)
Describes a VPC connection.
func (*Client) GenerateEmbedUrlForAnonymousUser ¶ added in v1.7.0
func (c *Client) GenerateEmbedUrlForAnonymousUser(ctx context.Context, params *GenerateEmbedUrlForAnonymousUserInput, optFns ...func(*Options)) (*GenerateEmbedUrlForAnonymousUserOutput, error)
Generates an embed URL that you can use to embed an Amazon Quick dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutesparameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.
You are charged only when the URL is used or there is interaction with Amazon Quick.
For more information, see Embedded Analytics in the Amazon Quick User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon Quick Developer Portal.
func (*Client) GenerateEmbedUrlForRegisteredUser ¶ added in v1.7.0
func (c *Client) GenerateEmbedUrlForRegisteredUser(ctx context.Context, params *GenerateEmbedUrlForRegisteredUserInput, optFns ...func(*Options)) (*GenerateEmbedUrlForRegisteredUserOutput, error)
Generates an embed URL that you can use to embed an Amazon Quick experience in your website. This action can be used for any type of user registered in an Amazon Quick account. Before you use this action, make sure that you have configured the relevant Amazon Quick resource and permissions.
The following rules apply to the generated URL:
It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.
The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutesparameter.
The resulting user session is valid for 15 minutes (minimum) to 10 hours
(maximum). The default session duration is 10 hours. - You are charged only when the URL is used or there is interaction with Amazon Quick.
For more information, see Embedded Analytics in the Amazon Quick User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon Quick Developer Portal.
func (*Client) GenerateEmbedUrlForRegisteredUserWithIdentity ¶ added in v1.81.0
func (c *Client) GenerateEmbedUrlForRegisteredUserWithIdentity(ctx context.Context, params *GenerateEmbedUrlForRegisteredUserWithIdentityInput, optFns ...func(*Options)) (*GenerateEmbedUrlForRegisteredUserWithIdentityOutput, error)
Generates an embed URL that you can use to embed an Amazon Quick Sight experience in your website. This action can be used for any type of user that is registered in an Amazon Quick Sight account that uses IAM Identity Center for authentication. This API requires identity-enhanced IAM Role sessionsfor the authenticated user that the API call is being made for.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Amazon Quick Sightwith the scope value set to quicksight:read . Before you use this action, make sure that you have configured the relevant Amazon Quick Sight resource and permissions.
func (*Client) GetDashboardEmbedUrl ¶
func (c *Client) GetDashboardEmbedUrl(ctx context.Context, params *GetDashboardEmbedUrlInput, optFns ...func(*Options)) (*GetDashboardEmbedUrlOutput, error)
Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon Quick Sight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL:
They must be used together.
They can be used one time only.
They are valid for 5 minutes after you run this command.
You are charged only when the URL is used or there is interaction with Quick.
The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customize session duration.
For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon Quick User Guide.
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon Quick Developer Portal.
func (*Client) GetFlowMetadata ¶ added in v1.95.0
func (c *Client) GetFlowMetadata(ctx context.Context, params *GetFlowMetadataInput, optFns ...func(*Options)) (*GetFlowMetadataOutput, error)
Retrieves the metadata of a flow, not including its definition specifying the steps.
func (*Client) GetFlowPermissions ¶ added in v1.95.0
func (c *Client) GetFlowPermissions(ctx context.Context, params *GetFlowPermissionsInput, optFns ...func(*Options)) (*GetFlowPermissionsOutput, error)
Get permissions for a flow.
func (*Client) GetIdentityContext ¶ added in v1.99.0
func (c *Client) GetIdentityContext(ctx context.Context, params *GetIdentityContextInput, optFns ...func(*Options)) (*GetIdentityContextOutput, error)
Retrieves the identity context for a Quick Sight user in a specified namespace, allowing you to obtain identity tokens that can be used with identity-enhanced IAM role sessions to call identity-aware APIs.
Currently, you can call the following APIs with identity-enhanced Credentials ¶
DescribeDashboardSnapshotJobResult
Supported Authentication Methods ¶
This API supports Quick Sight native users, IAM federated users, and Active Directory users. For Quick Sight users authenticated by Amazon Web Services Identity Center, see Identity Center documentation on identity-enhanced IAM role sessions.
Supported Regions ¶
The GetIdentityContext API works only in regions that support at least one of these identity types:
Amazon Quick Sight native identity
IAM federated identity
Active Directory
To use this API successfully, call it in the same region where your user's identity resides. For example, if your user's identity is in us-east-1, make the API call in us-east-1. For more information about managing identities in Amazon Quick Sight, see Identity and access management in Amazon Quick Sightin the Amazon Quick Sight User Guide.
Getting Identity-Enhanced Credentials ¶
To obtain identity-enhanced credentials, follow these steps:
Call the GetIdentityContext API to retrieve an identity token for the specified user.
Use the identity token with the STS AssumeRole APIto obtain identity-enhanced IAM role session credentials.
Usage with STS AssumeRole ¶
The identity token returned by this API should be used with the STS AssumeRole API to obtain credentials for an identity-enhanced IAM role session. When calling AssumeRole, include the identity token in the ProvidedContexts parameter with ProviderArn set to arn:aws:iam::aws:contextProvider/QuickSight and ContextAssertion set to the identity token received from this API.
The assumed role must allow the sts:SetContext action in addition to sts:AssumeRole in its trust relationship policy. The trust policy should include both actions for the principal that will be assuming the role.
func (*Client) GetSessionEmbedUrl ¶
func (c *Client) GetSessionEmbedUrl(ctx context.Context, params *GetSessionEmbedUrlInput, optFns ...func(*Options)) (*GetSessionEmbedUrlOutput, error)
Generates a session URL and authorization code that you can use to embed the Amazon Amazon Quick Sight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon Quick Sight console need 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 UpdateUserAPI operation. Use 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:
func (*Client) ListActionConnectors ¶ added in v1.95.0
func (c *Client) ListActionConnectors(ctx context.Context, params *ListActionConnectorsInput, optFns ...func(*Options)) (*ListActionConnectorsOutput, error)
Lists all action connectors in the specified Amazon Web Services account. Returns summary information for each connector including its name, type, creation time, and status.
func (*Client) ListAgents ¶ added in v1.113.0
func (c *Client) ListAgents(ctx context.Context, params *ListAgentsInput, optFns ...func(*Options)) (*ListAgentsOutput, error)
Lists all agents in an Amazon QuickSight account.
func (*Client) ListAnalyses ¶ added in v0.29.0
func (c *Client) ListAnalyses(ctx context.Context, params *ListAnalysesInput, optFns ...func(*Options)) (*ListAnalysesOutput, error)
Lists Amazon Quick Sight analyses that exist in the specified Amazon Web Services account.
func (*Client) ListApprovalPolicies ¶ added in v1.124.0
func (c *Client) ListApprovalPolicies(ctx context.Context, params *ListApprovalPoliciesInput, optFns ...func(*Options)) (*ListApprovalPoliciesOutput, error)
Lists all approval policies in the specified Quick Sight account. The results are paginated. If the response includes a NextToken value, pass it in a subsequent call to retrieve the next set of results.
func (*Client) ListApps ¶ added in v1.127.0
func (c *Client) ListApps(ctx context.Context, params *ListAppsInput, optFns ...func(*Options)) (*ListAppsOutput, error)
Lists the apps in an Amazon Web Services account. Results are paginated; use the NextToken parameter to retrieve additional results.
func (*Client) ListAssetBundleExportJobs ¶ added in v1.36.0
func (c *Client) ListAssetBundleExportJobs(ctx context.Context, params *ListAssetBundleExportJobsInput, optFns ...func(*Options)) (*ListAssetBundleExportJobsOutput, error)
Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.
func (*Client) ListAssetBundleImportJobs ¶ added in v1.36.0
func (c *Client) ListAssetBundleImportJobs(ctx context.Context, params *ListAssetBundleImportJobsInput, optFns ...func(*Options)) (*ListAssetBundleImportJobsOutput, error)
Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.
func (*Client) ListBrands ¶ added in v1.79.0
func (c *Client) ListBrands(ctx context.Context, params *ListBrandsInput, optFns ...func(*Options)) (*ListBrandsOutput, error)
Lists all brands in an Quick Sight account.
func (*Client) ListCustomPermissions ¶ added in v1.79.0
func (c *Client) ListCustomPermissions(ctx context.Context, params *ListCustomPermissionsInput, optFns ...func(*Options)) (*ListCustomPermissionsOutput, error)
Returns a list of all the custom permissions profiles.
func (*Client) ListDashboardVersions ¶
func (c *Client) ListDashboardVersions(ctx context.Context, params *ListDashboardVersionsInput, optFns ...func(*Options)) (*ListDashboardVersionsOutput, error)
Lists all the versions of the dashboards in the Amazon Quick Sight subscription.
func (*Client) ListDashboards ¶
func (c *Client) ListDashboards(ctx context.Context, params *ListDashboardsInput, optFns ...func(*Options)) (*ListDashboardsOutput, error)
Lists dashboards in an Amazon Web Services account.
func (*Client) ListDataSets ¶
func (c *Client) ListDataSets(ctx context.Context, params *ListDataSetsInput, optFns ...func(*Options)) (*ListDataSetsOutput, error)
Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/* .
func (*Client) ListDataSources ¶
func (c *Client) ListDataSources(ctx context.Context, params *ListDataSourcesInput, optFns ...func(*Options)) (*ListDataSourcesOutput, error)
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
func (*Client) ListDlpSettings ¶ added in v1.124.0
func (c *Client) ListDlpSettings(ctx context.Context, params *ListDlpSettingsInput, optFns ...func(*Options)) (*ListDlpSettingsOutput, error)
Lists all DLP settings in an Amazon Web Services account.
func (*Client) ListFlows ¶ added in v1.95.0
func (c *Client) ListFlows(ctx context.Context, params *ListFlowsInput, optFns ...func(*Options)) (*ListFlowsOutput, error)
Lists flows in an Amazon Web Services account.
func (*Client) ListFolderMembers ¶ added in v1.6.0
func (c *Client) ListFolderMembers(ctx context.Context, params *ListFolderMembersInput, optFns ...func(*Options)) (*ListFolderMembersOutput, error)
List all assets ( DASHBOARD , ANALYSIS , and DATASET ) in a folder.
func (*Client) ListFolders ¶ added in v1.6.0
func (c *Client) ListFolders(ctx context.Context, params *ListFoldersInput, optFns ...func(*Options)) (*ListFoldersOutput, error)
Lists all folders in an account.
func (*Client) ListFoldersForResource ¶ added in v1.72.0
func (c *Client) ListFoldersForResource(ctx context.Context, params *ListFoldersForResourceInput, optFns ...func(*Options)) (*ListFoldersForResourceOutput, error)
List all folders that a resource is a member of.
func (*Client) ListGroupMemberships ¶
func (c *Client) ListGroupMemberships(ctx context.Context, params *ListGroupMembershipsInput, optFns ...func(*Options)) (*ListGroupMembershipsOutput, error)
Lists member users in a group.
func (*Client) ListGroups ¶
func (c *Client) ListGroups(ctx context.Context, params *ListGroupsInput, optFns ...func(*Options)) (*ListGroupsOutput, error)
Lists all user groups in Amazon Quick Sight.
func (*Client) ListIAMPolicyAssignments ¶
func (c *Client) ListIAMPolicyAssignments(ctx context.Context, params *ListIAMPolicyAssignmentsInput, optFns ...func(*Options)) (*ListIAMPolicyAssignmentsOutput, error)
Lists the IAM policy assignments in the current Amazon Quick Sight account.
func (*Client) ListIAMPolicyAssignmentsForUser ¶
func (c *Client) ListIAMPolicyAssignmentsForUser(ctx context.Context, params *ListIAMPolicyAssignmentsForUserInput, optFns ...func(*Options)) (*ListIAMPolicyAssignmentsForUserOutput, error)
Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.
func (*Client) ListIdentityPropagationConfigs ¶ added in v1.52.0
func (c *Client) ListIdentityPropagationConfigs(ctx context.Context, params *ListIdentityPropagationConfigsInput, optFns ...func(*Options)) (*ListIdentityPropagationConfigsOutput, error)
Lists all services and authorized targets that the Quick Sight IAM Identity Center application can access.
This operation is only supported for Quick Sight accounts that use IAM Identity Center.
func (*Client) ListIngestions ¶
func (c *Client) ListIngestions(ctx context.Context, params *ListIngestionsInput, optFns ...func(*Options)) (*ListIngestionsOutput, error)
Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.
func (*Client) ListKnowledgeBases ¶ added in v1.114.0
func (c *Client) ListKnowledgeBases(ctx context.Context, params *ListKnowledgeBasesInput, optFns ...func(*Options)) (*ListKnowledgeBasesOutput, error)
Lists all knowledge bases in an Amazon QuickSight account.
func (*Client) ListLimitsProfiles ¶ added in v1.124.0
func (c *Client) ListLimitsProfiles(ctx context.Context, params *ListLimitsProfilesInput, optFns ...func(*Options)) (*ListLimitsProfilesOutput, error)
Lists all limits profiles in an Amazon Quick Sight account. Results are paginated. Use the maxResults parameter to limit the number of results returned in a single call, and use the nextToken parameter to retrieve the next page of results.
func (*Client) ListNamespaces ¶
func (c *Client) ListNamespaces(ctx context.Context, params *ListNamespacesInput, optFns ...func(*Options)) (*ListNamespacesOutput, error)
Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
func (*Client) ListOAuthClientApplications ¶ added in v1.112.0
func (c *Client) ListOAuthClientApplications(ctx context.Context, params *ListOAuthClientApplicationsInput, optFns ...func(*Options)) (*ListOAuthClientApplicationsOutput, error)
Lists all OAuthClientApplications in the current Amazon Web Services Region that belong to this Amazon Web Services account.
func (*Client) ListRefreshSchedules ¶ added in v1.34.0
func (c *Client) ListRefreshSchedules(ctx context.Context, params *ListRefreshSchedulesInput, optFns ...func(*Options)) (*ListRefreshSchedulesOutput, error)
Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
func (*Client) ListRoleMemberships ¶ added in v1.51.0
func (c *Client) ListRoleMemberships(ctx context.Context, params *ListRoleMembershipsInput, optFns ...func(*Options)) (*ListRoleMembershipsOutput, error)
Lists all groups that are associated with a role.
func (*Client) ListSelfUpgrades ¶ added in v1.100.0
func (c *Client) ListSelfUpgrades(ctx context.Context, params *ListSelfUpgradesInput, optFns ...func(*Options)) (*ListSelfUpgradesOutput, error)
Lists all self-upgrade requests for a Quick account.
func (*Client) ListSpaceResources ¶ added in v1.113.0
func (c *Client) ListSpaceResources(ctx context.Context, params *ListSpaceResourcesInput, optFns ...func(*Options)) (*ListSpaceResourcesOutput, error)
Lists the resources in an Amazon QuickSight space.
func (*Client) ListSpaces ¶ added in v1.113.0
func (c *Client) ListSpaces(ctx context.Context, params *ListSpacesInput, optFns ...func(*Options)) (*ListSpacesOutput, error)
Lists all Amazon QuickSight spaces in an Amazon Web Services account.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Lists the tags assigned to a resource.
func (*Client) ListTemplateAliases ¶
func (c *Client) ListTemplateAliases(ctx context.Context, params *ListTemplateAliasesInput, optFns ...func(*Options)) (*ListTemplateAliasesOutput, error)
Lists all the aliases of a template.
func (*Client) ListTemplateVersions ¶
func (c *Client) ListTemplateVersions(ctx context.Context, params *ListTemplateVersionsInput, optFns ...func(*Options)) (*ListTemplateVersionsOutput, error)
Lists all the versions of the templates in the current Amazon Quick Sight account.
func (*Client) ListTemplates ¶
func (c *Client) ListTemplates(ctx context.Context, params *ListTemplatesInput, optFns ...func(*Options)) (*ListTemplatesOutput, error)
Lists all the templates in the current Amazon Quick Sight account.
func (*Client) ListThemeAliases ¶
func (c *Client) ListThemeAliases(ctx context.Context, params *ListThemeAliasesInput, optFns ...func(*Options)) (*ListThemeAliasesOutput, error)
Lists all the aliases of a theme.
func (*Client) ListThemeVersions ¶
func (c *Client) ListThemeVersions(ctx context.Context, params *ListThemeVersionsInput, optFns ...func(*Options)) (*ListThemeVersionsOutput, error)
Lists all the versions of the themes in the current Amazon Web Services account.
func (*Client) ListThemes ¶
func (c *Client) ListThemes(ctx context.Context, params *ListThemesInput, optFns ...func(*Options)) (*ListThemesOutput, error)
Lists all the themes in the current Amazon Web Services account.
func (*Client) ListTopicRefreshSchedules ¶ added in v1.35.0
func (c *Client) ListTopicRefreshSchedules(ctx context.Context, params *ListTopicRefreshSchedulesInput, optFns ...func(*Options)) (*ListTopicRefreshSchedulesOutput, error)
Lists all of the refresh schedules for a topic.
func (*Client) ListTopicReviewedAnswers ¶ added in v1.68.0
func (c *Client) ListTopicReviewedAnswers(ctx context.Context, params *ListTopicReviewedAnswersInput, optFns ...func(*Options)) (*ListTopicReviewedAnswersOutput, error)
Lists all reviewed answers for a Q Topic.
func (*Client) ListTopics ¶ added in v1.35.0
func (c *Client) ListTopics(ctx context.Context, params *ListTopicsInput, optFns ...func(*Options)) (*ListTopicsOutput, error)
Lists all of the topics within an account.
func (*Client) ListTopicsV2 ¶ added in v1.123.0
func (c *Client) ListTopicsV2(ctx context.Context, params *ListTopicsV2Input, optFns ...func(*Options)) (*ListTopicsV2Output, error)
Lists all of the Q topics in the specified Amazon Web Services account in an Amazon Web Services Region.
func (*Client) ListUserGroups ¶
func (c *Client) ListUserGroups(ctx context.Context, params *ListUserGroupsInput, optFns ...func(*Options)) (*ListUserGroupsOutput, error)
Lists the Amazon Quick Sight groups that an Amazon Quick Sight user is a member of.
func (*Client) ListUsers ¶
func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error)
Returns a list of all of the Amazon Quick Sight users belonging to this account.
func (*Client) ListUsersIndexCapacity ¶ added in v1.114.0
func (c *Client) ListUsersIndexCapacity(ctx context.Context, params *ListUsersIndexCapacityInput, optFns ...func(*Options)) (*ListUsersIndexCapacityOutput, error)
Lists per-user index capacity consumption for an account.
func (*Client) ListVPCConnections ¶ added in v1.35.0
func (c *Client) ListVPCConnections(ctx context.Context, params *ListVPCConnectionsInput, optFns ...func(*Options)) (*ListVPCConnectionsOutput, error)
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
func (*Client) Options ¶ added in v1.53.0
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) PredictQAResults ¶ added in v1.81.0
func (c *Client) PredictQAResults(ctx context.Context, params *PredictQAResultsInput, optFns ...func(*Options)) (*PredictQAResultsOutput, error)
Predicts existing visuals or generates new visuals to answer a given query.
This API uses trusted identity propagation to ensure that an end user is authenticated and receives the embed URL that is specific to that user. The IAM Identity Center application that the user has logged into needs to have trusted Identity Propagation enabled for Quickwith the scope value set to quicksight:read . Before you use this action, make sure that you have configured the relevant Quick resource and permissions.
We recommend enabling the QSearchStatus API to unlock the full potential of PredictQnA . When QSearchStatus is enabled, it first checks the specified dashboard for any existing visuals that match the question. If no matching visuals are found, PredictQnA uses generative Q&A to provide an answer. To update the QSearchStatus , see UpdateQuickSightQSearchConfiguration.
func (*Client) PutDataSetRefreshProperties ¶ added in v1.34.0
func (c *Client) PutDataSetRefreshProperties(ctx context.Context, params *PutDataSetRefreshPropertiesInput, optFns ...func(*Options)) (*PutDataSetRefreshPropertiesOutput, error)
Creates or updates the dataset refresh properties for the dataset.
func (*Client) RegisterUser ¶
func (c *Client) RegisterUser(ctx context.Context, params *RegisterUserInput, optFns ...func(*Options)) (*RegisterUserOutput, error)
Creates an Amazon Quick Sight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Quick Sight API, Quick Sight generates a registration URL. The user accesses this registration URL to create their account. Quick Sight doesn't send a registration email to users who are registered from the Quick Sight API. If you want new users to receive a registration email, then add those users in the Quick Sight console. For more information on registering a new user in the Quick Sight console, see Inviting users to access Quick Sight.
func (*Client) RestoreAnalysis ¶ added in v0.29.0
func (c *Client) RestoreAnalysis(ctx context.Context, params *RestoreAnalysisInput, optFns ...func(*Options)) (*RestoreAnalysisOutput, error)
Restores an analysis.
func (*Client) SearchActionConnectors ¶ added in v1.95.0
func (c *Client) SearchActionConnectors(ctx context.Context, params *SearchActionConnectorsInput, optFns ...func(*Options)) (*SearchActionConnectorsOutput, error)
Searches for action connectors in the specified Amazon Web Services account using filters. You can search by connector name, type, or user permissions.
func (*Client) SearchAgents ¶ added in v1.113.0
func (c *Client) SearchAgents(ctx context.Context, params *SearchAgentsInput, optFns ...func(*Options)) (*SearchAgentsOutput, error)
Searches for agents based on specified filters.
func (*Client) SearchAnalyses ¶ added in v0.29.0
func (c *Client) SearchAnalyses(ctx context.Context, params *SearchAnalysesInput, optFns ...func(*Options)) (*SearchAnalysesOutput, error)
Searches for analyses that belong to the user specified in the filter.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
func (*Client) SearchApps ¶ added in v1.127.0
func (c *Client) SearchApps(ctx context.Context, params *SearchAppsInput, optFns ...func(*Options)) (*SearchAppsOutput, error)
Searches for apps in an Amazon Web Services account using the specified filters. This operation is eventually consistent; the results might not reflect very recent updates. Results are paginated; use the NextToken parameter to retrieve additional results.
func (*Client) SearchDashboards ¶
func (c *Client) SearchDashboards(ctx context.Context, params *SearchDashboardsInput, optFns ...func(*Options)) (*SearchDashboardsOutput, error)
Searches for dashboards that belong to a user.
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
func (*Client) SearchDataSets ¶ added in v1.27.0
func (c *Client) SearchDataSets(ctx context.Context, params *SearchDataSetsInput, optFns ...func(*Options)) (*SearchDataSetsOutput, error)
Use the SearchDataSets operation to search for datasets that belong to an account.
func (*Client) SearchDataSources ¶ added in v1.27.0
func (c *Client) SearchDataSources(ctx context.Context, params *SearchDataSourcesInput, optFns ...func(*Options)) (*SearchDataSourcesOutput, error)
Use the SearchDataSources operation to search for data sources that belong to an account.
func (*Client) SearchFlows ¶ added in v1.95.0
func (c *Client) SearchFlows(ctx context.Context, params *SearchFlowsInput, optFns ...func(*Options)) (*SearchFlowsOutput, error)
Search for the flows in an Amazon Web Services account.
func (*Client) SearchFolders ¶ added in v1.6.0
func (c *Client) SearchFolders(ctx context.Context, params *SearchFoldersInput, optFns ...func(*Options)) (*SearchFoldersOutput, error)
Searches the subfolders in a folder.
func (*Client) SearchGroups ¶ added in v1.21.0
func (c *Client) SearchGroups(ctx context.Context, params *SearchGroupsInput, optFns ...func(*Options)) (*SearchGroupsOutput, error)
Use the SearchGroups operation to search groups in a specified Quick Sight namespace using the supplied filters.
func (*Client) SearchKnowledgeBases ¶ added in v1.114.0
func (c *Client) SearchKnowledgeBases(ctx context.Context, params *SearchKnowledgeBasesInput, optFns ...func(*Options)) (*SearchKnowledgeBasesOutput, error)
Searches for a subset of knowledge bases based on specified filters.
func (*Client) SearchSpaces ¶ added in v1.113.0
func (c *Client) SearchSpaces(ctx context.Context, params *SearchSpacesInput, optFns ...func(*Options)) (*SearchSpacesOutput, error)
Searches for Amazon QuickSight spaces that match the specified filters.
func (*Client) SearchTopics ¶ added in v1.80.0
func (c *Client) SearchTopics(ctx context.Context, params *SearchTopicsInput, optFns ...func(*Options)) (*SearchTopicsOutput, error)
Searches for any Q topic that exists in an Quick account.
func (*Client) SearchTopicsV2 ¶ added in v1.123.0
func (c *Client) SearchTopicsV2(ctx context.Context, params *SearchTopicsV2Input, optFns ...func(*Options)) (*SearchTopicsV2Output, error)
Searches for any Q topic that exists in an Amazon Web Services account.
func (*Client) StartAssetBundleExportJob ¶ added in v1.36.0
func (c *Client) StartAssetBundleExportJob(ctx context.Context, params *StartAssetBundleExportJobInput, optFns ...func(*Options)) (*StartAssetBundleExportJobOutput, error)
Starts an Asset Bundle export job.
An Asset Bundle export job exports specified Amazon Quick Sight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon Quick Sight account can run up to 5 export jobs concurrently.
The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
func (*Client) StartAssetBundleImportJob ¶ added in v1.36.0
func (c *Client) StartAssetBundleImportJob(ctx context.Context, params *StartAssetBundleImportJobInput, optFns ...func(*Options)) (*StartAssetBundleImportJobOutput, error)
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon Quick Sight assets into an Amazon Quick Sight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon Quick Sight account. Each Amazon Quick Sight account can run up to 5 import jobs concurrently.
The API caller must have the necessary "create" , "describe" , and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.
func (*Client) StartAutomationJob ¶ added in v1.106.0
func (c *Client) StartAutomationJob(ctx context.Context, params *StartAutomationJobInput, optFns ...func(*Options)) (*StartAutomationJobOutput, error)
Starts a new job for a specified automation. The job runs the automation with the provided input payload.
func (*Client) StartDashboardSnapshotJob ¶ added in v1.39.0
func (c *Client) StartDashboardSnapshotJob(ctx context.Context, params *StartDashboardSnapshotJobInput, optFns ...func(*Options)) (*StartDashboardSnapshotJobOutput, error)
Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.
1 PDF
1 Excel workbook that includes up to 5 table or pivot table visuals
5 CSVs from table or pivot table visuals
Exporting CSV, Excel, or Pixel Perfect PDF reports requires Pixel Perfect Report Add-on.
The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred.
StartDashboardSnapshotJob API throttling ¶
Quick Sight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob . By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Quick Sight throttles the API calls to maintin an optimal experience and reliability for all Quick Sight users.
Common throttling scenarios ¶
The following list provides information about the most commin throttling scenarios that can occur.
A large number of SnapshotExport API jobs are running simultaneously on an Amazon Web Services account. When a new StartDashboardSnapshotJob is created and there are already 12 jobs with the RUNNING status, the new job request fails and returns a LimitExceededException error. Wait for a current job to comlpete before you resubmit the new job.
A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Quick Sight API in one second, a ThrottlingException is returned.
If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupportto explore options to tailor a more optimal expereince for your account.
Best practices to handle throttling ¶
If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Quick Sight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes) . Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.
The time that it takes to process a job can be impacted by the following factors:
The dataset type (Direct Query or SPICE).
The size of the dataset.
The complexity of the calculated fields that are used in the dashboard.
The number of visuals that are on a sheet.
The types of visuals that are on the sheet.
The number of formats and snapshots that are requested in the job configuration.
The size of the generated snapshots.
Registered user support ¶
You can generate snapshots for registered Quick Sight users by using the Snapshot Job APIs with identity-enhanced IAM role session credentials. This approach allows you to create snapshots on behalf of specific Quick Sight users while respecting their row-level security (RLS), column-level security (CLS), dynamic default parameters and dashboard parameter/filter settings.
To generate snapshots for registered Quick Sight users, you need to:
Obtain identity-enhanced IAM role session credentials from Amazon Web Services Security Token Service (STS).
Use these credentials to call the Snapshot Job APIs.
Identity-enhanced credentials are credentials that contain information about the end user (e.g., registered Quick Sight user).
If your Quick Sight users are backed by Amazon Web Services Identity Center, then you need to set up a trusted token issuer. Then, getting identity-enhanced IAM credentials for a Quick Sight user will look like the following:
Authenticate user with your OIDC compliant Identity Provider. You should get auth tokens back.
Use the OIDC API, CreateTokenWithIAM, to exchange auth tokens to IAM tokens. One of the resulted tokens will be identity token.
Call STS AssumeRole API as you normally would, but provide an extra ProvidedContexts parameter in the API request. The list of contexts must have a single trusted context assertion. The ProviderArn should be arn:aws:iam::aws:contextProvider/IdentityCenter while ContextAssertion will be the identity token you received in response from CreateTokenWithIAM
For more details, see IdC documentation on Identity-enhanced IAM role sessions.
To obtain Identity-enhanced credentials for Quick Sight native users, IAM federated users, or Active Directory users, follow the steps below:
Call Quick Sight GetIdentityContext APIto get identity token.
Call STS AssumeRole API as you normally would, but provide extra ProvidedContexts parameter in the API request. The list of contexts must have a single trusted context assertion. The ProviderArn should be arn:aws:iam::aws:contextProvider/QuickSight while ContextAssertion will be the identity token you received in response from GetIdentityContext
After obtaining the identity-enhanced IAM role session credentials, you can use them to start a job, describe the job and describe job result. You can use the same credentials as long as they haven't expired. All API requests made with these credentials are considered to be made by the impersonated Quick Sight user.
When using identity-enhanced session credentials, set the UserConfiguration request attribute to null. Otherwise, the request will be invalid.
Possible error scenarios ¶
The request fails with an Access Denied error in the following scenarios:
The credentials have expired.
The impersonated Quick Sight user doesn't have access to the specified dashboard.
The impersonated Quick Sight user is restricted from exporting data in the selected formats. For more information about export restrictions, see Customizing access to Amazon Quick Sight capabilities.
func (*Client) StartDashboardSnapshotJobSchedule ¶ added in v1.77.0
func (c *Client) StartDashboardSnapshotJobSchedule(ctx context.Context, params *StartDashboardSnapshotJobScheduleInput, optFns ...func(*Options)) (*StartDashboardSnapshotJobScheduleOutput, error)
Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.
Only one job can run simultaneously in a given schedule. Repeated requests are skipped with a 202 HTTP status code.
For more information, see Scheduling and sending Amazon Quick Sight reports by email and Configuring email report settings for a Amazon Quick Sight dashboard in the Amazon Quick Sight User Guide.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Assigns one or more tags (key-value pairs) to the specified Amazon Quick Sight resource.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource. Amazon Quick Sight supports tagging on data set, data source, dashboard, template, topic, and user.
Tagging for Amazon Quick Sight works in a similar way to tagging for other Amazon Web Services services, except for the following:
Tags are used to track costs for users in Amazon Quick Sight. You can't tag other resources that Amazon Quick Sight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units.
Amazon Quick Sight doesn't currently support the tag editor for Resource Groups.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes a tag or tags from a resource.
func (*Client) UpdateAccountCustomPermission ¶ added in v1.94.0
func (c *Client) UpdateAccountCustomPermission(ctx context.Context, params *UpdateAccountCustomPermissionInput, optFns ...func(*Options)) (*UpdateAccountCustomPermissionOutput, error)
Applies a custom permissions profile to an account.
func (*Client) UpdateAccountCustomization ¶
func (c *Client) UpdateAccountCustomization(ctx context.Context, params *UpdateAccountCustomizationInput, optFns ...func(*Options)) (*UpdateAccountCustomizationOutput, error)
Updates Amazon Quick Sight customizations. Currently, the only customization that you can use is a theme.
You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Quick Sight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
func (*Client) UpdateAccountSettings ¶
func (c *Client) UpdateAccountSettings(ctx context.Context, params *UpdateAccountSettingsInput, optFns ...func(*Options)) (*UpdateAccountSettingsOutput, error)
Updates the Amazon Quick Sight settings in your Amazon Web Services account.
func (*Client) UpdateActionConnector ¶ added in v1.95.0
func (c *Client) UpdateActionConnector(ctx context.Context, params *UpdateActionConnectorInput, optFns ...func(*Options)) (*UpdateActionConnectorOutput, error)
Updates an existing action connector with new configuration details, authentication settings, or enabled actions. You can modify the connector's name, description, authentication configuration, and which actions are enabled. For more information, https://docs.aws.amazon.com/quicksuite/latest/userguide/quick-action-auth.html.
func (*Client) UpdateActionConnectorPermissions ¶ added in v1.95.0
func (c *Client) UpdateActionConnectorPermissions(ctx context.Context, params *UpdateActionConnectorPermissionsInput, optFns ...func(*Options)) (*UpdateActionConnectorPermissionsOutput, error)
Updates the permissions for an action connector by granting or revoking access for specific users and groups. You can control who can view, use, or manage the action connector.
func (*Client) UpdateAgent ¶ added in v1.113.0
func (c *Client) UpdateAgent(ctx context.Context, params *UpdateAgentInput, optFns ...func(*Options)) (*UpdateAgentOutput, error)
Updates an existing agent.
func (*Client) UpdateAgentPermissions ¶ added in v1.113.0
func (c *Client) UpdateAgentPermissions(ctx context.Context, params *UpdateAgentPermissionsInput, optFns ...func(*Options)) (*UpdateAgentPermissionsOutput, error)
Updates the resource permissions for an agent.
func (*Client) UpdateAnalysis ¶ added in v0.29.0
func (c *Client) UpdateAnalysis(ctx context.Context, params *UpdateAnalysisInput, optFns ...func(*Options)) (*UpdateAnalysisOutput, error)
Updates an analysis in Amazon Quick Sight
func (*Client) UpdateAnalysisPermissions ¶ added in v0.29.0
func (c *Client) UpdateAnalysisPermissions(ctx context.Context, params *UpdateAnalysisPermissionsInput, optFns ...func(*Options)) (*UpdateAnalysisPermissionsOutput, error)
Updates the read and write permissions for an analysis.
func (*Client) UpdateAppPermissions ¶ added in v1.127.0
func (c *Client) UpdateAppPermissions(ctx context.Context, params *UpdateAppPermissionsInput, optFns ...func(*Options)) (*UpdateAppPermissionsOutput, error)
Updates the resource permissions for an app. You can grant or revoke permissions and, optionally, change the app's visibility.
func (*Client) UpdateApplicationWithTokenExchangeGrant ¶ added in v1.81.0
func (c *Client) UpdateApplicationWithTokenExchangeGrant(ctx context.Context, params *UpdateApplicationWithTokenExchangeGrantInput, optFns ...func(*Options)) (*UpdateApplicationWithTokenExchangeGrantOutput, error)
Updates an Quick application with a token exchange grant. This operation only supports Quick applications that are registered with IAM Identity Center.
func (*Client) UpdateApprovalPolicy ¶ added in v1.124.0
func (c *Client) UpdateApprovalPolicy(ctx context.Context, params *UpdateApprovalPolicyInput, optFns ...func(*Options)) (*UpdateApprovalPolicyOutput, error)
Updates an approval policy in Quick Sight.
func (*Client) UpdateBrand ¶ added in v1.79.0
func (c *Client) UpdateBrand(ctx context.Context, params *UpdateBrandInput, optFns ...func(*Options)) (*UpdateBrandOutput, error)
Updates a brand.
func (*Client) UpdateBrandAssignment ¶ added in v1.79.0
func (c *Client) UpdateBrandAssignment(ctx context.Context, params *UpdateBrandAssignmentInput, optFns ...func(*Options)) (*UpdateBrandAssignmentOutput, error)
Updates a brand assignment.
func (*Client) UpdateBrandPublishedVersion ¶ added in v1.79.0
func (c *Client) UpdateBrandPublishedVersion(ctx context.Context, params *UpdateBrandPublishedVersionInput, optFns ...func(*Options)) (*UpdateBrandPublishedVersionOutput, error)
Updates the published version of a brand.
func (*Client) UpdateCustomPermissions ¶ added in v1.79.0
func (c *Client) UpdateCustomPermissions(ctx context.Context, params *UpdateCustomPermissionsInput, optFns ...func(*Options)) (*UpdateCustomPermissionsOutput, error)
Updates a custom permissions profile.
func (*Client) UpdateDashboard ¶
func (c *Client) UpdateDashboard(ctx context.Context, params *UpdateDashboardInput, optFns ...func(*Options)) (*UpdateDashboardOutput, error)
Updates a dashboard in an Amazon Web Services account.
Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersionAPI operation.
func (*Client) UpdateDashboardLinks ¶ added in v1.54.0
func (c *Client) UpdateDashboardLinks(ctx context.Context, params *UpdateDashboardLinksInput, optFns ...func(*Options)) (*UpdateDashboardLinksOutput, error)
Updates the linked analyses on a dashboard.
func (*Client) UpdateDashboardPermissions ¶
func (c *Client) UpdateDashboardPermissions(ctx context.Context, params *UpdateDashboardPermissionsInput, optFns ...func(*Options)) (*UpdateDashboardPermissionsOutput, error)
Updates read and write permissions on a dashboard.
func (*Client) UpdateDashboardPublishedVersion ¶
func (c *Client) UpdateDashboardPublishedVersion(ctx context.Context, params *UpdateDashboardPublishedVersionInput, optFns ...func(*Options)) (*UpdateDashboardPublishedVersionOutput, error)
Updates the published version of a dashboard.
func (*Client) UpdateDashboardsQAConfiguration ¶ added in v1.80.0
func (c *Client) UpdateDashboardsQAConfiguration(ctx context.Context, params *UpdateDashboardsQAConfigurationInput, optFns ...func(*Options)) (*UpdateDashboardsQAConfigurationOutput, error)
Updates a Dashboard QA configuration.
func (*Client) UpdateDataSet ¶
func (c *Client) UpdateDataSet(ctx context.Context, params *UpdateDataSetInput, optFns ...func(*Options)) (*UpdateDataSetOutput, error)
Updates a dataset. Partial updates are not supported by this operation.
func (*Client) UpdateDataSetPermissions ¶
func (c *Client) UpdateDataSetPermissions(ctx context.Context, params *UpdateDataSetPermissionsInput, optFns ...func(*Options)) (*UpdateDataSetPermissionsOutput, error)
Updates the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id .
func (*Client) UpdateDataSource ¶
func (c *Client) UpdateDataSource(ctx context.Context, params *UpdateDataSourceInput, optFns ...func(*Options)) (*UpdateDataSourceOutput, error)
Updates a data source.
func (*Client) UpdateDataSourcePermissions ¶
func (c *Client) UpdateDataSourcePermissions(ctx context.Context, params *UpdateDataSourcePermissionsInput, optFns ...func(*Options)) (*UpdateDataSourcePermissionsOutput, error)
Updates the permissions to a data source.
func (*Client) UpdateDefaultQBusinessApplication ¶ added in v1.81.0
func (c *Client) UpdateDefaultQBusinessApplication(ctx context.Context, params *UpdateDefaultQBusinessApplicationInput, optFns ...func(*Options)) (*UpdateDefaultQBusinessApplicationOutput, error)
Updates a Amazon Q Business application that is linked to a Quick Sight account.
func (*Client) UpdateDlpSetting ¶ added in v1.124.0
func (c *Client) UpdateDlpSetting(ctx context.Context, params *UpdateDlpSettingInput, optFns ...func(*Options)) (*UpdateDlpSettingOutput, error)
Updates an existing DLP setting configuration in an Amazon Web Services account. Fields that are omitted from the request retain their current values.
func (*Client) UpdateFlow ¶ added in v1.113.0
func (c *Client) UpdateFlow(ctx context.Context, params *UpdateFlowInput, optFns ...func(*Options)) (*UpdateFlowOutput, error)
Updates an existing flow. Supply only the fields you want to change. Updates both DRAFT and PUBLISHED versions. When FlowDefinition is provided, all existing steps are replaced with the new definition.
func (*Client) UpdateFlowPermissions ¶ added in v1.95.0
func (c *Client) UpdateFlowPermissions(ctx context.Context, params *UpdateFlowPermissionsInput, optFns ...func(*Options)) (*UpdateFlowPermissionsOutput, error)
Updates permissions against principals on a flow.
func (*Client) UpdateFolder ¶ added in v1.6.0
func (c *Client) UpdateFolder(ctx context.Context, params *UpdateFolderInput, optFns ...func(*Options)) (*UpdateFolderOutput, error)
Updates the name of a folder.
func (*Client) UpdateFolderPermissions ¶ added in v1.6.0
func (c *Client) UpdateFolderPermissions(ctx context.Context, params *UpdateFolderPermissionsInput, optFns ...func(*Options)) (*UpdateFolderPermissionsOutput, error)
Updates permissions of a folder.
func (*Client) UpdateGroup ¶
func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error)
Changes a group description.
func (*Client) UpdateIAMPolicyAssignment ¶
func (c *Client) UpdateIAMPolicyAssignment(ctx context.Context, params *UpdateIAMPolicyAssignmentInput, optFns ...func(*Options)) (*UpdateIAMPolicyAssignmentOutput, error)
Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities .
func (*Client) UpdateIdentityPropagationConfig ¶ added in v1.52.0
func (c *Client) UpdateIdentityPropagationConfig(ctx context.Context, params *UpdateIdentityPropagationConfigInput, optFns ...func(*Options)) (*UpdateIdentityPropagationConfigOutput, error)
Adds or updates services and authorized targets to configure what the Quick Sight IAM Identity Center application can access.
This operation is only supported for Quick Sight accounts using IAM Identity Center
func (*Client) UpdateIpRestriction ¶ added in v1.13.0
func (c *Client) UpdateIpRestriction(ctx context.Context, params *UpdateIpRestrictionInput, optFns ...func(*Options)) (*UpdateIpRestrictionOutput, error)
Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule , VpcIdRestrictionRule , or VpcEndpointIdRestrictionRule . To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.
func (*Client) UpdateKeyRegistration ¶ added in v1.64.0
func (c *Client) UpdateKeyRegistration(ctx context.Context, params *UpdateKeyRegistrationInput, optFns ...func(*Options)) (*UpdateKeyRegistrationOutput, error)
Updates a customer managed key in a Quick Sight account.
func (*Client) UpdateKnowledgeBase ¶ added in v1.118.0
func (c *Client) UpdateKnowledgeBase(ctx context.Context, params *UpdateKnowledgeBaseInput, optFns ...func(*Options)) (*UpdateKnowledgeBaseOutput, error)
Updates the properties of an existing knowledge base.
func (*Client) UpdateKnowledgeBasePermissions ¶ added in v1.114.0
func (c *Client) UpdateKnowledgeBasePermissions(ctx context.Context, params *UpdateKnowledgeBasePermissionsInput, optFns ...func(*Options)) (*UpdateKnowledgeBasePermissionsOutput, error)
Updates the resource permissions for a knowledge base.
func (*Client) UpdateLimitsProfile ¶ added in v1.124.0
func (c *Client) UpdateLimitsProfile(ctx context.Context, params *UpdateLimitsProfileInput, optFns ...func(*Options)) (*UpdateLimitsProfileOutput, error)
Updates the properties of an existing limits profile.
func (*Client) UpdateOAuthClientApplication ¶ added in v1.112.0
func (c *Client) UpdateOAuthClientApplication(ctx context.Context, params *UpdateOAuthClientApplicationInput, optFns ...func(*Options)) (*UpdateOAuthClientApplicationOutput, error)
Updates an OAuthClientApplication.
func (*Client) UpdatePublicSharingSettings ¶ added in v1.22.0
func (c *Client) UpdatePublicSharingSettings(ctx context.Context, params *UpdatePublicSharingSettingsInput, optFns ...func(*Options)) (*UpdatePublicSharingSettingsOutput, error)
This API controls public sharing settings for your entire Quick Sight account, affecting data security and access. When you enable public sharing:
Dashboards can be shared publicly
This setting affects your entire Amazon Web Services account and all Quick Sight users
Before proceeding: Ensure you understand the security implications and have proper IAM permissions configured.
Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon Quick Sight dashboard.
To use this operation, turn on session capacity pricing for your Amazon Quick Sight account.
Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon Quick Sight, see Using Quick with IAMin the Amazon Quick Sight User Guide.
func (*Client) UpdateQPersonalizationConfiguration ¶ added in v1.74.0
func (c *Client) UpdateQPersonalizationConfiguration(ctx context.Context, params *UpdateQPersonalizationConfigurationInput, optFns ...func(*Options)) (*UpdateQPersonalizationConfigurationOutput, error)
Updates a personalization configuration.
func (*Client) UpdateQuickSightQSearchConfiguration ¶ added in v1.81.0
func (c *Client) UpdateQuickSightQSearchConfiguration(ctx context.Context, params *UpdateQuickSightQSearchConfigurationInput, optFns ...func(*Options)) (*UpdateQuickSightQSearchConfigurationOutput, error)
Updates the state of a Quick Sight Q Search configuration.
func (*Client) UpdateRefreshSchedule ¶ added in v1.34.0
func (c *Client) UpdateRefreshSchedule(ctx context.Context, params *UpdateRefreshScheduleInput, optFns ...func(*Options)) (*UpdateRefreshScheduleOutput, error)
Updates a refresh schedule for a dataset.
func (*Client) UpdateResourcePermissions ¶ added in v1.139.0
func (c *Client) UpdateResourcePermissions(ctx context.Context, params *UpdateResourcePermissionsInput, optFns ...func(*Options)) (*UpdateResourcePermissionsOutput, error)
Updates the service role configuration that Amazon Quick Sight uses to access resources in your Amazon Web Services account. To use this operation, you must have the quicksight:UpdateResourcePermissions and iam:PassRole permissions.
Call this operation in the Amazon Web Services Region where your Amazon Quick Sight account is registered (the home Region). You can switch from a role managed by Amazon Quick Sight to a customer-managed role, or replace one customer-managed role with another. You can't use this operation to switch back to a role managed by Amazon Quick Sight.
func (*Client) UpdateRoleCustomPermission ¶ added in v1.51.0
func (c *Client) UpdateRoleCustomPermission(ctx context.Context, params *UpdateRoleCustomPermissionInput, optFns ...func(*Options)) (*UpdateRoleCustomPermissionOutput, error)
Updates the custom permissions that are associated with a role.
func (*Client) UpdateSPICECapacityConfiguration ¶ added in v1.63.0
func (c *Client) UpdateSPICECapacityConfiguration(ctx context.Context, params *UpdateSPICECapacityConfigurationInput, optFns ...func(*Options)) (*UpdateSPICECapacityConfigurationOutput, error)
Updates the SPICE capacity configuration for a Quick Sight account.
func (*Client) UpdateSelfUpgrade ¶ added in v1.100.0
func (c *Client) UpdateSelfUpgrade(ctx context.Context, params *UpdateSelfUpgradeInput, optFns ...func(*Options)) (*UpdateSelfUpgradeOutput, error)
Updates a self-upgrade request for a Quick user by approving, denying, or verifying the request.
func (*Client) UpdateSelfUpgradeConfiguration ¶ added in v1.100.0
func (c *Client) UpdateSelfUpgradeConfiguration(ctx context.Context, params *UpdateSelfUpgradeConfigurationInput, optFns ...func(*Options)) (*UpdateSelfUpgradeConfigurationOutput, error)
Updates the self-upgrade configuration for a Quick account.
func (*Client) UpdateSpace ¶ added in v1.113.0
func (c *Client) UpdateSpace(ctx context.Context, params *UpdateSpaceInput, optFns ...func(*Options)) (*UpdateSpaceOutput, error)
Updates the metadata of an Amazon QuickSight space.
func (*Client) UpdateSpacePermissions ¶ added in v1.113.0
func (c *Client) UpdateSpacePermissions(ctx context.Context, params *UpdateSpacePermissionsInput, optFns ...func(*Options)) (*UpdateSpacePermissionsOutput, error)
Updates the permissions for an Amazon QuickSight space.
func (*Client) UpdateSpaceResources ¶ added in v1.113.0
func (c *Client) UpdateSpaceResources(ctx context.Context, params *UpdateSpaceResourcesInput, optFns ...func(*Options)) (*UpdateSpaceResourcesOutput, error)
Adds or removes resources from an Amazon QuickSight space.
func (*Client) UpdateTemplate ¶
func (c *Client) UpdateTemplate(ctx context.Context, params *UpdateTemplateInput, optFns ...func(*Options)) (*UpdateTemplateOutput, error)
Updates a template from an existing Amazon Quick Sight analysis or another template.
func (*Client) UpdateTemplateAlias ¶
func (c *Client) UpdateTemplateAlias(ctx context.Context, params *UpdateTemplateAliasInput, optFns ...func(*Options)) (*UpdateTemplateAliasOutput, error)
Updates the template alias of a template.
func (*Client) UpdateTemplatePermissions ¶
func (c *Client) UpdateTemplatePermissions(ctx context.Context, params *UpdateTemplatePermissionsInput, optFns ...func(*Options)) (*UpdateTemplatePermissionsOutput, error)
Updates the resource permissions for a template.
func (*Client) UpdateTheme ¶
func (c *Client) UpdateTheme(ctx context.Context, params *UpdateThemeInput, optFns ...func(*Options)) (*UpdateThemeOutput, error)
Updates a theme.
func (*Client) UpdateThemeAlias ¶
func (c *Client) UpdateThemeAlias(ctx context.Context, params *UpdateThemeAliasInput, optFns ...func(*Options)) (*UpdateThemeAliasOutput, error)
Updates an alias of a theme.
func (*Client) UpdateThemePermissions ¶
func (c *Client) UpdateThemePermissions(ctx context.Context, params *UpdateThemePermissionsInput, optFns ...func(*Options)) (*UpdateThemePermissionsOutput, error)
Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme" .
Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:
User
"quicksight:DescribeTheme"
"quicksight:DescribeThemeAlias"
"quicksight:ListThemeAliases"
"quicksight:ListThemeVersions"
Owner
"quicksight:DescribeTheme"
"quicksight:DescribeThemeAlias"
"quicksight:ListThemeAliases"
"quicksight:ListThemeVersions"
"quicksight:DeleteTheme"
"quicksight:UpdateTheme"
"quicksight:CreateThemeAlias"
"quicksight:DeleteThemeAlias"
"quicksight:UpdateThemeAlias"
"quicksight:UpdateThemePermissions"
"quicksight:DescribeThemePermissions"
To specify no permissions, omit the permissions list.
func (*Client) UpdateTopic ¶ added in v1.35.0
func (c *Client) UpdateTopic(ctx context.Context, params *UpdateTopicInput, optFns ...func(*Options)) (*UpdateTopicOutput, error)
Updates a topic.
func (*Client) UpdateTopicPermissions ¶ added in v1.35.0
func (c *Client) UpdateTopicPermissions(ctx context.Context, params *UpdateTopicPermissionsInput, optFns ...func(*Options)) (*UpdateTopicPermissionsOutput, error)
Updates the permissions of a topic.
func (*Client) UpdateTopicPermissionsV2 ¶ added in v1.123.0
func (c *Client) UpdateTopicPermissionsV2(ctx context.Context, params *UpdateTopicPermissionsV2Input, optFns ...func(*Options)) (*UpdateTopicPermissionsV2Output, error)
Updates the permissions of a topic.
func (*Client) UpdateTopicRefreshSchedule ¶ added in v1.35.0
func (c *Client) UpdateTopicRefreshSchedule(ctx context.Context, params *UpdateTopicRefreshScheduleInput, optFns ...func(*Options)) (*UpdateTopicRefreshScheduleOutput, error)
Updates a topic refresh schedule.
func (*Client) UpdateTopicV2 ¶ added in v1.123.0
func (c *Client) UpdateTopicV2(ctx context.Context, params *UpdateTopicV2Input, optFns ...func(*Options)) (*UpdateTopicV2Output, error)
Updates the definition of a Q topic.
func (*Client) UpdateUser ¶
func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error)
Updates an Amazon Quick Sight user.
func (*Client) UpdateUserCustomPermission ¶ added in v1.79.0
func (c *Client) UpdateUserCustomPermission(ctx context.Context, params *UpdateUserCustomPermissionInput, optFns ...func(*Options)) (*UpdateUserCustomPermissionOutput, error)
Updates a custom permissions profile for a user.
func (*Client) UpdateVPCConnection ¶ added in v1.35.0
func (c *Client) UpdateVPCConnection(ctx context.Context, params *UpdateVPCConnectionInput, optFns ...func(*Options)) (*UpdateVPCConnectionOutput, error)
Updates a VPC connection.
type CreateAccountCustomizationInput ¶
type CreateAccountCustomizationInput struct {
// The Quick Sight customizations you're adding. You can add these to an Amazon
// Web Services account and a QuickSight namespace.
//
// For example, you can add a default theme by setting AccountCustomization to the
// midnight theme: "AccountCustomization": { "DefaultTheme":
// "arn:aws:quicksight::aws:theme/MIDNIGHT" } . Or, you can add a custom theme by
// specifying "AccountCustomization": { "DefaultTheme":
// "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"
// } .
//
// This member is required.
AccountCustomization *types.AccountCustomization
// The ID for the Amazon Web Services account that you want to customize Quick
// Sight for.
//
// This member is required.
AwsAccountId *string
// The Quick Sight namespace that you want to add customizations to.
Namespace *string
// A list of the tags that you want to attach to this resource.
Tags []types.Tag
// contains filtered or unexported fields
}
func (*CreateAccountCustomizationInput) Serialize ¶ added in v1.131.0
func (v *CreateAccountCustomizationInput) Serialize(s smithy.ShapeSerializer)
func (*CreateAccountCustomizationInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateAccountCustomizationInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateAccountCustomizationOutput ¶
type CreateAccountCustomizationOutput struct {
// The Quick Sight customizations you're adding.
AccountCustomization *types.AccountCustomization
// The Amazon Resource Name (ARN) for the customization that you created for this
// Amazon Web Services account.
Arn *string
// The ID for the Amazon Web Services account that you want to customize Quick
// Sight for.
AwsAccountId *string
// The namespace associated with the customization you're creating.
Namespace *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateAccountCustomizationOutput) Deserialize ¶ added in v1.131.0
func (v *CreateAccountCustomizationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateAccountCustomizationOutput) Serialize ¶ added in v1.131.0
func (v *CreateAccountCustomizationOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateAccountCustomizationOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateAccountCustomizationOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateAccountSubscriptionInput ¶ added in v1.23.0
type CreateAccountSubscriptionInput struct {
// The name of your Amazon Quick Sight account. This name is unique over all of
// Amazon Web Services, and it appears only when users sign in. You can't change
// AccountName value after the Amazon Quick Sight account is created.
//
// This member is required.
AccountName *string
// The method that you want to use to authenticate your Quick Sight account.
//
// If you choose ACTIVE_DIRECTORY , provide an ActiveDirectoryName and an
// AdminGroup associated with your Active Directory.
//
// If you choose IAM_IDENTITY_CENTER , provide an AdminGroup associated with your
// IAM Identity Center account.
//
// This member is required.
AuthenticationMethod types.AuthenticationMethodOption
// The Amazon Web Services account ID of the account that you're using to create
// your Quick Sight account.
//
// This member is required.
AwsAccountId *string
// The email address that you want Quick Sight to send notifications to regarding
// your Quick Sight account or Quick Sight subscription.
//
// This member is required.
NotificationEmail *string
// The name of your Active Directory. This field is required if ACTIVE_DIRECTORY
// is the selected authentication method of the new Quick Sight account.
ActiveDirectoryName *string
// The admin group associated with your Active Directory or IAM Identity Center
// account. Either this field or the AdminProGroup field is required if
// ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method
// of the new Quick Sight account.
//
// For more information about using IAM Identity Center in Amazon Quick Sight, see [Using IAM Identity Center with Amazon Quick Sight Enterprise Edition]
// in the Amazon Quick Sight User Guide. For more information about using Active
// Directory in Amazon Quick Sight, see [Using Active Directory with Amazon Quick Sight Enterprise Edition]in the Amazon Quick Sight User Guide.
//
// [Using Active Directory with Amazon Quick Sight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
// [Using IAM Identity Center with Amazon Quick Sight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
AdminGroup []string
// The admin pro group associated with your Active Directory or IAM Identity
// Center account. Either this field or the AdminGroup field is required if
// ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method
// of the new Quick Sight account.
//
// For more information about using IAM Identity Center in Amazon Quick Sight, see [Using IAM Identity Center with Amazon Quick Sight Enterprise Edition]
// in the Amazon Quick Sight User Guide. For more information about using Active
// Directory in Amazon Quick Sight, see [Using Active Directory with Amazon Quick Sight Enterprise Edition]in the Amazon Quick Sight User Guide.
//
// [Using Active Directory with Amazon Quick Sight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
// [Using IAM Identity Center with Amazon Quick Sight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
AdminProGroup []string
// The author group associated with your Active Directory or IAM Identity Center
// account.
//
// For more information about using IAM Identity Center in Amazon Quick Sight, see [Using IAM Identity Center with Amazon Quick Sight Enterprise Edition]
// in the Amazon Quick Sight User Guide. For more information about using Active
// Directory in Amazon Quick Sight, see [Using Active Directory with Amazon Quick Sight Enterprise Edition]in the Amazon Quick Sight User Guide.
//
// [Using Active Directory with Amazon Quick Sight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
// [Using IAM Identity Center with Amazon Quick Sight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
AuthorGroup []string
// The author pro group associated with your Active Directory or IAM Identity
// Center account.
//
// For more information about using IAM Identity Center in Amazon Quick Sight, see [Using IAM Identity Center with Amazon Quick Sight Enterprise Edition]
// in the Amazon Quick Sight User Guide. For more information about using Active
// Directory in Amazon Quick Sight, see [Using Active Directory with Amazon Quick Sight Enterprise Edition]in the Amazon Quick Sight User Guide.
//
// [Using Active Directory with Amazon Quick Sight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
// [Using IAM Identity Center with Amazon Quick Sight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
AuthorProGroup []string
// A 10-digit phone number for the author of the Amazon Quick Sight account to use
// for future communications. This field is required if ENTERPPRISE_AND_Q is the
// selected edition of the new Amazon Quick Sight account.
ContactNumber *string
// The ID of the Active Directory that is associated with your Quick Sight account.
DirectoryId *string
// The edition of Amazon Quick Sight that you want your account to have.
// Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q .
//
// If you choose ENTERPRISE_AND_Q , the following parameters are required:
//
// - FirstName
//
// - LastName
//
// - EmailAddress
//
// - ContactNumber
Edition types.Edition
// The email address of the author of the Amazon Quick Sight account to use for
// future communications. This field is required if ENTERPPRISE_AND_Q is the
// selected edition of the new Amazon Quick Sight account.
EmailAddress *string
// The first name of the author of the Amazon Quick Sight account to use for
// future communications. This field is required if ENTERPPRISE_AND_Q is the
// selected edition of the new Amazon Quick Sight account.
FirstName *string
// The Amazon Resource Name (ARN) for the IAM Identity Center instance.
IAMIdentityCenterInstanceArn *string
// The last name of the author of the Amazon Quick Sight account to use for future
// communications. This field is required if ENTERPPRISE_AND_Q is the selected
// edition of the new Amazon Quick Sight account.
LastName *string
// The reader group associated with your Active Directory or IAM Identity Center
// account.
//
// For more information about using IAM Identity Center in Amazon Quick Sight, see [Using IAM Identity Center with Amazon Quick Sight Enterprise Edition]
// in the Amazon Quick Sight User Guide. For more information about using Active
// Directory in Amazon Quick Sight, see [Using Active Directory with Amazon Quick Sight Enterprise Edition]in the Amazon Quick Sight User Guide.
//
// [Using Active Directory with Amazon Quick Sight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
// [Using IAM Identity Center with Amazon Quick Sight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
ReaderGroup []string
// The reader pro group associated with your Active Directory or IAM Identity
// Center account.
//
// For more information about using IAM Identity Center in Amazon Quick Sight, see [Using IAM Identity Center with Amazon Quick Sight Enterprise Edition]
// in the Amazon Quick Sight User Guide. For more information about using Active
// Directory in Amazon Quick Sight, see [Using Active Directory with Amazon Quick Sight Enterprise Edition]in the Amazon Quick Sight User Guide.
//
// [Using Active Directory with Amazon Quick Sight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html
// [Using IAM Identity Center with Amazon Quick Sight Enterprise Edition]: https://docs.aws.amazon.com/quicksight/latest/user/sec-identity-management-identity-center.html
ReaderProGroup []string
// The realm of the Active Directory that is associated with your Quick Sight
// account. This field is required if ACTIVE_DIRECTORY is the selected
// authentication method of the new Quick Sight account.
Realm *string
// contains filtered or unexported fields
}
func (*CreateAccountSubscriptionInput) Serialize ¶ added in v1.131.0
func (v *CreateAccountSubscriptionInput) Serialize(s smithy.ShapeSerializer)
func (*CreateAccountSubscriptionInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateAccountSubscriptionInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateAccountSubscriptionOutput ¶ added in v1.23.0
type CreateAccountSubscriptionOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// A SignupResponse object that returns information about a newly created Quick
// Sight account.
SignupResponse *types.SignupResponse
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateAccountSubscriptionOutput) Deserialize ¶ added in v1.131.0
func (v *CreateAccountSubscriptionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateAccountSubscriptionOutput) Serialize ¶ added in v1.131.0
func (v *CreateAccountSubscriptionOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateAccountSubscriptionOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateAccountSubscriptionOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateActionConnectorInput ¶ added in v1.95.0
type CreateActionConnectorInput struct {
// A unique identifier for the action connector. This ID must be unique within the
// Amazon Web Services account. The ActionConnectorId must not start with the
// prefix quicksuite-
//
// This member is required.
ActionConnectorId *string
// The authentication configuration for connecting to the external service. This
// includes the authentication type, base URL, and authentication metadata such as
// client credentials or API keys.
//
// This member is required.
AuthenticationConfig *types.AuthConfig
// The Amazon Web Services account ID associated with the action connector.
//
// This member is required.
AwsAccountId *string
// A descriptive name for the action connector.
//
// This member is required.
Name *string
// The type of action connector.
//
// This member is required.
Type types.ActionConnectorType
// An optional description of the action connector.
Description *string
// The permissions configuration that defines which users, groups, or namespaces
// can access this action connector and what operations they can perform.
Permissions []types.ResourcePermission
// A list of tags to apply to the action connector for resource management and
// organization.
Tags []types.Tag
// The ARN of the VPC connection to use for secure connectivity to the external
// service.
VpcConnectionArn *string
// contains filtered or unexported fields
}
func (*CreateActionConnectorInput) Serialize ¶ added in v1.131.0
func (v *CreateActionConnectorInput) Serialize(s smithy.ShapeSerializer)
func (*CreateActionConnectorInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateActionConnectorInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateActionConnectorOutput ¶ added in v1.95.0
type CreateActionConnectorOutput struct {
// The unique identifier of the created action connector.
ActionConnectorId *string
// The Amazon Resource Name (ARN) of the created action connector.
Arn *string
// The creation status of the action connector.
CreationStatus types.ResourceStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status code of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateActionConnectorOutput) Deserialize ¶ added in v1.131.0
func (v *CreateActionConnectorOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateActionConnectorOutput) Serialize ¶ added in v1.131.0
func (v *CreateActionConnectorOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateActionConnectorOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateActionConnectorOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateAgentInput ¶ added in v1.113.0
type CreateAgentInput struct {
// A unique identifier for the agent.
//
// This member is required.
AgentId *string
// The ID of the Amazon Web Services account that contains the agent.
//
// This member is required.
AwsAccountId *string
// The name of the agent.
//
// This member is required.
Name *string
// The Amazon Resource Names (ARNs) of the action connectors to attach to the
// agent.
ActionConnectors []string
// The lifecycle state of the agent. Valid values are PREVIEW and PUBLISHED .
AgentLifecycle types.AgentLifecycle
// The custom prompt configuration for the agent.
CustomPromptInput types.CustomPromptInput
// A description of the agent.
Description *string
// The icon identifier for the agent.
IconId *string
// The Amazon Resource Names (ARNs) of the spaces to attach to the agent.
Spaces []string
// A list of starter prompts that are displayed to users when they begin
// interacting with the agent.
StarterPrompts []string
// The welcome message that is displayed when a user starts a conversation with
// the agent.
WelcomeMessage *string
// contains filtered or unexported fields
}
func (*CreateAgentInput) Serialize ¶ added in v1.131.0
func (v *CreateAgentInput) Serialize(s smithy.ShapeSerializer)
func (*CreateAgentInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateAgentInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateAgentOutput ¶ added in v1.113.0
type CreateAgentOutput struct {
// The unique identifier for the agent.
//
// This member is required.
AgentId *string
// The name of the agent.
//
// This member is required.
AgentName *string
// The status of the agent.
//
// This member is required.
AgentStatus types.AgentStatus
// The Amazon Resource Name (ARN) of the agent.
//
// This member is required.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateAgentOutput) Deserialize ¶ added in v1.131.0
func (v *CreateAgentOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateAgentOutput) Serialize ¶ added in v1.131.0
func (v *CreateAgentOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateAgentOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateAgentOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateAnalysisInput ¶ added in v0.29.0
type CreateAnalysisInput struct {
// The ID for the analysis that you're creating. This ID displays in the URL of
// the analysis.
//
// This member is required.
AnalysisId *string
// The ID of the Amazon Web Services account where you are creating an analysis.
//
// This member is required.
AwsAccountId *string
// A descriptive name for the analysis that you're creating. This name displays
// for the analysis in the Amazon Quick Sight console.
//
// This member is required.
Name *string
// The definition of an analysis.
//
// A definition is the data model of all features in a Dashboard, Template, or
// Analysis.
//
// Either a SourceEntity or a Definition must be provided in order for the request
// to be valid.
Definition *types.AnalysisDefinition
// When you create the analysis, Amazon Quick Sight adds the analysis to these
// folders.
FolderArns []string
// The parameter names and override values that you want to use. An analysis can
// have any parameter type, and some parameters might accept multiple values.
Parameters *types.Parameters
// A structure that describes the principals and the resource-level permissions on
// an analysis. You can use the Permissions structure to grant permissions by
// providing a list of Identity and Access Management (IAM) action information for
// each principal listed by Amazon Resource Name (ARN).
//
// To specify no permissions, omit Permissions .
Permissions []types.ResourcePermission
// A source entity to use for the analysis that you're creating. This metadata
// structure contains details that describe a source template and one or more
// datasets or topics.
//
// Either a SourceEntity or a Definition must be provided in order for the request
// to be valid.
SourceEntity *types.AnalysisSourceEntity
// Contains a map of the key-value pairs for the resource tag or tags assigned to
// the analysis.
Tags []types.Tag
// The ARN for the theme to apply to the analysis that you're creating. To see the
// theme in the Amazon Quick Sight console, make sure that you have access to it.
ThemeArn *string
// The option to relax the validation needed to create an analysis with definition
// objects. This skips the validation step for specific errors.
ValidationStrategy *types.ValidationStrategy
// contains filtered or unexported fields
}
func (*CreateAnalysisInput) Serialize ¶ added in v1.131.0
func (v *CreateAnalysisInput) Serialize(s smithy.ShapeSerializer)
func (*CreateAnalysisInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateAnalysisInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateAnalysisOutput ¶ added in v0.29.0
type CreateAnalysisOutput struct {
// The ID of the analysis.
AnalysisId *string
// The ARN for the analysis.
Arn *string
// The status of the creation of the analysis.
CreationStatus types.ResourceStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateAnalysisOutput) Deserialize ¶ added in v1.131.0
func (v *CreateAnalysisOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateAnalysisOutput) Serialize ¶ added in v1.131.0
func (v *CreateAnalysisOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateAnalysisOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateAnalysisOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateApprovalPolicyInput ¶ added in v1.124.0
type CreateApprovalPolicyInput struct {
// The list of governed actions that trigger the approval workflow.
//
// This member is required.
Actions []types.GovernedAction
// The scoping configuration that determines who the approval policy applies to.
//
// This member is required.
ApplicableTo *types.ApplicableTo
// The list of group ARNs whose members can approve requests.
//
// This member is required.
ApprovalGroups []string
// The list of asset types that the approval policy applies to.
//
// This member is required.
AssetTypes []types.AssetType
// The name of the approval policy.
//
// This member is required.
Name *string
// The unique identifier to assign to the approval policy. You cannot change this
// value after you create the policy.
//
// This member is required.
PolicyId *string
// A description of the approval policy.
Description *string
// contains filtered or unexported fields
}
func (*CreateApprovalPolicyInput) Serialize ¶ added in v1.131.0
func (v *CreateApprovalPolicyInput) Serialize(s smithy.ShapeSerializer)
func (*CreateApprovalPolicyInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateApprovalPolicyInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateApprovalPolicyOutput ¶ added in v1.124.0
type CreateApprovalPolicyOutput struct {
// The approval policy that was created.
//
// This member is required.
Policy *types.ApprovalPolicy
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateApprovalPolicyOutput) Deserialize ¶ added in v1.131.0
func (v *CreateApprovalPolicyOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateApprovalPolicyOutput) Serialize ¶ added in v1.131.0
func (v *CreateApprovalPolicyOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateApprovalPolicyOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateApprovalPolicyOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateBrandInput ¶ added in v1.79.0
type CreateBrandInput struct {
// The ID of the Amazon Web Services account that owns the brand.
//
// This member is required.
AwsAccountId *string
// The ID of the Quick brand.
//
// This member is required.
BrandId *string
// The definition of the brand.
BrandDefinition *types.BrandDefinition
// A map of the key-value pairs that are assigned to the brand.
Tags []types.Tag
// contains filtered or unexported fields
}
func (*CreateBrandInput) Serialize ¶ added in v1.131.0
func (v *CreateBrandInput) Serialize(s smithy.ShapeSerializer)
func (*CreateBrandInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateBrandInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateBrandOutput ¶ added in v1.79.0
type CreateBrandOutput struct {
// The definition of the brand.
BrandDefinition *types.BrandDefinition
// The details of the brand.
BrandDetail *types.BrandDetail
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateBrandOutput) Deserialize ¶ added in v1.131.0
func (v *CreateBrandOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateBrandOutput) Serialize ¶ added in v1.131.0
func (v *CreateBrandOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateBrandOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateBrandOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateCustomPermissionsInput ¶ added in v1.79.0
type CreateCustomPermissionsInput struct {
// The ID of the Amazon Web Services account that you want to create the custom
// permissions profile in.
//
// This member is required.
AwsAccountId *string
// The name of the custom permissions profile that you want to create.
//
// This member is required.
CustomPermissionsName *string
// A set of actions to include in the custom permissions profile.
Capabilities *types.Capabilities
// The governance configuration for the custom permissions profile. When
// governance controls are defined for a category, any capabilities in that
// category not explicitly set to ALLOW in Capabilities are denied. Even newly
// added capabilities in the category are implicitly disabled when Amazon Quick
// releases them.
Governance *types.Governance
// The tags to associate with the custom permissions profile.
Tags []types.Tag
// contains filtered or unexported fields
}
func (*CreateCustomPermissionsInput) Serialize ¶ added in v1.131.0
func (v *CreateCustomPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*CreateCustomPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateCustomPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateCustomPermissionsOutput ¶ added in v1.79.0
type CreateCustomPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the custom permissions profile.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateCustomPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *CreateCustomPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateCustomPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *CreateCustomPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateCustomPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateCustomPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateDashboardInput ¶
type CreateDashboardInput struct {
// The ID of the Amazon Web Services account where you want to create the
// dashboard.
//
// This member is required.
AwsAccountId *string
// The ID for the dashboard, also added to the IAM policy.
//
// This member is required.
DashboardId *string
// The display name of the dashboard.
//
// This member is required.
Name *string
// Options for publishing the dashboard when you create it:
//
// - AvailabilityStatus for AdHocFilteringOption - This status can be either
// ENABLED or DISABLED . When this is set to DISABLED , Amazon Quick Sight
// disables the left filter pane on the published dashboard, which can be used for
// ad hoc (one-time) filtering. This option is ENABLED by default.
//
// - AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED
// or DISABLED . The visual option to export data to .CSV format isn't enabled
// when this is set to DISABLED . This option is ENABLED by default.
//
// - VisibilityState for SheetControlsOption - This visibility state can be
// either COLLAPSED or EXPANDED . This option is COLLAPSED by default.
//
// - AvailabilityStatus for QuickSuiteActionsOption - This status can be either
// ENABLED or DISABLED . Features related to Actions in Amazon Quick Suite on
// dashboards are disabled when this is set to DISABLED . This option is DISABLED
// by default.
//
// - AvailabilityStatus for ExecutiveSummaryOption - This status can be either
// ENABLED or DISABLED . The option to build an executive summary is disabled
// when this is set to DISABLED . This option is ENABLED by default.
//
// - AvailabilityStatus for DataStoriesSharingOption - This status can be either
// ENABLED or DISABLED . The option to share a data story is disabled when this
// is set to DISABLED . This option is ENABLED by default.
DashboardPublishOptions *types.DashboardPublishOptions
// The definition of a dashboard.
//
// A definition is the data model of all features in a Dashboard, Template, or
// Analysis.
//
// Either a SourceEntity or a Definition must be provided in order for the request
// to be valid.
Definition *types.DashboardVersionDefinition
// When you create the dashboard, Amazon Quick Sight adds the dashboard to these
// folders.
FolderArns []string
// A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
LinkEntities []string
// A structure that contains the permissions of a shareable link to the dashboard.
LinkSharingConfiguration *types.LinkSharingConfiguration
// The parameters for the creation of the dashboard, which you want to use to
// override the default settings. A dashboard can have any type of parameters, and
// some parameters might accept multiple values.
Parameters *types.Parameters
// A structure that contains the permissions of the dashboard. You can use this
// structure for granting permissions by providing a list of IAM action information
// for each principal ARN.
//
// To specify no permissions, omit the permissions list.
Permissions []types.ResourcePermission
// The entity that you are using as a source when you create the dashboard. In
// SourceEntity , you specify the type of object you're using as source. You can
// only create a dashboard from a template, so you use a SourceTemplate entity. If
// you need to create a dashboard from an analysis, first convert the analysis to a
// template by using the [CreateTemplate]API operation. For SourceTemplate , specify the Amazon
// Resource Name (ARN) of the source template. The SourceTemplate ARN can contain
// any Amazon Web Services account and any Amazon Quick Sight-supported Amazon Web
// Services Region.
//
// Use the DataSetReferences entity within SourceTemplate to list the replacement
// datasets for the placeholders listed in the original. The schema in each dataset
// must match its placeholder. Use the TopicReferences entity to list the
// replacement topics for the topic placeholders listed in the original. The schema
// in each topic must match its placeholder.
//
// Either a SourceEntity or a Definition must be provided in order for the request
// to be valid.
//
// [CreateTemplate]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html
SourceEntity *types.DashboardSourceEntity
// Contains a map of the key-value pairs for the resource tag or tags assigned to
// the dashboard.
Tags []types.Tag
// The Amazon Resource Name (ARN) of the theme that is being used for this
// dashboard. If you add a value for this field, it overrides the value that is
// used in the source entity. The theme ARN must exist in the same Amazon Web
// Services account where you create the dashboard.
ThemeArn *string
// The option to relax the validation needed to create a dashboard with definition
// objects. This option skips the validation step for specific errors.
ValidationStrategy *types.ValidationStrategy
// A description for the first version of the dashboard being created.
VersionDescription *string
// contains filtered or unexported fields
}
func (*CreateDashboardInput) Serialize ¶ added in v1.131.0
func (v *CreateDashboardInput) Serialize(s smithy.ShapeSerializer)
func (*CreateDashboardInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateDashboardInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateDashboardOutput ¶
type CreateDashboardOutput struct {
// The ARN of the dashboard.
Arn *string
// The status of the dashboard creation request.
CreationStatus types.ResourceStatus
// The ID for the dashboard.
DashboardId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ARN of the dashboard, including the version number of the first version
// that is created.
VersionArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateDashboardOutput) Deserialize ¶ added in v1.131.0
func (v *CreateDashboardOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateDashboardOutput) Serialize ¶ added in v1.131.0
func (v *CreateDashboardOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateDashboardOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateDashboardOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateDataSetInput ¶
type CreateDataSetInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// An ID for the dataset that you want to create. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
//
// This member is required.
DataSetId *string
// Indicates whether you want to import the data into SPICE.
//
// This member is required.
ImportMode types.DataSetImportMode
// The display name for the dataset.
//
// This member is required.
Name *string
// Declares the physical tables that are available in the underlying data sources.
//
// This member is required.
PhysicalTableMap map[string]types.PhysicalTable
// Groupings of columns that work together in certain Amazon Quick Sight features.
// Currently, only geospatial hierarchy is supported.
ColumnGroups []types.ColumnGroup
// A set of one or more definitions of a [ColumnLevelPermissionRule].
//
// [ColumnLevelPermissionRule]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html
ColumnLevelPermissionRules []types.ColumnLevelPermissionRule
// The data preparation configuration for the dataset. This configuration defines
// the source tables, transformation steps, and destination tables used to prepare
// the data. Required when using the new data preparation experience.
DataPrepConfiguration *types.DataPrepConfiguration
// The usage configuration to apply to child datasets that reference this dataset
// as a source.
DataSetUsageConfiguration *types.DataSetUsageConfiguration
// The parameter declarations of the dataset.
DatasetParameters []types.DatasetParameter
// The folder that contains fields and nested subfolders for your dataset.
FieldFolders map[string]types.FieldFolder
// When you create the dataset, Amazon Quick Sight adds the dataset to these
// folders.
FolderArns []string
// Configures the combination and transformation of the data from the physical
// tables. This parameter is used with the legacy data preparation experience.
//
// Deprecated: Only used in the legacy data preparation experience.
LogicalTableMap map[string]types.LogicalTable
// The configuration for the performance optimization of the dataset that contains
// a UniqueKey configuration.
PerformanceConfiguration *types.PerformanceConfiguration
// A list of resource permissions on the dataset.
Permissions []types.ResourcePermission
// The row-level security configuration for the data that you want to create. This
// parameter is used with the legacy data preparation experience.
//
// Deprecated: Only used in the legacy data preparation experience.
RowLevelPermissionDataSet *types.RowLevelPermissionDataSet
// The configuration of tags on a dataset to set row-level security. Row-level
// security tags are currently supported for anonymous embedding only. This
// parameter is used with the legacy data preparation experience.
//
// Deprecated: Only used in the legacy data preparation experience.
RowLevelPermissionTagConfiguration *types.RowLevelPermissionTagConfiguration
// The semantic model configuration for the dataset. This configuration defines
// how the prepared data is structured for an analysis, including table mappings
// and row-level security configurations. Required when using the new data
// preparation experience.
SemanticModelConfiguration *types.SemanticModelConfiguration
// Contains a map of the key-value pairs for the resource tag or tags assigned to
// the dataset.
Tags []types.Tag
// The usage of the dataset. RLS_RULES must be specified for RLS permission
// datasets.
UseAs types.DataSetUseAs
// contains filtered or unexported fields
}
func (*CreateDataSetInput) Serialize ¶ added in v1.131.0
func (v *CreateDataSetInput) Serialize(s smithy.ShapeSerializer)
func (*CreateDataSetInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateDataSetInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateDataSetOutput ¶
type CreateDataSetOutput struct {
// The Amazon Resource Name (ARN) of the dataset.
Arn *string
// The ID for the dataset that you want to create. This ID is unique per Amazon
// Web Services Region for each Amazon Web Services account.
DataSetId *string
// The ARN for the ingestion, which is triggered as a result of dataset creation
// if the import mode is SPICE.
IngestionArn *string
// The ID of the ingestion, which is triggered as a result of dataset creation if
// the import mode is SPICE.
IngestionId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateDataSetOutput) Deserialize ¶ added in v1.131.0
func (v *CreateDataSetOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateDataSetOutput) Serialize ¶ added in v1.131.0
func (v *CreateDataSetOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateDataSetOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateDataSetOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateDataSourceInput ¶
type CreateDataSourceInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// An ID for the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
//
// This member is required.
DataSourceId *string
// A display name for the data source.
//
// This member is required.
Name *string
// The type of the data source. To return a list of all data sources, use
// ListDataSources .
//
// Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
//
// This member is required.
Type types.DataSourceType
// The credentials Amazon Quick Sight that uses to connect to your underlying
// source. Currently, only credentials based on user name and password are
// supported.
Credentials *types.DataSourceCredentials
// The parameters that Amazon Quick Sight uses to connect to your underlying
// source.
DataSourceParameters types.DataSourceParameters
// When you create the data source, Amazon Quick Sight adds the data source to
// these folders.
FolderArns []string
// A list of resource permissions on the data source.
Permissions []types.ResourcePermission
// Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight
// connects to your underlying source.
SslProperties *types.SslProperties
// Contains a map of the key-value pairs for the resource tag or tags assigned to
// the data source.
Tags []types.Tag
// Use this parameter only when you want Amazon Quick Sight to use a VPC
// connection when connecting to your underlying source.
VpcConnectionProperties *types.VpcConnectionProperties
// contains filtered or unexported fields
}
func (*CreateDataSourceInput) Serialize ¶ added in v1.131.0
func (v *CreateDataSourceInput) Serialize(s smithy.ShapeSerializer)
func (*CreateDataSourceInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateDataSourceInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateDataSourceOutput ¶
type CreateDataSourceOutput struct {
// The Amazon Resource Name (ARN) of the data source.
Arn *string
// The status of creating the data source.
CreationStatus types.ResourceStatus
// The ID of the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
DataSourceId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateDataSourceOutput) Deserialize ¶ added in v1.131.0
func (v *CreateDataSourceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateDataSourceOutput) Serialize ¶ added in v1.131.0
func (v *CreateDataSourceOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateDataSourceOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateDataSourceOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateDlpSettingInput ¶ added in v1.124.0
type CreateDlpSettingInput struct {
// The ID of the Amazon Web Services account in which to create the DLP setting.
//
// This member is required.
AwsAccountId *string
// A unique identifier for the DLP setting.
//
// This member is required.
DlpSettingId *string
// Specifies whether DLP enforcement is active for this setting. Set to true to
// enable enforcement, or false to disable it at time of setting creation.
//
// This member is required.
Enabled bool
// A human-readable display name for the DLP setting.
//
// This member is required.
Name *string
// The provider-specific configuration for the DLP integration. This is a union
// type structure. For this structure to be valid, only one of the attributes can
// be defined.
//
// This member is required.
ProviderConfig types.ProviderConfig
// The behavior to apply when the DLP provider is unreachable. Valid values are
// ALLOW , WARN , and BLOCK .
//
// This member is required.
ProviderOutageAction types.DlpAction
// The type of external DLP provider to use for sensitivity label classification.
// Currently, the only supported value is MICROSOFT_PURVIEW .
//
// This member is required.
ProviderType types.DlpProviderType
// A list of resource tags to apply to the DLP setting. You can use tags to manage
// access to your Amazon Web Services resources.
Tags []types.Tag
// contains filtered or unexported fields
}
func (*CreateDlpSettingInput) Serialize ¶ added in v1.131.0
func (v *CreateDlpSettingInput) Serialize(s smithy.ShapeSerializer)
func (*CreateDlpSettingInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateDlpSettingInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateDlpSettingOutput ¶ added in v1.124.0
type CreateDlpSettingOutput struct {
// The Amazon Resource Name (ARN) of the created DLP setting.
//
// This member is required.
Arn *string
// The ID of the created DLP setting.
//
// This member is required.
DlpSettingId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateDlpSettingOutput) Deserialize ¶ added in v1.131.0
func (v *CreateDlpSettingOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateDlpSettingOutput) Serialize ¶ added in v1.131.0
func (v *CreateDlpSettingOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateDlpSettingOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateDlpSettingOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateFlowInput ¶ added in v1.113.0
type CreateFlowInput struct {
// The ID of the Amazon Web Services account where you want to create the flow.
//
// This member is required.
AwsAccountId *string
// 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.
//
// Always derive or depend on the flow definition from the DescribeFlow operation
// to ensure you are working with the latest format.
//
// This member is required.
FlowDefinition document.Interface
// The display name for the flow.
//
// This member is required.
Name *string
// A unique, case-sensitive identifier that you provide to ensure the idempotency
// of the request.
ClientToken *string
// The description for the flow.
Description *string
// Initial permissions for the flow. If omitted, the flow is created without any
// permissions.
Permissions []types.Permission
// contains filtered or unexported fields
}
func (*CreateFlowInput) Serialize ¶ added in v1.131.0
func (v *CreateFlowInput) Serialize(s smithy.ShapeSerializer)
func (*CreateFlowInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateFlowInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateFlowOutput ¶ added in v1.113.0
type CreateFlowOutput struct {
// The Amazon Resource Name (ARN) of the flow.
//
// This member is required.
Arn *string
// The unique identifier of the flow.
//
// This member is required.
FlowId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateFlowOutput) Deserialize ¶ added in v1.131.0
func (v *CreateFlowOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateFlowOutput) Serialize ¶ added in v1.131.0
func (v *CreateFlowOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateFlowOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateFlowOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateFolderInput ¶ added in v1.6.0
type CreateFolderInput struct {
// The ID for the Amazon Web Services account where you want to create the folder.
//
// This member is required.
AwsAccountId *string
// The ID of the folder.
//
// This member is required.
FolderId *string
// The type of folder. By default, folderType is SHARED .
FolderType types.FolderType
// The name of the folder.
Name *string
// The Amazon Resource Name (ARN) for the parent folder.
//
// ParentFolderArn can be null. An empty parentFolderArn creates a root-level
// folder.
ParentFolderArn *string
// A structure that describes the principals and the resource-level permissions of
// a folder.
//
// To specify no permissions, omit Permissions .
Permissions []types.ResourcePermission
// An optional parameter that determines the sharing scope of the folder. The
// default value for this parameter is ACCOUNT .
SharingModel types.SharingModel
// Tags for the folder.
Tags []types.Tag
// contains filtered or unexported fields
}
func (*CreateFolderInput) Serialize ¶ added in v1.131.0
func (v *CreateFolderInput) Serialize(s smithy.ShapeSerializer)
func (*CreateFolderInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateFolderInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateFolderMembershipInput ¶ added in v1.6.0
type CreateFolderMembershipInput struct {
// The ID for the Amazon Web Services account that contains the folder.
//
// This member is required.
AwsAccountId *string
// The ID of the folder.
//
// This member is required.
FolderId *string
// The ID of the asset that you want to add to the folder.
//
// This member is required.
MemberId *string
// The member type of the asset that you want to add to a folder.
//
// This member is required.
MemberType types.MemberType
// contains filtered or unexported fields
}
func (*CreateFolderMembershipInput) Serialize ¶ added in v1.131.0
func (v *CreateFolderMembershipInput) Serialize(s smithy.ShapeSerializer)
func (*CreateFolderMembershipInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateFolderMembershipInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateFolderMembershipOutput ¶ added in v1.6.0
type CreateFolderMembershipOutput struct {
// Information about the member in the folder.
FolderMember *types.FolderMember
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateFolderMembershipOutput) Deserialize ¶ added in v1.131.0
func (v *CreateFolderMembershipOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateFolderMembershipOutput) Serialize ¶ added in v1.131.0
func (v *CreateFolderMembershipOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateFolderMembershipOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateFolderMembershipOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateFolderOutput ¶ added in v1.6.0
type CreateFolderOutput struct {
// The Amazon Resource Name (ARN) for the newly created folder.
Arn *string
// The folder ID for the newly created folder.
FolderId *string
// The request ID for the newly created folder.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateFolderOutput) Deserialize ¶ added in v1.131.0
func (v *CreateFolderOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateFolderOutput) Serialize ¶ added in v1.131.0
func (v *CreateFolderOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateFolderOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateFolderOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateGroupInput ¶
type CreateGroupInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// A name for the group that you want to create.
//
// This member is required.
GroupName *string
// The namespace that you want the group to be a part of.
//
// This member is required.
Namespace *string
// A description for the group that you want to create.
Description *string
// contains filtered or unexported fields
}
The request object for this operation.
func (*CreateGroupInput) Serialize ¶ added in v1.131.0
func (v *CreateGroupInput) Serialize(s smithy.ShapeSerializer)
func (*CreateGroupInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateGroupInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateGroupMembershipInput ¶
type CreateGroupMembershipInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The name of the group that you want to add the user to.
//
// This member is required.
GroupName *string
// The name of the user that you want to add to the group membership.
//
// This member is required.
MemberName *string
// The namespace that you want the user to be a part of.
//
// This member is required.
Namespace *string
// contains filtered or unexported fields
}
func (*CreateGroupMembershipInput) Serialize ¶ added in v1.131.0
func (v *CreateGroupMembershipInput) Serialize(s smithy.ShapeSerializer)
func (*CreateGroupMembershipInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateGroupMembershipInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateGroupMembershipOutput ¶
type CreateGroupMembershipOutput struct {
// The group member.
GroupMember *types.GroupMember
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateGroupMembershipOutput) Deserialize ¶ added in v1.131.0
func (v *CreateGroupMembershipOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateGroupMembershipOutput) Serialize ¶ added in v1.131.0
func (v *CreateGroupMembershipOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateGroupMembershipOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateGroupMembershipOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateGroupOutput ¶
type CreateGroupOutput struct {
// The name of the group.
Group *types.Group
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
The response object for this operation.
func (*CreateGroupOutput) Deserialize ¶ added in v1.131.0
func (v *CreateGroupOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateGroupOutput) Serialize ¶ added in v1.131.0
func (v *CreateGroupOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateGroupOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateGroupOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateIAMPolicyAssignmentInput ¶
type CreateIAMPolicyAssignmentInput struct {
// The name of the assignment, also called a rule. The name must be unique within
// the Amazon Web Services account.
//
// This member is required.
AssignmentName *string
// The status of the assignment. Possible values are as follows:
//
// - ENABLED - Anything specified in this assignment is used when creating the
// data source.
//
// - DISABLED - This assignment isn't used when creating the data source.
//
// - DRAFT - This assignment is an unfinished draft and isn't used when creating
// the data source.
//
// This member is required.
AssignmentStatus types.AssignmentStatus
// The ID of the Amazon Web Services account where you want to assign an IAM
// policy to Amazon Quick Sight users or groups.
//
// This member is required.
AwsAccountId *string
// The namespace that contains the assignment.
//
// This member is required.
Namespace *string
// The Amazon Quick Sight users, groups, or both that you want to assign the
// policy to.
Identities map[string][]string
// The ARN for the IAM policy to apply to the Amazon Quick Sight users and groups
// specified in this assignment.
PolicyArn *string
// contains filtered or unexported fields
}
func (*CreateIAMPolicyAssignmentInput) Serialize ¶ added in v1.131.0
func (v *CreateIAMPolicyAssignmentInput) Serialize(s smithy.ShapeSerializer)
func (*CreateIAMPolicyAssignmentInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateIAMPolicyAssignmentInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateIAMPolicyAssignmentOutput ¶
type CreateIAMPolicyAssignmentOutput struct {
// The ID for the assignment.
AssignmentId *string
// The name of the assignment. The name must be unique within the Amazon Web
// Services account.
AssignmentName *string
// The status of the assignment. Possible values are as follows:
//
// - ENABLED - Anything specified in this assignment is used when creating the
// data source.
//
// - DISABLED - This assignment isn't used when creating the data source.
//
// - DRAFT - This assignment is an unfinished draft and isn't used when creating
// the data source.
AssignmentStatus types.AssignmentStatus
// The Amazon Quick Sight users, groups, or both that the IAM policy is assigned
// to.
Identities map[string][]string
// The ARN for the IAM policy that is applied to the Amazon Quick Sight users and
// groups specified in this assignment.
PolicyArn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateIAMPolicyAssignmentOutput) Deserialize ¶ added in v1.131.0
func (v *CreateIAMPolicyAssignmentOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateIAMPolicyAssignmentOutput) Serialize ¶ added in v1.131.0
func (v *CreateIAMPolicyAssignmentOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateIAMPolicyAssignmentOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateIAMPolicyAssignmentOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateIngestionInput ¶
type CreateIngestionInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset used in the ingestion.
//
// This member is required.
DataSetId *string
// An ID for the ingestion.
//
// This member is required.
IngestionId *string
// The type of ingestion that you want to create.
IngestionType types.IngestionType
// contains filtered or unexported fields
}
func (*CreateIngestionInput) Serialize ¶ added in v1.131.0
func (v *CreateIngestionInput) Serialize(s smithy.ShapeSerializer)
func (*CreateIngestionInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateIngestionInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateIngestionOutput ¶
type CreateIngestionOutput struct {
// The Amazon Resource Name (ARN) for the data ingestion.
Arn *string
// An ID for the ingestion.
IngestionId *string
// The ingestion status.
IngestionStatus types.IngestionStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateIngestionOutput) Deserialize ¶ added in v1.131.0
func (v *CreateIngestionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateIngestionOutput) Serialize ¶ added in v1.131.0
func (v *CreateIngestionOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateIngestionOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateIngestionOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateKnowledgeBaseInput ¶ added in v1.118.0
type CreateKnowledgeBaseInput struct {
// The ID of the Amazon Web Services account that contains the knowledge base.
//
// This member is required.
AwsAccountId *string
// The Amazon Resource Name (ARN) of the data source for the knowledge base.
//
// This member is required.
DataSourceArn *string
// The configuration settings for a knowledge base.
//
// This member is required.
KnowledgeBaseConfiguration *types.KnowledgeBaseConfiguration
// The unique identifier for the knowledge base.
//
// This member is required.
KnowledgeBaseId *string
// The name of the knowledge base.
//
// This member is required.
Name *string
// The access control configuration for the knowledge base. If you don't specify
// this parameter, document-level ACLs are disabled.
AccessControlConfiguration *types.AccessControlConfiguration
// A description for the knowledge base. If you don't specify a description, the
// knowledge base is created without one.
Description *string
// The configuration for media extraction from knowledge base documents.
MediaExtractionConfiguration *types.MediaExtractionConfiguration
// A list of resource permissions on the knowledge base. Each entry grants a
// specified Amazon QuickSight principal either owner or viewer access. If you
// don't specify permissions, only the primary owner (if provided) receives owner
// access.
Permissions []types.ResourcePermission
// The Amazon Resource Name (ARN) of the Amazon QuickSight user or group to set as
// the primary owner of the knowledge base. The specified principal is always
// granted owner access, regardless of what is specified in the Permissions field.
//
// This must be an Amazon QuickSight principal ARN, not an IAM user or role ARN.
// The API caller is never assigned as the owner automatically. If you don't
// specify a primary owner and don't grant owner access in Permissions , the
// knowledge base is created without an owner, even when you call the operation as
// an Amazon QuickSight user.
//
// When you call CreateKnowledgeBase as an IAM user or an assumed IAM role,
// specify PrimaryOwnerArn (as an Amazon QuickSight principal ARN) or an owner
// entry in Permissions so that the knowledge base has an owner. Although
// optional, specifying a primary owner is recommended.
PrimaryOwnerArn *string
// The tags to assign to the knowledge base. If you don't specify tags, the
// knowledge base is created without tags.
Tags []types.Tag
// contains filtered or unexported fields
}
func (*CreateKnowledgeBaseInput) Serialize ¶ added in v1.131.0
func (v *CreateKnowledgeBaseInput) Serialize(s smithy.ShapeSerializer)
func (*CreateKnowledgeBaseInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateKnowledgeBaseInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateKnowledgeBaseOutput ¶ added in v1.118.0
type CreateKnowledgeBaseOutput struct {
// The creation status of the knowledge base.
//
// This member is required.
CreationStatus types.DataSetStatus
// The Amazon Resource Name (ARN) of the knowledge base.
//
// This member is required.
KnowledgeBaseArn *string
// The unique identifier for the knowledge base.
//
// This member is required.
KnowledgeBaseId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status *int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateKnowledgeBaseOutput) Deserialize ¶ added in v1.131.0
func (v *CreateKnowledgeBaseOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateKnowledgeBaseOutput) Serialize ¶ added in v1.131.0
func (v *CreateKnowledgeBaseOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateKnowledgeBaseOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateKnowledgeBaseOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateLimitsProfileInput ¶ added in v1.124.0
type CreateLimitsProfileInput struct {
// The ID of the Amazon Web Services account that contains the limits profile.
//
// This member is required.
AccountId *string
// A unique, case-sensitive identifier to ensure that the operation completes no
// more than one time. If this token matches a previous request, the service
// ignores the request, but does not return an error.
//
// This member is required.
ClientToken *string
// A display name for the limits profile.
//
// This member is required.
ProfileName *string
// A map of resource types to their limit values for this profile.
//
// This member is required.
ResourceLimits map[string]types.ProfileLimitValue
// A description for the limits profile.
Description *string
// contains filtered or unexported fields
}
func (*CreateLimitsProfileInput) Serialize ¶ added in v1.131.0
func (v *CreateLimitsProfileInput) Serialize(s smithy.ShapeSerializer)
func (*CreateLimitsProfileInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateLimitsProfileInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateLimitsProfileOutput ¶ added in v1.124.0
type CreateLimitsProfileOutput struct {
// The Amazon Resource Name (ARN) of the created limits profile.
//
// This member is required.
Arn *string
// The unique identifier for the created limits profile.
//
// This member is required.
ProfileId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateLimitsProfileOutput) Deserialize ¶ added in v1.131.0
func (v *CreateLimitsProfileOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateLimitsProfileOutput) Serialize ¶ added in v1.131.0
func (v *CreateLimitsProfileOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateLimitsProfileOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateLimitsProfileOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateNamespaceInput ¶
type CreateNamespaceInput struct {
// The ID for the Amazon Web Services account that you want to create the Quick
// Sight namespace in.
//
// This member is required.
AwsAccountId *string
// Specifies the type of your user identity directory. Currently, this supports
// users with an identity type of QUICKSIGHT .
//
// This member is required.
IdentityStore types.IdentityStore
// The name that you want to use to describe the new namespace.
//
// This member is required.
Namespace *string
// The tags that you want to associate with the namespace that you're creating.
Tags []types.Tag
// contains filtered or unexported fields
}
func (*CreateNamespaceInput) Serialize ¶ added in v1.131.0
func (v *CreateNamespaceInput) Serialize(s smithy.ShapeSerializer)
func (*CreateNamespaceInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateNamespaceInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateNamespaceOutput ¶
type CreateNamespaceOutput struct {
// The ARN of the Quick Sight namespace you created.
Arn *string
// The Amazon Web Services Region; that you want to use for the free SPICE
// capacity for the new namespace. This is set to the region that you run
// CreateNamespace in.
CapacityRegion *string
// The status of the creation of the namespace. This is an asynchronous process. A
// status of CREATED means that your namespace is ready to use. If an error
// occurs, it indicates if the process is retryable or non-retryable . In the case
// of a non-retryable error, refer to the error message for follow-up tasks.
CreationStatus types.NamespaceStatus
// Specifies the type of your user identity directory. Currently, this supports
// users with an identity type of QUICKSIGHT .
IdentityStore types.IdentityStore
// The name of the new namespace that you created.
Name *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateNamespaceOutput) Deserialize ¶ added in v1.131.0
func (v *CreateNamespaceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateNamespaceOutput) Serialize ¶ added in v1.131.0
func (v *CreateNamespaceOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateNamespaceOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateNamespaceOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateOAuthClientApplicationInput ¶ added in v1.112.0
type CreateOAuthClientApplicationInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The client ID of the OAuth application that is registered with the identity
// provider.
//
// This member is required.
ClientId *string
// The client secret of the OAuth application that is registered with the identity
// provider.
//
// This member is required.
ClientSecret *string
// The display name for the OAuthClientApplication.
//
// This member is required.
Name *string
// An ID for the OAuthClientApplication that you want to create. This ID is unique
// per Amazon Web Services Region for each Amazon Web Services account.
//
// This member is required.
OAuthClientApplicationId *string
// The authentication type to use for the OAuthClientApplication. This determines
// the OAuth 2.0 grant flow that is used when the data source connects to the
// identity provider. Valid values are TOKEN .
//
// This member is required.
OAuthClientAuthenticationType types.OAuthClientAuthenticationType
// The token endpoint URL of the identity provider that is used to obtain access
// tokens.
//
// This member is required.
OAuthTokenEndpointUrl *string
// The type of data source that the OAuthClientApplication is used with. Valid
// values are SNOWFLAKE .
DataSourceType types.DataSourceType
// VPC connection properties.
IdentityProviderVpcConnectionProperties *types.VpcConnectionProperties
// The authorization endpoint URL of the identity provider that is used to obtain
// authorization codes.
OAuthAuthorizationEndpointUrl *string
// The OAuth scopes that are requested when the OAuthClientApplication obtains an
// access token from the identity provider.
OAuthScopes *string
// Contains a map of the key-value pairs for the resource tag or tags assigned to
// the OAuthClientApplication.
Tags []types.Tag
// contains filtered or unexported fields
}
func (*CreateOAuthClientApplicationInput) Serialize ¶ added in v1.131.0
func (v *CreateOAuthClientApplicationInput) Serialize(s smithy.ShapeSerializer)
func (*CreateOAuthClientApplicationInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateOAuthClientApplicationInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateOAuthClientApplicationOutput ¶ added in v1.112.0
type CreateOAuthClientApplicationOutput struct {
// The Amazon Resource Name (ARN) of the OAuthClientApplication.
Arn *string
// The status of creating the OAuthClientApplication.
CreationStatus types.ResourceStatus
// The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services
// Region for each Amazon Web Services account.
OAuthClientApplicationId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateOAuthClientApplicationOutput) Deserialize ¶ added in v1.131.0
func (v *CreateOAuthClientApplicationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateOAuthClientApplicationOutput) Serialize ¶ added in v1.131.0
func (v *CreateOAuthClientApplicationOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateOAuthClientApplicationOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateOAuthClientApplicationOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateRefreshScheduleInput ¶ added in v1.34.0
type CreateRefreshScheduleInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset.
//
// This member is required.
DataSetId *string
// The refresh schedule.
//
// This member is required.
Schedule *types.RefreshSchedule
// contains filtered or unexported fields
}
func (*CreateRefreshScheduleInput) Serialize ¶ added in v1.131.0
func (v *CreateRefreshScheduleInput) Serialize(s smithy.ShapeSerializer)
func (*CreateRefreshScheduleInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateRefreshScheduleInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateRefreshScheduleOutput ¶ added in v1.34.0
type CreateRefreshScheduleOutput struct {
// The Amazon Resource Name (ARN) for the refresh schedule.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The ID of the refresh schedule.
ScheduleId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateRefreshScheduleOutput) Deserialize ¶ added in v1.131.0
func (v *CreateRefreshScheduleOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateRefreshScheduleOutput) Serialize ¶ added in v1.131.0
func (v *CreateRefreshScheduleOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateRefreshScheduleOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateRefreshScheduleOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateRoleMembershipInput ¶ added in v1.51.0
type CreateRoleMembershipInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The name of the group that you want to add to the role.
//
// This member is required.
MemberName *string
// The namespace that the role belongs to.
//
// This member is required.
Namespace *string
// The role that you want to add a group to.
//
// This member is required.
Role types.Role
// contains filtered or unexported fields
}
func (*CreateRoleMembershipInput) Serialize ¶ added in v1.131.0
func (v *CreateRoleMembershipInput) Serialize(s smithy.ShapeSerializer)
func (*CreateRoleMembershipInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateRoleMembershipInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateRoleMembershipOutput ¶ added in v1.51.0
type CreateRoleMembershipOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateRoleMembershipOutput) Deserialize ¶ added in v1.131.0
func (v *CreateRoleMembershipOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateRoleMembershipOutput) Serialize ¶ added in v1.131.0
func (v *CreateRoleMembershipOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateRoleMembershipOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateRoleMembershipOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateSpaceInput ¶ added in v1.113.0
type CreateSpaceInput struct {
// The ID of the Amazon Web Services account that contains the space.
//
// This member is required.
AwsAccountId *string
// A display name for the space.
//
// This member is required.
Name *string
// The ID of the space. This ID is unique per Amazon Web Services Region for each
// Amazon Web Services account.
//
// This member is required.
SpaceId *string
// A description of the space.
Description *string
// contains filtered or unexported fields
}
func (*CreateSpaceInput) Serialize ¶ added in v1.131.0
func (v *CreateSpaceInput) Serialize(s smithy.ShapeSerializer)
func (*CreateSpaceInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateSpaceInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateSpaceOutput ¶ added in v1.113.0
type CreateSpaceOutput struct {
// The ID of the space.
//
// This member is required.
SpaceId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The ARN of the space.
SpaceArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateSpaceOutput) Deserialize ¶ added in v1.131.0
func (v *CreateSpaceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateSpaceOutput) Serialize ¶ added in v1.131.0
func (v *CreateSpaceOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateSpaceOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateSpaceOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateTemplateAliasInput ¶
type CreateTemplateAliasInput struct {
// The name that you want to give to the template alias that you're creating.
// Don't start the alias name with the $ character. Alias names that start with $
// are reserved by Quick Sight.
//
// This member is required.
AliasName *string
// The ID of the Amazon Web Services account that contains the template that you
// creating an alias for.
//
// This member is required.
AwsAccountId *string
// An ID for the template.
//
// This member is required.
TemplateId *string
// The version number of the template.
//
// This member is required.
TemplateVersionNumber *int64
// contains filtered or unexported fields
}
func (*CreateTemplateAliasInput) Serialize ¶ added in v1.131.0
func (v *CreateTemplateAliasInput) Serialize(s smithy.ShapeSerializer)
func (*CreateTemplateAliasInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateTemplateAliasInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateTemplateAliasOutput ¶
type CreateTemplateAliasOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Information about the template alias.
TemplateAlias *types.TemplateAlias
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateTemplateAliasOutput) Deserialize ¶ added in v1.131.0
func (v *CreateTemplateAliasOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateTemplateAliasOutput) Serialize ¶ added in v1.131.0
func (v *CreateTemplateAliasOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateTemplateAliasOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateTemplateAliasOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateTemplateInput ¶
type CreateTemplateInput struct {
// The ID for the Amazon Web Services account that the group is in. You use the ID
// for the Amazon Web Services account that contains your Amazon Quick Sight
// account.
//
// This member is required.
AwsAccountId *string
// An ID for the template that you want to create. This template is unique per
// Amazon Web Services Region; in each Amazon Web Services account.
//
// This member is required.
TemplateId *string
// The definition of a template.
//
// A definition is the data model of all features in a Dashboard, Template, or
// Analysis.
//
// Either a SourceEntity or a Definition must be provided in order for the request
// to be valid.
Definition *types.TemplateVersionDefinition
// A display name for the template.
Name *string
// A list of resource permissions to be set on the template.
Permissions []types.ResourcePermission
// The entity that you are using as a source when you create the template. In
// SourceEntity , you specify the type of object you're using as source:
// SourceTemplate for a template or SourceAnalysis for an analysis. Both of these
// require an Amazon Resource Name (ARN). For SourceTemplate , specify the ARN of
// the source template. For SourceAnalysis , specify the ARN of the source
// analysis. The SourceTemplate ARN can contain any Amazon Web Services account
// and any Quick Sight-supported Amazon Web Services Region.
//
// Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to
// list the replacement datasets for the placeholders listed in the original. The
// schema in each dataset must match its placeholder. Use the TopicReferences
// entity to list the replacement topics for the topic placeholders listed in the
// original. The schema in each topic must match its placeholder.
//
// Either a SourceEntity or a Definition must be provided in order for the request
// to be valid.
SourceEntity *types.TemplateSourceEntity
// Contains a map of the key-value pairs for the resource tag or tags assigned to
// the resource.
Tags []types.Tag
// TThe option to relax the validation needed to create a template with definition
// objects. This skips the validation step for specific errors.
ValidationStrategy *types.ValidationStrategy
// A description of the current template version being created. This API operation
// creates the first version of the template. Every time UpdateTemplate is called,
// a new version is created. Each version of the template maintains a description
// of the version in the VersionDescription field.
VersionDescription *string
// contains filtered or unexported fields
}
func (*CreateTemplateInput) Serialize ¶ added in v1.131.0
func (v *CreateTemplateInput) Serialize(s smithy.ShapeSerializer)
func (*CreateTemplateInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateTemplateInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateTemplateOutput ¶
type CreateTemplateOutput struct {
// The ARN for the template.
Arn *string
// The template creation status.
CreationStatus types.ResourceStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ID of the template.
TemplateId *string
// The ARN for the template, including the version information of the first
// version.
VersionArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateTemplateOutput) Deserialize ¶ added in v1.131.0
func (v *CreateTemplateOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateTemplateOutput) Serialize ¶ added in v1.131.0
func (v *CreateTemplateOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateTemplateOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateTemplateOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateThemeAliasInput ¶
type CreateThemeAliasInput struct {
// The name that you want to give to the theme alias that you are creating. The
// alias name can't begin with a $ . Alias names that start with $ are reserved by
// Amazon Quick Sight.
//
// This member is required.
AliasName *string
// The ID of the Amazon Web Services account that contains the theme for the new
// theme alias.
//
// This member is required.
AwsAccountId *string
// An ID for the theme alias.
//
// This member is required.
ThemeId *string
// The version number of the theme.
//
// This member is required.
ThemeVersionNumber *int64
// contains filtered or unexported fields
}
func (*CreateThemeAliasInput) Serialize ¶ added in v1.131.0
func (v *CreateThemeAliasInput) Serialize(s smithy.ShapeSerializer)
func (*CreateThemeAliasInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateThemeAliasInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateThemeAliasOutput ¶
type CreateThemeAliasOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Information about the theme alias.
ThemeAlias *types.ThemeAlias
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateThemeAliasOutput) Deserialize ¶ added in v1.131.0
func (v *CreateThemeAliasOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateThemeAliasOutput) Serialize ¶ added in v1.131.0
func (v *CreateThemeAliasOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateThemeAliasOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateThemeAliasOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateThemeInput ¶
type CreateThemeInput struct {
// The ID of the Amazon Web Services account where you want to store the new
// theme.
//
// This member is required.
AwsAccountId *string
// The ID of the theme that a custom theme will inherit from. All themes inherit
// from one of the starting themes defined by Amazon Quick Sight. For a list of the
// starting themes, use ListThemes or choose Themes from within an analysis.
//
// This member is required.
BaseThemeId *string
// The theme configuration, which contains the theme display properties.
//
// This member is required.
Configuration *types.ThemeConfiguration
// A display name for the theme.
//
// This member is required.
Name *string
// An ID for the theme that you want to create. The theme ID is unique per Amazon
// Web Services Region in each Amazon Web Services account.
//
// This member is required.
ThemeId *string
// A valid grouping of resource permissions to apply to the new theme.
Permissions []types.ResourcePermission
// A map of the key-value pairs for the resource tag or tags that you want to add
// to the resource.
Tags []types.Tag
// A description of the first version of the theme that you're creating. Every
// time UpdateTheme is called, a new version is created. Each version of the theme
// has a description of the version in the VersionDescription field.
VersionDescription *string
// contains filtered or unexported fields
}
func (*CreateThemeInput) Serialize ¶ added in v1.131.0
func (v *CreateThemeInput) Serialize(s smithy.ShapeSerializer)
func (*CreateThemeInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateThemeInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateThemeOutput ¶
type CreateThemeOutput struct {
// The Amazon Resource Name (ARN) for the theme.
Arn *string
// The theme creation status.
CreationStatus types.ResourceStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ID of the theme.
ThemeId *string
// The Amazon Resource Name (ARN) for the new theme.
VersionArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateThemeOutput) Deserialize ¶ added in v1.131.0
func (v *CreateThemeOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateThemeOutput) Serialize ¶ added in v1.131.0
func (v *CreateThemeOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateThemeOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateThemeOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateTopicInput ¶ added in v1.35.0
type CreateTopicInput struct {
// The ID of the Amazon Web Services account that you want to create a topic in.
//
// This member is required.
AwsAccountId *string
// The definition of a topic to create.
//
// This member is required.
Topic *types.TopicDetails
// The ID for the topic that you want to create. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
// Custom instructions for the topic.
CustomInstructions *types.CustomInstructions
// The Folder ARN of the folder that you want the topic to reside in.
FolderArns []string
// Contains a map of the key-value pairs for the resource tag or tags that are
// assigned to the dataset.
Tags []types.Tag
// contains filtered or unexported fields
}
func (*CreateTopicInput) Serialize ¶ added in v1.131.0
func (v *CreateTopicInput) Serialize(s smithy.ShapeSerializer)
func (*CreateTopicInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateTopicInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateTopicOutput ¶ added in v1.35.0
type CreateTopicOutput struct {
// The Amazon Resource Name (ARN) of the topic.
Arn *string
// The Amazon Resource Name (ARN) of the topic refresh.
RefreshArn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ID for the topic that you want to create. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateTopicOutput) Deserialize ¶ added in v1.131.0
func (v *CreateTopicOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateTopicOutput) Serialize ¶ added in v1.131.0
func (v *CreateTopicOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateTopicOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateTopicOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateTopicRefreshScheduleInput ¶ added in v1.35.0
type CreateTopicRefreshScheduleInput struct {
// The ID of the Amazon Web Services account that contains the topic you're
// creating a refresh schedule for.
//
// This member is required.
AwsAccountId *string
// The Amazon Resource Name (ARN) of the dataset.
//
// This member is required.
DatasetArn *string
// The definition of a refresh schedule.
//
// This member is required.
RefreshSchedule *types.TopicRefreshSchedule
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
// The name of the dataset.
DatasetName *string
// contains filtered or unexported fields
}
func (*CreateTopicRefreshScheduleInput) Serialize ¶ added in v1.131.0
func (v *CreateTopicRefreshScheduleInput) Serialize(s smithy.ShapeSerializer)
func (*CreateTopicRefreshScheduleInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateTopicRefreshScheduleInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateTopicRefreshScheduleOutput ¶ added in v1.35.0
type CreateTopicRefreshScheduleOutput struct {
// The Amazon Resource Name (ARN) of the dataset.
DatasetArn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the topic.
TopicArn *string
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateTopicRefreshScheduleOutput) Deserialize ¶ added in v1.131.0
func (v *CreateTopicRefreshScheduleOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateTopicRefreshScheduleOutput) Serialize ¶ added in v1.131.0
func (v *CreateTopicRefreshScheduleOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateTopicRefreshScheduleOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateTopicRefreshScheduleOutput) SerializeMembers(s smithy.ShapeSerializer)
type CreateTopicV2Input ¶ added in v1.123.0
type CreateTopicV2Input struct {
// The ID of the Amazon Web Services account that you want to create a topic in.
//
// This member is required.
AwsAccountId *string
// The definition of a topic to create.
//
// This member is required.
Topic *types.TopicV2Details
// The ID for the topic that you want to create. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
// Instructions that provide additional guidance and context for response
// generation.
CustomInstructions *types.CustomInstructions
// The Amazon Resource Names (ARNs) of the folders that you want the topic to
// reside in.
FolderArns []string
// Contains a map of the key-value pairs for the resource tag or tags that are
// assigned to the topic.
Tags []types.Tag
// contains filtered or unexported fields
}
func (*CreateTopicV2Input) Serialize ¶ added in v1.131.0
func (v *CreateTopicV2Input) Serialize(s smithy.ShapeSerializer)
func (*CreateTopicV2Input) SerializeMembers ¶ added in v1.131.0
func (v *CreateTopicV2Input) SerializeMembers(s smithy.ShapeSerializer)
type CreateTopicV2Output ¶ added in v1.123.0
type CreateTopicV2Output struct {
// The Amazon Resource Name (ARN) of the topic.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ID for the topic that you want to create. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateTopicV2Output) Deserialize ¶ added in v1.131.0
func (v *CreateTopicV2Output) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateTopicV2Output) Serialize ¶ added in v1.131.0
func (v *CreateTopicV2Output) Serialize(s smithy.ShapeSerializer)
func (*CreateTopicV2Output) SerializeMembers ¶ added in v1.131.0
func (v *CreateTopicV2Output) SerializeMembers(s smithy.ShapeSerializer)
type CreateVPCConnectionInput ¶ added in v1.35.0
type CreateVPCConnectionInput struct {
// The Amazon Web Services account ID of the account where you want to create a
// new VPC connection.
//
// This member is required.
AwsAccountId *string
// The display name for the VPC connection.
//
// This member is required.
Name *string
// The IAM role to associate with the VPC connection.
//
// This member is required.
RoleArn *string
// A list of security group IDs for the VPC connection.
//
// This member is required.
SecurityGroupIds []string
// A list of subnet IDs for the VPC connection.
//
// This member is required.
SubnetIds []string
// 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.
//
// This member is required.
VPCConnectionId *string
// A list of IP addresses of DNS resolver endpoints for the VPC connection.
DnsResolvers []string
// A map of the key-value pairs for the resource tag or tags assigned to the VPC
// connection.
Tags []types.Tag
// contains filtered or unexported fields
}
func (*CreateVPCConnectionInput) Serialize ¶ added in v1.131.0
func (v *CreateVPCConnectionInput) Serialize(s smithy.ShapeSerializer)
func (*CreateVPCConnectionInput) SerializeMembers ¶ added in v1.131.0
func (v *CreateVPCConnectionInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateVPCConnectionOutput ¶ added in v1.35.0
type CreateVPCConnectionOutput struct {
// The Amazon Resource Name (ARN) of the VPC connection.
Arn *string
// The availability status of the VPC connection.
AvailabilityStatus types.VPCConnectionAvailabilityStatus
// The status of the creation of the VPC connection.
CreationStatus types.VPCConnectionResourceStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ID for the VPC connection that you're creating. This ID is unique per
// Amazon Web Services Region for each Amazon Web Services account.
VPCConnectionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateVPCConnectionOutput) Deserialize ¶ added in v1.131.0
func (v *CreateVPCConnectionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateVPCConnectionOutput) Serialize ¶ added in v1.131.0
func (v *CreateVPCConnectionOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateVPCConnectionOutput) SerializeMembers ¶ added in v1.131.0
func (v *CreateVPCConnectionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteAccountCustomPermissionInput ¶ added in v1.94.0
type DeleteAccountCustomPermissionInput struct {
// The ID of the Amazon Web Services account from which you want to unapply the
// custom permissions profile.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DeleteAccountCustomPermissionInput) Serialize ¶ added in v1.131.0
func (v *DeleteAccountCustomPermissionInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteAccountCustomPermissionInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteAccountCustomPermissionInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteAccountCustomPermissionOutput ¶ added in v1.94.0
type DeleteAccountCustomPermissionOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteAccountCustomPermissionOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteAccountCustomPermissionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteAccountCustomPermissionOutput) Serialize ¶ added in v1.131.0
func (v *DeleteAccountCustomPermissionOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteAccountCustomPermissionOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteAccountCustomPermissionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteAccountCustomizationInput ¶
type DeleteAccountCustomizationInput struct {
// The ID for the Amazon Web Services account that you want to delete Quick Sight
// customizations from.
//
// This member is required.
AwsAccountId *string
// The Quick Sight namespace that you're deleting the customizations from.
Namespace *string
// contains filtered or unexported fields
}
func (*DeleteAccountCustomizationInput) Serialize ¶ added in v1.131.0
func (v *DeleteAccountCustomizationInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteAccountCustomizationInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteAccountCustomizationInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteAccountCustomizationOutput ¶
type DeleteAccountCustomizationOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteAccountCustomizationOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteAccountCustomizationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteAccountCustomizationOutput) Serialize ¶ added in v1.131.0
func (v *DeleteAccountCustomizationOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteAccountCustomizationOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteAccountCustomizationOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteAccountSubscriptionInput ¶ added in v1.27.0
type DeleteAccountSubscriptionInput struct {
// The Amazon Web Services account ID of the account that you want to delete.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DeleteAccountSubscriptionInput) Serialize ¶ added in v1.131.0
func (v *DeleteAccountSubscriptionInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteAccountSubscriptionInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteAccountSubscriptionInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteAccountSubscriptionOutput ¶ added in v1.27.0
type DeleteAccountSubscriptionOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteAccountSubscriptionOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteAccountSubscriptionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteAccountSubscriptionOutput) Serialize ¶ added in v1.131.0
func (v *DeleteAccountSubscriptionOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteAccountSubscriptionOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteAccountSubscriptionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteActionConnectorInput ¶ added in v1.95.0
type DeleteActionConnectorInput struct {
// The unique identifier of the action connector to delete.
//
// This member is required.
ActionConnectorId *string
// The Amazon Web Services account ID that contains the action connector to delete.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DeleteActionConnectorInput) Serialize ¶ added in v1.131.0
func (v *DeleteActionConnectorInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteActionConnectorInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteActionConnectorInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteActionConnectorOutput ¶ added in v1.95.0
type DeleteActionConnectorOutput struct {
// The unique identifier of the deleted action connector.
ActionConnectorId *string
// The Amazon Resource Name (ARN) of the deleted action connector.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status code of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteActionConnectorOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteActionConnectorOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteActionConnectorOutput) Serialize ¶ added in v1.131.0
func (v *DeleteActionConnectorOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteActionConnectorOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteActionConnectorOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteAgentInput ¶ added in v1.113.0
type DeleteAgentInput struct {
// The unique identifier for the agent to delete.
//
// This member is required.
AgentId *string
// The ID of the Amazon Web Services account that contains the agent.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DeleteAgentInput) Serialize ¶ added in v1.131.0
func (v *DeleteAgentInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteAgentInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteAgentInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteAgentOutput ¶ added in v1.113.0
type DeleteAgentOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteAgentOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteAgentOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteAgentOutput) Serialize ¶ added in v1.131.0
func (v *DeleteAgentOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteAgentOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteAgentOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteAnalysisInput ¶ added in v0.29.0
type DeleteAnalysisInput struct {
// The ID of the analysis that you're deleting.
//
// This member is required.
AnalysisId *string
// The ID of the Amazon Web Services account where you want to delete an analysis.
//
// This member is required.
AwsAccountId *string
// This option defaults to the value NoForceDeleteWithoutRecovery . To immediately
// delete the analysis, add the ForceDeleteWithoutRecovery option. You can't
// restore an analysis after it's deleted.
ForceDeleteWithoutRecovery bool
// A value that specifies the number of days that Amazon Quick Sight waits before
// it deletes the analysis. You can't use this parameter with the
// ForceDeleteWithoutRecovery option in the same API call. The default value is 30.
RecoveryWindowInDays *int64
// contains filtered or unexported fields
}
func (*DeleteAnalysisInput) Serialize ¶ added in v1.131.0
func (v *DeleteAnalysisInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteAnalysisInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteAnalysisInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteAnalysisOutput ¶ added in v0.29.0
type DeleteAnalysisOutput struct {
// The ID of the deleted analysis.
AnalysisId *string
// The Amazon Resource Name (ARN) of the deleted analysis.
Arn *string
// The date and time that the analysis is scheduled to be deleted.
DeletionTime *time.Time
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteAnalysisOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteAnalysisOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteAnalysisOutput) Serialize ¶ added in v1.131.0
func (v *DeleteAnalysisOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteAnalysisOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteAnalysisOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteAppInput ¶ added in v1.127.0
type DeleteAppInput struct {
// The ID of the app that you want to delete.
//
// This member is required.
AppId *string
// The ID of the Amazon Web Services account that contains the app.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DeleteAppInput) Serialize ¶ added in v1.131.0
func (v *DeleteAppInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteAppInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteAppInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteAppOutput ¶ added in v1.127.0
type DeleteAppOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteAppOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteAppOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteAppOutput) Serialize ¶ added in v1.131.0
func (v *DeleteAppOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteAppOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteAppOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteApprovalPolicyInput ¶ added in v1.124.0
type DeleteApprovalPolicyInput struct {
// The unique identifier of the approval policy to delete.
//
// This member is required.
PolicyId *string
// contains filtered or unexported fields
}
func (*DeleteApprovalPolicyInput) Serialize ¶ added in v1.131.0
func (v *DeleteApprovalPolicyInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteApprovalPolicyInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteApprovalPolicyInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteApprovalPolicyOutput ¶ added in v1.124.0
type DeleteApprovalPolicyOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteApprovalPolicyOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteApprovalPolicyOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteApprovalPolicyOutput) Serialize ¶ added in v1.131.0
func (v *DeleteApprovalPolicyOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteApprovalPolicyOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteApprovalPolicyOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteBrandAssignmentInput ¶ added in v1.79.0
type DeleteBrandAssignmentInput struct {
// The ID of the Amazon Web Services account that owns the brand assignment.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DeleteBrandAssignmentInput) Serialize ¶ added in v1.131.0
func (v *DeleteBrandAssignmentInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteBrandAssignmentInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteBrandAssignmentInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteBrandAssignmentOutput ¶ added in v1.79.0
type DeleteBrandAssignmentOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteBrandAssignmentOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteBrandAssignmentOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteBrandAssignmentOutput) Serialize ¶ added in v1.131.0
func (v *DeleteBrandAssignmentOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteBrandAssignmentOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteBrandAssignmentOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteBrandInput ¶ added in v1.79.0
type DeleteBrandInput struct {
// The ID of the Amazon Web Services account that owns the brand.
//
// This member is required.
AwsAccountId *string
// The ID of the Quick brand.
//
// This member is required.
BrandId *string
// contains filtered or unexported fields
}
func (*DeleteBrandInput) Serialize ¶ added in v1.131.0
func (v *DeleteBrandInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteBrandInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteBrandInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteBrandOutput ¶ added in v1.79.0
type DeleteBrandOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteBrandOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteBrandOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteBrandOutput) Serialize ¶ added in v1.131.0
func (v *DeleteBrandOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteBrandOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteBrandOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteCustomPermissionsInput ¶ added in v1.79.0
type DeleteCustomPermissionsInput struct {
// The ID of the Amazon Web Services account that contains the custom permissions
// profile that you want to delete.
//
// This member is required.
AwsAccountId *string
// The name of the custom permissions profile that you want to delete.
//
// This member is required.
CustomPermissionsName *string
// contains filtered or unexported fields
}
func (*DeleteCustomPermissionsInput) Serialize ¶ added in v1.131.0
func (v *DeleteCustomPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteCustomPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteCustomPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteCustomPermissionsOutput ¶ added in v1.79.0
type DeleteCustomPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the custom permissions profile.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteCustomPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteCustomPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteCustomPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *DeleteCustomPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteCustomPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteCustomPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteDashboardInput ¶
type DeleteDashboardInput struct {
// The ID of the Amazon Web Services account that contains the dashboard that
// you're deleting.
//
// This member is required.
AwsAccountId *string
// The ID for the dashboard.
//
// This member is required.
DashboardId *string
// The version number of the dashboard. If the version number property is
// provided, only the specified version of the dashboard is deleted.
VersionNumber *int64
// contains filtered or unexported fields
}
func (*DeleteDashboardInput) Serialize ¶ added in v1.131.0
func (v *DeleteDashboardInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteDashboardInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteDashboardInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteDashboardOutput ¶
type DeleteDashboardOutput struct {
// The Secure Socket Layer (SSL) properties that apply for the resource.
Arn *string
// The ID of the dashboard.
DashboardId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteDashboardOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteDashboardOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteDashboardOutput) Serialize ¶ added in v1.131.0
func (v *DeleteDashboardOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteDashboardOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteDashboardOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteDataSetInput ¶
type DeleteDataSetInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID for the dataset that you want to delete. This ID is unique per Amazon
// Web Services Region for each Amazon Web Services account.
//
// This member is required.
DataSetId *string
// contains filtered or unexported fields
}
func (*DeleteDataSetInput) Serialize ¶ added in v1.131.0
func (v *DeleteDataSetInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteDataSetInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteDataSetInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteDataSetOutput ¶
type DeleteDataSetOutput struct {
// The Amazon Resource Name (ARN) of the dataset.
Arn *string
// The ID for the dataset that you want to delete. This ID is unique per Amazon
// Web Services Region for each Amazon Web Services account.
DataSetId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteDataSetOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteDataSetOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteDataSetOutput) Serialize ¶ added in v1.131.0
func (v *DeleteDataSetOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteDataSetOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteDataSetOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteDataSetRefreshPropertiesInput ¶ added in v1.34.0
type DeleteDataSetRefreshPropertiesInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset.
//
// This member is required.
DataSetId *string
// contains filtered or unexported fields
}
func (*DeleteDataSetRefreshPropertiesInput) Serialize ¶ added in v1.131.0
func (v *DeleteDataSetRefreshPropertiesInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteDataSetRefreshPropertiesInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteDataSetRefreshPropertiesInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteDataSetRefreshPropertiesOutput ¶ added in v1.34.0
type DeleteDataSetRefreshPropertiesOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteDataSetRefreshPropertiesOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteDataSetRefreshPropertiesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteDataSetRefreshPropertiesOutput) Serialize ¶ added in v1.131.0
func (v *DeleteDataSetRefreshPropertiesOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteDataSetRefreshPropertiesOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteDataSetRefreshPropertiesOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteDataSourceInput ¶
type DeleteDataSourceInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
//
// This member is required.
DataSourceId *string
// contains filtered or unexported fields
}
func (*DeleteDataSourceInput) Serialize ¶ added in v1.131.0
func (v *DeleteDataSourceInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteDataSourceInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteDataSourceInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteDataSourceOutput ¶
type DeleteDataSourceOutput struct {
// The Amazon Resource Name (ARN) of the data source that you deleted.
Arn *string
// The ID of the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
DataSourceId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteDataSourceOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteDataSourceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteDataSourceOutput) Serialize ¶ added in v1.131.0
func (v *DeleteDataSourceOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteDataSourceOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteDataSourceOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteDefaultQBusinessApplicationInput ¶ added in v1.81.0
type DeleteDefaultQBusinessApplicationInput struct {
// The ID of the Quick Sight account that you want to disconnect from a Amazon Q
// Business application.
//
// This member is required.
AwsAccountId *string
// The Quick Sight namespace that you want to delete a linked Amazon Q Business
// application from. If this field is left blank, the Amazon Q Business application
// is deleted from the default namespace. Currently, the default namespace is the
// only valid value for this parameter.
Namespace *string
// contains filtered or unexported fields
}
func (*DeleteDefaultQBusinessApplicationInput) Serialize ¶ added in v1.131.0
func (v *DeleteDefaultQBusinessApplicationInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteDefaultQBusinessApplicationInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteDefaultQBusinessApplicationInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteDefaultQBusinessApplicationOutput ¶ added in v1.81.0
type DeleteDefaultQBusinessApplicationOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteDefaultQBusinessApplicationOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteDefaultQBusinessApplicationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteDefaultQBusinessApplicationOutput) Serialize ¶ added in v1.131.0
func (v *DeleteDefaultQBusinessApplicationOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteDefaultQBusinessApplicationOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteDefaultQBusinessApplicationOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteDlpSettingInput ¶ added in v1.124.0
type DeleteDlpSettingInput struct {
// The ID of the Amazon Web Services account that contains the DLP setting that
// you want to delete.
//
// This member is required.
AwsAccountId *string
// The ID of the DLP setting that you want to delete.
//
// This member is required.
DlpSettingId *string
// contains filtered or unexported fields
}
func (*DeleteDlpSettingInput) Serialize ¶ added in v1.131.0
func (v *DeleteDlpSettingInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteDlpSettingInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteDlpSettingInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteDlpSettingOutput ¶ added in v1.124.0
type DeleteDlpSettingOutput struct {
// The Amazon Resource Name (ARN) of the deleted DLP setting.
//
// This member is required.
Arn *string
// The ID of the deleted DLP setting.
//
// This member is required.
DlpSettingId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteDlpSettingOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteDlpSettingOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteDlpSettingOutput) Serialize ¶ added in v1.131.0
func (v *DeleteDlpSettingOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteDlpSettingOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteDlpSettingOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteFlowInput ¶ added in v1.113.0
type DeleteFlowInput struct {
// The ID of the Amazon Web Services account that contains the flow that you are
// deleting.
//
// This member is required.
AwsAccountId *string
// The unique identifier of the flow to delete.
//
// This member is required.
FlowId *string
// contains filtered or unexported fields
}
func (*DeleteFlowInput) Serialize ¶ added in v1.131.0
func (v *DeleteFlowInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteFlowInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteFlowInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteFlowOutput ¶ added in v1.113.0
type DeleteFlowOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteFlowOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteFlowOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteFlowOutput) Serialize ¶ added in v1.131.0
func (v *DeleteFlowOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteFlowOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteFlowOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteFolderInput ¶ added in v1.6.0
type DeleteFolderInput struct {
// The ID for the Amazon Web Services account that contains the folder.
//
// This member is required.
AwsAccountId *string
// The ID of the folder.
//
// This member is required.
FolderId *string
// contains filtered or unexported fields
}
func (*DeleteFolderInput) Serialize ¶ added in v1.131.0
func (v *DeleteFolderInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteFolderInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteFolderInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteFolderMembershipInput ¶ added in v1.6.0
type DeleteFolderMembershipInput struct {
// The ID for the Amazon Web Services account that contains the folder.
//
// This member is required.
AwsAccountId *string
// The Folder ID.
//
// This member is required.
FolderId *string
// The ID of the asset that you want to delete.
//
// This member is required.
MemberId *string
// The member type of the asset that you want to delete from a folder.
//
// This member is required.
MemberType types.MemberType
// contains filtered or unexported fields
}
func (*DeleteFolderMembershipInput) Serialize ¶ added in v1.131.0
func (v *DeleteFolderMembershipInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteFolderMembershipInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteFolderMembershipInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteFolderMembershipOutput ¶ added in v1.6.0
type DeleteFolderMembershipOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteFolderMembershipOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteFolderMembershipOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteFolderMembershipOutput) Serialize ¶ added in v1.131.0
func (v *DeleteFolderMembershipOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteFolderMembershipOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteFolderMembershipOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteFolderOutput ¶ added in v1.6.0
type DeleteFolderOutput struct {
// The Amazon Resource Name of the deleted folder.
Arn *string
// The ID of the folder.
FolderId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteFolderOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteFolderOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteFolderOutput) Serialize ¶ added in v1.131.0
func (v *DeleteFolderOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteFolderOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteFolderOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteGroupInput ¶
type DeleteGroupInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The name of the group that you want to delete.
//
// This member is required.
GroupName *string
// The namespace of the group that you want to delete.
//
// This member is required.
Namespace *string
// contains filtered or unexported fields
}
func (*DeleteGroupInput) Serialize ¶ added in v1.131.0
func (v *DeleteGroupInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteGroupInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteGroupInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteGroupMembershipInput ¶
type DeleteGroupMembershipInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The name of the group that you want to delete the user from.
//
// This member is required.
GroupName *string
// The name of the user that you want to delete from the group membership.
//
// This member is required.
MemberName *string
// The namespace of the group that you want to remove a user from.
//
// This member is required.
Namespace *string
// contains filtered or unexported fields
}
func (*DeleteGroupMembershipInput) Serialize ¶ added in v1.131.0
func (v *DeleteGroupMembershipInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteGroupMembershipInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteGroupMembershipInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteGroupMembershipOutput ¶
type DeleteGroupMembershipOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteGroupMembershipOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteGroupMembershipOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteGroupMembershipOutput) Serialize ¶ added in v1.131.0
func (v *DeleteGroupMembershipOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteGroupMembershipOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteGroupMembershipOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteGroupOutput ¶
type DeleteGroupOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteGroupOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteGroupOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteGroupOutput) Serialize ¶ added in v1.131.0
func (v *DeleteGroupOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteGroupOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteGroupOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteIAMPolicyAssignmentInput ¶
type DeleteIAMPolicyAssignmentInput struct {
// The name of the assignment.
//
// This member is required.
AssignmentName *string
// The Amazon Web Services account ID where you want to delete the IAM policy
// assignment.
//
// This member is required.
AwsAccountId *string
// The namespace that contains the assignment.
//
// This member is required.
Namespace *string
// contains filtered or unexported fields
}
func (*DeleteIAMPolicyAssignmentInput) Serialize ¶ added in v1.131.0
func (v *DeleteIAMPolicyAssignmentInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteIAMPolicyAssignmentInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteIAMPolicyAssignmentInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteIAMPolicyAssignmentOutput ¶
type DeleteIAMPolicyAssignmentOutput struct {
// The name of the assignment.
AssignmentName *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteIAMPolicyAssignmentOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteIAMPolicyAssignmentOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteIAMPolicyAssignmentOutput) Serialize ¶ added in v1.131.0
func (v *DeleteIAMPolicyAssignmentOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteIAMPolicyAssignmentOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteIAMPolicyAssignmentOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteIdentityPropagationConfigInput ¶ added in v1.52.0
type DeleteIdentityPropagationConfigInput struct {
// The ID of the Amazon Web Services account that you want to delete an identity
// propagation configuration from.
//
// This member is required.
AwsAccountId *string
// The name of the Amazon Web Services service that you want to delete the
// associated access scopes and authorized targets from.
//
// This member is required.
Service types.ServiceType
// contains filtered or unexported fields
}
func (*DeleteIdentityPropagationConfigInput) Serialize ¶ added in v1.131.0
func (v *DeleteIdentityPropagationConfigInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteIdentityPropagationConfigInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteIdentityPropagationConfigInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteIdentityPropagationConfigOutput ¶ added in v1.52.0
type DeleteIdentityPropagationConfigOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteIdentityPropagationConfigOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteIdentityPropagationConfigOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteIdentityPropagationConfigOutput) Serialize ¶ added in v1.131.0
func (v *DeleteIdentityPropagationConfigOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteIdentityPropagationConfigOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteIdentityPropagationConfigOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteKnowledgeBaseInput ¶ added in v1.114.0
type DeleteKnowledgeBaseInput struct {
// The ID of the Amazon Web Services account that contains the knowledge base.
//
// This member is required.
AwsAccountId *string
// The unique identifier for the knowledge base.
//
// This member is required.
KnowledgeBaseId *string
// contains filtered or unexported fields
}
func (*DeleteKnowledgeBaseInput) Serialize ¶ added in v1.131.0
func (v *DeleteKnowledgeBaseInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteKnowledgeBaseInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteKnowledgeBaseInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteKnowledgeBaseOutput ¶ added in v1.114.0
type DeleteKnowledgeBaseOutput struct {
// The ARN of the deleted knowledge base.
//
// This member is required.
KnowledgeBaseArn *string
// The ID of the deleted knowledge base.
//
// This member is required.
KnowledgeBaseId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status *int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteKnowledgeBaseOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteKnowledgeBaseOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteKnowledgeBaseOutput) Serialize ¶ added in v1.131.0
func (v *DeleteKnowledgeBaseOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteKnowledgeBaseOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteKnowledgeBaseOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteLimitsProfileInput ¶ added in v1.124.0
type DeleteLimitsProfileInput struct {
// The ID of the Amazon Web Services account that contains the limits profile.
//
// This member is required.
AccountId *string
// The unique identifier for the limits profile to delete.
//
// This member is required.
ProfileId *string
// contains filtered or unexported fields
}
func (*DeleteLimitsProfileInput) Serialize ¶ added in v1.131.0
func (v *DeleteLimitsProfileInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteLimitsProfileInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteLimitsProfileInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteLimitsProfileOutput ¶ added in v1.124.0
type DeleteLimitsProfileOutput struct {
// The Amazon Resource Name (ARN) of the deleted limits profile.
//
// This member is required.
Arn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteLimitsProfileOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteLimitsProfileOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteLimitsProfileOutput) Serialize ¶ added in v1.131.0
func (v *DeleteLimitsProfileOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteLimitsProfileOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteLimitsProfileOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteNamespaceInput ¶
type DeleteNamespaceInput struct {
// The ID for the Amazon Web Services account that you want to delete the Quick
// Sight namespace from.
//
// This member is required.
AwsAccountId *string
// The namespace that you want to delete.
//
// This member is required.
Namespace *string
// contains filtered or unexported fields
}
func (*DeleteNamespaceInput) Serialize ¶ added in v1.131.0
func (v *DeleteNamespaceInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteNamespaceInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteNamespaceInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteNamespaceOutput ¶
type DeleteNamespaceOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteNamespaceOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteNamespaceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteNamespaceOutput) Serialize ¶ added in v1.131.0
func (v *DeleteNamespaceOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteNamespaceOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteNamespaceOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteOAuthClientApplicationInput ¶ added in v1.112.0
type DeleteOAuthClientApplicationInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the OAuthClientApplication that you want to delete.
//
// This member is required.
OAuthClientApplicationId *string
// contains filtered or unexported fields
}
func (*DeleteOAuthClientApplicationInput) Serialize ¶ added in v1.131.0
func (v *DeleteOAuthClientApplicationInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteOAuthClientApplicationInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteOAuthClientApplicationInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteOAuthClientApplicationOutput ¶ added in v1.112.0
type DeleteOAuthClientApplicationOutput struct {
// The Amazon Resource Name (ARN) of the OAuthClientApplication that you deleted.
Arn *string
// The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services
// Region for each Amazon Web Services account.
OAuthClientApplicationId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteOAuthClientApplicationOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteOAuthClientApplicationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteOAuthClientApplicationOutput) Serialize ¶ added in v1.131.0
func (v *DeleteOAuthClientApplicationOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteOAuthClientApplicationOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteOAuthClientApplicationOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteRefreshScheduleInput ¶ added in v1.34.0
type DeleteRefreshScheduleInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset.
//
// This member is required.
DataSetId *string
// The ID of the refresh schedule.
//
// This member is required.
ScheduleId *string
// contains filtered or unexported fields
}
func (*DeleteRefreshScheduleInput) Serialize ¶ added in v1.131.0
func (v *DeleteRefreshScheduleInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteRefreshScheduleInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteRefreshScheduleInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteRefreshScheduleOutput ¶ added in v1.34.0
type DeleteRefreshScheduleOutput struct {
// The Amazon Resource Name (ARN) for the refresh schedule.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The ID of the refresh schedule.
ScheduleId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteRefreshScheduleOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteRefreshScheduleOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteRefreshScheduleOutput) Serialize ¶ added in v1.131.0
func (v *DeleteRefreshScheduleOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteRefreshScheduleOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteRefreshScheduleOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteRoleCustomPermissionInput ¶ added in v1.51.0
type DeleteRoleCustomPermissionInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The namespace that includes the role.
//
// This member is required.
Namespace *string
// The role that you want to remove permissions from.
//
// This member is required.
Role types.Role
// contains filtered or unexported fields
}
func (*DeleteRoleCustomPermissionInput) Serialize ¶ added in v1.131.0
func (v *DeleteRoleCustomPermissionInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteRoleCustomPermissionInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteRoleCustomPermissionInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteRoleCustomPermissionOutput ¶ added in v1.51.0
type DeleteRoleCustomPermissionOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteRoleCustomPermissionOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteRoleCustomPermissionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteRoleCustomPermissionOutput) Serialize ¶ added in v1.131.0
func (v *DeleteRoleCustomPermissionOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteRoleCustomPermissionOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteRoleCustomPermissionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteRoleMembershipInput ¶ added in v1.51.0
type DeleteRoleMembershipInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The name of the group.
//
// This member is required.
MemberName *string
// The namespace that contains the role.
//
// This member is required.
Namespace *string
// The role that you want to remove permissions from.
//
// This member is required.
Role types.Role
// contains filtered or unexported fields
}
func (*DeleteRoleMembershipInput) Serialize ¶ added in v1.131.0
func (v *DeleteRoleMembershipInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteRoleMembershipInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteRoleMembershipInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteRoleMembershipOutput ¶ added in v1.51.0
type DeleteRoleMembershipOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteRoleMembershipOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteRoleMembershipOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteRoleMembershipOutput) Serialize ¶ added in v1.131.0
func (v *DeleteRoleMembershipOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteRoleMembershipOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteRoleMembershipOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteSpaceInput ¶ added in v1.113.0
type DeleteSpaceInput struct {
// The ID of the Amazon Web Services account that contains the space.
//
// This member is required.
AwsAccountId *string
// The ID of the space that you want to delete.
//
// This member is required.
SpaceId *string
// contains filtered or unexported fields
}
func (*DeleteSpaceInput) Serialize ¶ added in v1.131.0
func (v *DeleteSpaceInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteSpaceInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteSpaceInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteSpaceOutput ¶ added in v1.113.0
type DeleteSpaceOutput struct {
// The ID of the space.
//
// This member is required.
SpaceId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The ARN of the space.
SpaceArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteSpaceOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteSpaceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteSpaceOutput) Serialize ¶ added in v1.131.0
func (v *DeleteSpaceOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteSpaceOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteSpaceOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteTemplateAliasInput ¶
type DeleteTemplateAliasInput struct {
// The name for the template alias. To delete a specific alias, you delete the
// version that the alias points to. You can specify the alias name, or specify the
// latest version of the template by providing the keyword $LATEST in the AliasName
// parameter.
//
// This member is required.
AliasName *string
// The ID of the Amazon Web Services account that contains the item to delete.
//
// This member is required.
AwsAccountId *string
// The ID for the template that the specified alias is for.
//
// This member is required.
TemplateId *string
// contains filtered or unexported fields
}
func (*DeleteTemplateAliasInput) Serialize ¶ added in v1.131.0
func (v *DeleteTemplateAliasInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteTemplateAliasInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteTemplateAliasInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteTemplateAliasOutput ¶
type DeleteTemplateAliasOutput struct {
// The name for the template alias.
AliasName *string
// The Amazon Resource Name (ARN) of the template you want to delete.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// An ID for the template associated with the deletion.
TemplateId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteTemplateAliasOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteTemplateAliasOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteTemplateAliasOutput) Serialize ¶ added in v1.131.0
func (v *DeleteTemplateAliasOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteTemplateAliasOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteTemplateAliasOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteTemplateInput ¶
type DeleteTemplateInput struct {
// The ID of the Amazon Web Services account that contains the template that
// you're deleting.
//
// This member is required.
AwsAccountId *string
// An ID for the template you want to delete.
//
// This member is required.
TemplateId *string
// Specifies the version of the template that you want to delete. If you don't
// provide a version number, DeleteTemplate deletes all versions of the template.
VersionNumber *int64
// contains filtered or unexported fields
}
func (*DeleteTemplateInput) Serialize ¶ added in v1.131.0
func (v *DeleteTemplateInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteTemplateInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteTemplateInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteTemplateOutput ¶
type DeleteTemplateOutput struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// An ID for the template.
TemplateId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteTemplateOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteTemplateOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteTemplateOutput) Serialize ¶ added in v1.131.0
func (v *DeleteTemplateOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteTemplateOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteTemplateOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteThemeAliasInput ¶
type DeleteThemeAliasInput struct {
// The unique name for the theme alias to delete.
//
// This member is required.
AliasName *string
// The ID of the Amazon Web Services account that contains the theme alias to
// delete.
//
// This member is required.
AwsAccountId *string
// The ID for the theme that the specified alias is for.
//
// This member is required.
ThemeId *string
// contains filtered or unexported fields
}
func (*DeleteThemeAliasInput) Serialize ¶ added in v1.131.0
func (v *DeleteThemeAliasInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteThemeAliasInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteThemeAliasInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteThemeAliasOutput ¶
type DeleteThemeAliasOutput struct {
// The name for the theme alias.
AliasName *string
// The Amazon Resource Name (ARN) of the theme resource using the deleted alias.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// An ID for the theme associated with the deletion.
ThemeId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteThemeAliasOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteThemeAliasOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteThemeAliasOutput) Serialize ¶ added in v1.131.0
func (v *DeleteThemeAliasOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteThemeAliasOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteThemeAliasOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteThemeInput ¶
type DeleteThemeInput struct {
// The ID of the Amazon Web Services account that contains the theme that you're
// deleting.
//
// This member is required.
AwsAccountId *string
// An ID for the theme that you want to delete.
//
// This member is required.
ThemeId *string
// The version of the theme that you want to delete.
//
// Note: If you don't provide a version number, you're using this call to
// DeleteTheme to delete all versions of the theme.
VersionNumber *int64
// contains filtered or unexported fields
}
func (*DeleteThemeInput) Serialize ¶ added in v1.131.0
func (v *DeleteThemeInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteThemeInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteThemeInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteThemeOutput ¶
type DeleteThemeOutput struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// An ID for the theme.
ThemeId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteThemeOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteThemeOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteThemeOutput) Serialize ¶ added in v1.131.0
func (v *DeleteThemeOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteThemeOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteThemeOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteTopicInput ¶ added in v1.35.0
type DeleteTopicInput struct {
// The ID of the Amazon Web Services account that contains the topic that you want
// to delete.
//
// This member is required.
AwsAccountId *string
// The ID of the topic that you want to delete. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
// contains filtered or unexported fields
}
func (*DeleteTopicInput) Serialize ¶ added in v1.131.0
func (v *DeleteTopicInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteTopicInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteTopicInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteTopicOutput ¶ added in v1.35.0
type DeleteTopicOutput struct {
// The Amazon Resource Name (ARN) of the topic.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ID of the topic that you want to delete. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteTopicOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteTopicOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteTopicOutput) Serialize ¶ added in v1.131.0
func (v *DeleteTopicOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteTopicOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteTopicOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteTopicRefreshScheduleInput ¶ added in v1.35.0
type DeleteTopicRefreshScheduleInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset.
//
// This member is required.
DatasetId *string
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
// contains filtered or unexported fields
}
func (*DeleteTopicRefreshScheduleInput) Serialize ¶ added in v1.131.0
func (v *DeleteTopicRefreshScheduleInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteTopicRefreshScheduleInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteTopicRefreshScheduleInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteTopicRefreshScheduleOutput ¶ added in v1.35.0
type DeleteTopicRefreshScheduleOutput struct {
// The Amazon Resource Name (ARN) of the dataset.
DatasetArn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the topic.
TopicArn *string
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteTopicRefreshScheduleOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteTopicRefreshScheduleOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteTopicRefreshScheduleOutput) Serialize ¶ added in v1.131.0
func (v *DeleteTopicRefreshScheduleOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteTopicRefreshScheduleOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteTopicRefreshScheduleOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteTopicV2Input ¶ added in v1.123.0
type DeleteTopicV2Input struct {
// The ID of the Amazon Web Services account that contains the topic that you want
// to delete.
//
// This member is required.
AwsAccountId *string
// The ID of the topic that you want to delete. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
// contains filtered or unexported fields
}
func (*DeleteTopicV2Input) Serialize ¶ added in v1.131.0
func (v *DeleteTopicV2Input) Serialize(s smithy.ShapeSerializer)
func (*DeleteTopicV2Input) SerializeMembers ¶ added in v1.131.0
func (v *DeleteTopicV2Input) SerializeMembers(s smithy.ShapeSerializer)
type DeleteTopicV2Output ¶ added in v1.123.0
type DeleteTopicV2Output struct {
// The Amazon Resource Name (ARN) of the topic.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ID of the topic that you want to delete. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteTopicV2Output) Deserialize ¶ added in v1.131.0
func (v *DeleteTopicV2Output) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteTopicV2Output) Serialize ¶ added in v1.131.0
func (v *DeleteTopicV2Output) Serialize(s smithy.ShapeSerializer)
func (*DeleteTopicV2Output) SerializeMembers ¶ added in v1.131.0
func (v *DeleteTopicV2Output) SerializeMembers(s smithy.ShapeSerializer)
type DeleteUserByPrincipalIdInput ¶
type DeleteUserByPrincipalIdInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The namespace. Currently, you should set this to default .
//
// This member is required.
Namespace *string
// The principal ID of the user.
//
// This member is required.
PrincipalId *string
// contains filtered or unexported fields
}
func (*DeleteUserByPrincipalIdInput) Serialize ¶ added in v1.131.0
func (v *DeleteUserByPrincipalIdInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteUserByPrincipalIdInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteUserByPrincipalIdInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteUserByPrincipalIdOutput ¶
type DeleteUserByPrincipalIdOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteUserByPrincipalIdOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteUserByPrincipalIdOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteUserByPrincipalIdOutput) Serialize ¶ added in v1.131.0
func (v *DeleteUserByPrincipalIdOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteUserByPrincipalIdOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteUserByPrincipalIdOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteUserCustomPermissionInput ¶ added in v1.79.0
type DeleteUserCustomPermissionInput struct {
// The ID of the Amazon Web Services account that contains the custom permission
// configuration that you want to delete.
//
// This member is required.
AwsAccountId *string
// The namespace that the user belongs to.
//
// This member is required.
Namespace *string
// The username of the user that you want to remove custom permissions from.
//
// This member is required.
UserName *string
// contains filtered or unexported fields
}
func (*DeleteUserCustomPermissionInput) Serialize ¶ added in v1.131.0
func (v *DeleteUserCustomPermissionInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteUserCustomPermissionInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteUserCustomPermissionInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteUserCustomPermissionOutput ¶ added in v1.79.0
type DeleteUserCustomPermissionOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteUserCustomPermissionOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteUserCustomPermissionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteUserCustomPermissionOutput) Serialize ¶ added in v1.131.0
func (v *DeleteUserCustomPermissionOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteUserCustomPermissionOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteUserCustomPermissionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteUserInput ¶
type DeleteUserInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The namespace. Currently, you should set this to default .
//
// This member is required.
Namespace *string
// The name of the user that you want to delete.
//
// This member is required.
UserName *string
// contains filtered or unexported fields
}
func (*DeleteUserInput) Serialize ¶ added in v1.131.0
func (v *DeleteUserInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteUserInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteUserInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteUserOutput ¶
type DeleteUserOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteUserOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteUserOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteUserOutput) Serialize ¶ added in v1.131.0
func (v *DeleteUserOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteUserOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteUserOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteVPCConnectionInput ¶ added in v1.35.0
type DeleteVPCConnectionInput struct {
// The Amazon Web Services account ID of the account where you want to delete a
// VPC connection.
//
// This member is required.
AwsAccountId *string
// 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.
//
// This member is required.
VPCConnectionId *string
// contains filtered or unexported fields
}
func (*DeleteVPCConnectionInput) Serialize ¶ added in v1.131.0
func (v *DeleteVPCConnectionInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteVPCConnectionInput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteVPCConnectionInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteVPCConnectionOutput ¶ added in v1.35.0
type DeleteVPCConnectionOutput struct {
// The Amazon Resource Name (ARN) of the deleted VPC connection.
Arn *string
// The availability status of the VPC connection.
AvailabilityStatus types.VPCConnectionAvailabilityStatus
// The deletion status of the VPC connection.
DeletionStatus types.VPCConnectionResourceStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// 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.
VPCConnectionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteVPCConnectionOutput) Deserialize ¶ added in v1.131.0
func (v *DeleteVPCConnectionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteVPCConnectionOutput) Serialize ¶ added in v1.131.0
func (v *DeleteVPCConnectionOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteVPCConnectionOutput) SerializeMembers ¶ added in v1.131.0
func (v *DeleteVPCConnectionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAccountCustomPermissionInput ¶ added in v1.94.0
type DescribeAccountCustomPermissionInput struct {
// The ID of the Amazon Web Services account for which you want to describe the
// applied custom permissions profile.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeAccountCustomPermissionInput) Serialize ¶ added in v1.131.0
func (v *DescribeAccountCustomPermissionInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAccountCustomPermissionInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAccountCustomPermissionInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAccountCustomPermissionOutput ¶ added in v1.94.0
type DescribeAccountCustomPermissionOutput struct {
// The name of the custom permissions profile.
CustomPermissionsName *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeAccountCustomPermissionOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeAccountCustomPermissionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeAccountCustomPermissionOutput) Serialize ¶ added in v1.131.0
func (v *DescribeAccountCustomPermissionOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAccountCustomPermissionOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAccountCustomPermissionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAccountCustomizationInput ¶
type DescribeAccountCustomizationInput struct {
// The ID for the Amazon Web Services account that you want to describe Quick
// Sight customizations for.
//
// This member is required.
AwsAccountId *string
// The Quick Sight namespace that you want to describe Quick Sight customizations
// for.
Namespace *string
// The Resolved flag works with the other parameters to determine which view of
// Quick Sight customizations is returned. You can add this flag to your command to
// use the same view that Quick Sight uses to identify which customizations to
// apply to the console. Omit this flag, or set it to no-resolved , to reveal
// customizations that are configured at different levels.
Resolved bool
// contains filtered or unexported fields
}
func (*DescribeAccountCustomizationInput) Serialize ¶ added in v1.131.0
func (v *DescribeAccountCustomizationInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAccountCustomizationInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAccountCustomizationInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAccountCustomizationOutput ¶
type DescribeAccountCustomizationOutput struct {
// The Quick Sight customizations that exist.
AccountCustomization *types.AccountCustomization
// The Amazon Resource Name (ARN) of the customization that's associated with this
// Amazon Web Services account.
Arn *string
// The ID for the Amazon Web Services account that you're describing.
AwsAccountId *string
// The Quick Sight namespace that you're describing.
Namespace *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeAccountCustomizationOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeAccountCustomizationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeAccountCustomizationOutput) Serialize ¶ added in v1.131.0
func (v *DescribeAccountCustomizationOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAccountCustomizationOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAccountCustomizationOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAccountSettingsInput ¶
type DescribeAccountSettingsInput struct {
// The ID for the Amazon Web Services account that contains the settings that you
// want to list.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeAccountSettingsInput) Serialize ¶ added in v1.131.0
func (v *DescribeAccountSettingsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAccountSettingsInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAccountSettingsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAccountSettingsOutput ¶
type DescribeAccountSettingsOutput struct {
// The Amazon Quick Sight settings for this Amazon Web Services account. This
// information includes the edition of Amazon Quick Sight that you subscribed to
// (Standard or Enterprise) and the notification email for the Amazon Quick Sight
// subscription.
//
// In the Quick Sight console, the Amazon Quick Sight subscription is sometimes
// referred to as a Quick Sight "account" even though it's technically not an
// account by itself. Instead, it's a subscription to the Amazon Quick Sight
// service for your Amazon Web Services account. The edition that you subscribe to
// applies to Quick in every Amazon Web Services Region where you use it.
AccountSettings *types.AccountSettings
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeAccountSettingsOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeAccountSettingsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeAccountSettingsOutput) Serialize ¶ added in v1.131.0
func (v *DescribeAccountSettingsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAccountSettingsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAccountSettingsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAccountSubscriptionInput ¶ added in v1.23.0
type DescribeAccountSubscriptionInput struct {
// The Amazon Web Services account ID associated with your Quick Sight account.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeAccountSubscriptionInput) Serialize ¶ added in v1.131.0
func (v *DescribeAccountSubscriptionInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAccountSubscriptionInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAccountSubscriptionInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAccountSubscriptionOutput ¶ added in v1.23.0
type DescribeAccountSubscriptionOutput struct {
// A structure that contains the following elements:
//
// - Your Quick Sight account name.
//
// - The edition of Quick Sight that your account is using.
//
// - The notification email address that is associated with the Amazon Quick
// Sight account.
//
// - The authentication type of the Quick Sight account.
//
// - The status of the Quick Sight account's subscription.
AccountInfo *types.AccountInfo
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeAccountSubscriptionOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeAccountSubscriptionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeAccountSubscriptionOutput) Serialize ¶ added in v1.131.0
func (v *DescribeAccountSubscriptionOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAccountSubscriptionOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAccountSubscriptionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeActionConnectorInput ¶ added in v1.95.0
type DescribeActionConnectorInput struct {
// The unique identifier of the action connector to describe.
//
// This member is required.
ActionConnectorId *string
// The Amazon Web Services account ID that contains the action connector.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeActionConnectorInput) Serialize ¶ added in v1.131.0
func (v *DescribeActionConnectorInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeActionConnectorInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeActionConnectorInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeActionConnectorOutput ¶ added in v1.95.0
type DescribeActionConnectorOutput struct {
// The detailed information about the action connector, including its
// configuration and current state.
ActionConnector *types.ActionConnector
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status code of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeActionConnectorOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeActionConnectorOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeActionConnectorOutput) Serialize ¶ added in v1.131.0
func (v *DescribeActionConnectorOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeActionConnectorOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeActionConnectorOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeActionConnectorPermissionsInput ¶ added in v1.95.0
type DescribeActionConnectorPermissionsInput struct {
// The unique identifier of the action connector whose permissions you want to
// describe.
//
// This member is required.
ActionConnectorId *string
// The Amazon Web Services account ID that contains the action connector.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeActionConnectorPermissionsInput) Serialize ¶ added in v1.131.0
func (v *DescribeActionConnectorPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeActionConnectorPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeActionConnectorPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeActionConnectorPermissionsOutput ¶ added in v1.95.0
type DescribeActionConnectorPermissionsOutput struct {
// The unique identifier of the action connector.
ActionConnectorId *string
// The Amazon Resource Name (ARN) of the action connector.
Arn *string
// The list of permissions associated with the action connector, including the
// principals and their allowed actions.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status code of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeActionConnectorPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeActionConnectorPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeActionConnectorPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *DescribeActionConnectorPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeActionConnectorPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeActionConnectorPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAgentInput ¶ added in v1.113.0
type DescribeAgentInput struct {
// The unique identifier for the agent.
//
// This member is required.
AgentId *string
// The ID of the Amazon Web Services account that contains the agent.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeAgentInput) Serialize ¶ added in v1.131.0
func (v *DescribeAgentInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAgentInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAgentInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAgentOutput ¶ added in v1.113.0
type DescribeAgentOutput struct {
// The full details of the agent, including its configuration, status, and
// associations.
//
// This member is required.
Agent *types.Agent
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeAgentOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeAgentOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeAgentOutput) Serialize ¶ added in v1.131.0
func (v *DescribeAgentOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAgentOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAgentOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAgentPermissionsInput ¶ added in v1.113.0
type DescribeAgentPermissionsInput struct {
// The unique identifier for the agent.
//
// This member is required.
AgentId *string
// The ID of the Amazon Web Services account that contains the agent.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeAgentPermissionsInput) Serialize ¶ added in v1.131.0
func (v *DescribeAgentPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAgentPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAgentPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAgentPermissionsOutput ¶ added in v1.113.0
type DescribeAgentPermissionsOutput struct {
// The unique identifier for the agent.
//
// This member is required.
AgentId *string
// The Amazon Resource Name (ARN) of the agent.
//
// This member is required.
Arn *string
// The resource permissions for the agent.
//
// This member is required.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
//
// This member is required.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeAgentPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeAgentPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeAgentPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *DescribeAgentPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAgentPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAgentPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAnalysisDefinitionInput ¶ added in v1.28.0
type DescribeAnalysisDefinitionInput struct {
// The ID of the analysis that you're describing. The ID is part of the URL of the
// analysis.
//
// This member is required.
AnalysisId *string
// The ID of the Amazon Web Services account that contains the analysis. You must
// be using the Amazon Web Services account that the analysis is in.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeAnalysisDefinitionInput) Serialize ¶ added in v1.131.0
func (v *DescribeAnalysisDefinitionInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAnalysisDefinitionInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAnalysisDefinitionInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAnalysisDefinitionOutput ¶ added in v1.28.0
type DescribeAnalysisDefinitionOutput struct {
// The ID of the analysis described.
AnalysisId *string
// The definition of an analysis.
//
// A definition is the data model of all features in a Dashboard, Template, or
// Analysis.
Definition *types.AnalysisDefinition
// Errors associated with the analysis.
Errors []types.AnalysisError
// The descriptive name of the analysis.
Name *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// Status associated with the analysis.
//
// - CREATION_IN_PROGRESS
//
// - CREATION_SUCCESSFUL
//
// - CREATION_FAILED
//
// - UPDATE_IN_PROGRESS
//
// - UPDATE_SUCCESSFUL
//
// - UPDATE_FAILED
//
// - DELETED
ResourceStatus types.ResourceStatus
// The HTTP status of the request.
Status int32
// The ARN of the theme of the analysis.
ThemeArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeAnalysisDefinitionOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeAnalysisDefinitionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeAnalysisDefinitionOutput) Serialize ¶ added in v1.131.0
func (v *DescribeAnalysisDefinitionOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAnalysisDefinitionOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAnalysisDefinitionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAnalysisInput ¶ added in v0.29.0
type DescribeAnalysisInput struct {
// The ID of the analysis that you're describing. The ID is part of the URL of the
// analysis.
//
// This member is required.
AnalysisId *string
// The ID of the Amazon Web Services account that contains the analysis. You must
// be using the Amazon Web Services account that the analysis is in.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeAnalysisInput) Serialize ¶ added in v1.131.0
func (v *DescribeAnalysisInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAnalysisInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAnalysisInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAnalysisOutput ¶ added in v0.29.0
type DescribeAnalysisOutput struct {
// A metadata structure that contains summary information for the analysis that
// you're describing.
Analysis *types.Analysis
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeAnalysisOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeAnalysisOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeAnalysisOutput) Serialize ¶ added in v1.131.0
func (v *DescribeAnalysisOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAnalysisOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAnalysisOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAnalysisPermissionsInput ¶ added in v0.29.0
type DescribeAnalysisPermissionsInput struct {
// The ID of the analysis whose permissions you're describing. The ID is part of
// the analysis URL.
//
// This member is required.
AnalysisId *string
// The ID of the Amazon Web Services account that contains the analysis whose
// permissions you're describing. You must be using the Amazon Web Services account
// that the analysis is in.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeAnalysisPermissionsInput) Serialize ¶ added in v1.131.0
func (v *DescribeAnalysisPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAnalysisPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAnalysisPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAnalysisPermissionsOutput ¶ added in v0.29.0
type DescribeAnalysisPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the analysis whose permissions you're
// describing.
AnalysisArn *string
// The ID of the analysis whose permissions you're describing.
AnalysisId *string
// A structure that describes the principals and the resource-level permissions on
// an analysis.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeAnalysisPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeAnalysisPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeAnalysisPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *DescribeAnalysisPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAnalysisPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAnalysisPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAppInput ¶ added in v1.127.0
type DescribeAppInput struct {
// The ID of the app that you want to describe.
//
// This member is required.
AppId *string
// The ID of the Amazon Web Services account that contains the app.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeAppInput) Serialize ¶ added in v1.131.0
func (v *DescribeAppInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAppInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAppInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAppOutput ¶ added in v1.127.0
type DescribeAppOutput struct {
// The information about the app.
//
// This member is required.
App *types.AppSummary
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeAppOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeAppOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeAppOutput) Serialize ¶ added in v1.131.0
func (v *DescribeAppOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAppOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAppOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAppPermissionsInput ¶ added in v1.127.0
type DescribeAppPermissionsInput struct {
// The ID of the app.
//
// This member is required.
AppId *string
// The ID of the Amazon Web Services account that contains the app.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeAppPermissionsInput) Serialize ¶ added in v1.131.0
func (v *DescribeAppPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAppPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAppPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAppPermissionsOutput ¶ added in v1.127.0
type DescribeAppPermissionsOutput struct {
// The ID of the app.
AppId *string
// The Amazon Resource Name (ARN) of the app.
Arn *string
// The resource permissions for the app.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeAppPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeAppPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeAppPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *DescribeAppPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAppPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAppPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeApprovalPolicyInput ¶ added in v1.124.0
type DescribeApprovalPolicyInput struct {
// The unique identifier of the approval policy to describe.
//
// This member is required.
PolicyId *string
// contains filtered or unexported fields
}
func (*DescribeApprovalPolicyInput) Serialize ¶ added in v1.131.0
func (v *DescribeApprovalPolicyInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeApprovalPolicyInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeApprovalPolicyInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeApprovalPolicyOutput ¶ added in v1.124.0
type DescribeApprovalPolicyOutput struct {
// The approval policy.
//
// This member is required.
Policy *types.ApprovalPolicy
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeApprovalPolicyOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeApprovalPolicyOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeApprovalPolicyOutput) Serialize ¶ added in v1.131.0
func (v *DescribeApprovalPolicyOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeApprovalPolicyOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeApprovalPolicyOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAssetBundleExportJobInput ¶ added in v1.36.0
type DescribeAssetBundleExportJobInput struct {
// The ID of the job that you want described. The job ID is set when you start a
// new job with a StartAssetBundleExportJob API call.
//
// This member is required.
AssetBundleExportJobId *string
// The ID of the Amazon Web Services account the export job is executed in.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeAssetBundleExportJobInput) Serialize ¶ added in v1.131.0
func (v *DescribeAssetBundleExportJobInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAssetBundleExportJobInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAssetBundleExportJobInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAssetBundleExportJobOutput ¶ added in v1.36.0
type DescribeAssetBundleExportJobOutput struct {
// The Amazon Resource Name (ARN) for the export job.
Arn *string
// The ID of the job. The job ID is set when you start a new job with a
// StartAssetBundleExportJob API call.
AssetBundleExportJobId *string
// The ID of the Amazon Web Services account that the export job was executed in.
AwsAccountId *string
// The CloudFormation override property configuration for the export job.
CloudFormationOverridePropertyConfiguration *types.AssetBundleCloudFormationOverridePropertyConfiguration
// The time that the export job was created.
CreatedTime *time.Time
// The URL to download the exported asset bundle data from.
//
// This URL is available only after the job has succeeded. This URL is valid for 5
// minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL
// if needed.
//
// The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs . The
// file has a .qs extension.
//
// This URL can't be used in a StartAssetBundleImportJob API call and should only
// be used for download purposes.
DownloadUrl *string
// An array of error records that describes any failures that occurred during the
// export job processing.
//
// Error records accumulate while the job runs. The complete set of error records
// is available after the job has completed and failed.
Errors []types.AssetBundleExportJobError
// The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can
// be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON
// formatted file can be used in the CloudFormation console and with the
// CloudFormation APIs.
ExportFormat types.AssetBundleExportFormat
// The include dependencies flag.
IncludeAllDependencies bool
// A setting that determines whether folder members are included.
IncludeFolderMembers types.IncludeFolderMembers
// The include folder memberships flag.
IncludeFolderMemberships bool
// The include permissions flag.
IncludePermissions bool
// The include tags flag.
IncludeTags bool
// Indicates the status of a job through its queuing and execution.
//
// Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or
// FAILED .
JobStatus types.AssetBundleExportJobStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// A list of resource ARNs that exported with the job.
ResourceArns []string
// The HTTP status of the response.
Status int32
// The validation strategy that is used to export the analysis or dashboard.
ValidationStrategy *types.AssetBundleExportJobValidationStrategy
// An array of warning records that describe the analysis or dashboard that is
// exported. This array includes UI errors that can be skipped during the
// validation process.
//
// This property only appears if StrictModeForAllResources in ValidationStrategy
// is set to FALSE .
Warnings []types.AssetBundleExportJobWarning
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeAssetBundleExportJobOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeAssetBundleExportJobOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeAssetBundleExportJobOutput) Serialize ¶ added in v1.131.0
func (v *DescribeAssetBundleExportJobOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAssetBundleExportJobOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAssetBundleExportJobOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAssetBundleImportJobInput ¶ added in v1.36.0
type DescribeAssetBundleImportJobInput struct {
// The ID of the job. The job ID is set when you start a new job with a
// StartAssetBundleImportJob API call.
//
// This member is required.
AssetBundleImportJobId *string
// The ID of the Amazon Web Services account the import job was executed in.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeAssetBundleImportJobInput) Serialize ¶ added in v1.131.0
func (v *DescribeAssetBundleImportJobInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAssetBundleImportJobInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAssetBundleImportJobInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAssetBundleImportJobOutput ¶ added in v1.36.0
type DescribeAssetBundleImportJobOutput struct {
// The Amazon Resource Name (ARN) for the import job.
Arn *string
// The ID of the job. The job ID is set when you start a new job with a
// StartAssetBundleImportJob API call.
AssetBundleImportJobId *string
// The source of the asset bundle zip file that contains the data that is imported
// by the job.
AssetBundleImportSource *types.AssetBundleImportSourceDescription
// The ID of the Amazon Web Services account the import job was executed in.
AwsAccountId *string
// The time that the import job was created.
CreatedTime *time.Time
// An array of error records that describes any failures that occurred during the
// export job processing.
//
// Error records accumulate while the job is still running. The complete set of
// error records is available after the job has completed and failed.
Errors []types.AssetBundleImportJobError
// The failure action for the import job.
FailureAction types.AssetBundleImportFailureAction
// Indicates the status of a job through its queuing and execution.
//
// Poll the DescribeAssetBundleImport API until JobStatus returns one of the
// following values:
//
// - SUCCESSFUL
//
// - FAILED
//
// - FAILED_ROLLBACK_COMPLETED
//
// - FAILED_ROLLBACK_ERROR
JobStatus types.AssetBundleImportJobStatus
// Optional overrides that are applied to the resource configuration before import.
OverrideParameters *types.AssetBundleImportJobOverrideParameters
// Optional permission overrides that are applied to the resource configuration
// before import.
OverridePermissions *types.AssetBundleImportJobOverridePermissions
// Optional tag overrides that are applied to the resource configuration before
// import.
OverrideTags *types.AssetBundleImportJobOverrideTags
// An optional validation strategy override for all analyses and dashboards to be
// applied to the resource configuration before import.
OverrideValidationStrategy *types.AssetBundleImportJobOverrideValidationStrategy
// The Amazon Web Services request ID for this operation.
RequestId *string
// An array of error records that describes any failures that occurred while an
// import job was attempting a rollback.
//
// Error records accumulate while the job is still running. The complete set of
// error records is available after the job has completed and failed.
RollbackErrors []types.AssetBundleImportJobError
// The HTTP status of the response.
Status int32
// An array of warning records that describe all permitted errors that are
// encountered during the import job.
Warnings []types.AssetBundleImportJobWarning
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeAssetBundleImportJobOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeAssetBundleImportJobOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeAssetBundleImportJobOutput) Serialize ¶ added in v1.131.0
func (v *DescribeAssetBundleImportJobOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAssetBundleImportJobOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAssetBundleImportJobOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAutomationJobInput ¶ added in v1.106.0
type DescribeAutomationJobInput struct {
// The ID of the automation group that contains the automation.
//
// This member is required.
AutomationGroupId *string
// The ID of the automation that the job belongs to.
//
// This member is required.
AutomationId *string
// The ID of the Amazon Web Services account that contains the automation job.
//
// This member is required.
AwsAccountId *string
// The ID of the automation job to describe.
//
// This member is required.
JobId *string
// A Boolean value that indicates whether to include the input payload in the
// response. If set to true , the input payload will be included. If set to false ,
// the input payload will be returned as null .
IncludeInputPayload bool
// A Boolean value that indicates whether to include the output payload in the
// response. If set to true , the output payload will be included. If set to false
// , the output payload will be returned as null .
IncludeOutputPayload bool
// contains filtered or unexported fields
}
func (*DescribeAutomationJobInput) Serialize ¶ added in v1.131.0
func (v *DescribeAutomationJobInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAutomationJobInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAutomationJobInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeAutomationJobOutput ¶ added in v1.106.0
type DescribeAutomationJobOutput struct {
// The Amazon Resource Name (ARN) of the automation job.
//
// This member is required.
Arn *string
// The current status of the automation job.
//
// This member is required.
JobStatus types.AutomationJobStatus
// The time that the automation job was created.
CreatedAt *time.Time
// The time that the automation job finished running.
EndedAt *time.Time
// The input payload that was provided when the automation job was started. This
// field is only included when IncludeInputPayload is set to true in the request.
InputPayload *string
// The output payload that was generated by the automation job. This field is only
// included when IncludeOutputPayload is set to true in the request.
OutputPayload *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The time that the automation job started running.
StartedAt *time.Time
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeAutomationJobOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeAutomationJobOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeAutomationJobOutput) Serialize ¶ added in v1.131.0
func (v *DescribeAutomationJobOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeAutomationJobOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeAutomationJobOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeBrandAssignmentInput ¶ added in v1.79.0
type DescribeBrandAssignmentInput struct {
// The ID of the Amazon Web Services account that owns the brand assignment.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeBrandAssignmentInput) Serialize ¶ added in v1.131.0
func (v *DescribeBrandAssignmentInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeBrandAssignmentInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeBrandAssignmentInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeBrandAssignmentOutput ¶ added in v1.79.0
type DescribeBrandAssignmentOutput struct {
// The Amazon Resource Name (ARN) of the brand.
BrandArn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeBrandAssignmentOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeBrandAssignmentOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeBrandAssignmentOutput) Serialize ¶ added in v1.131.0
func (v *DescribeBrandAssignmentOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeBrandAssignmentOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeBrandAssignmentOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeBrandInput ¶ added in v1.79.0
type DescribeBrandInput struct {
// The ID of the Amazon Web Services account that owns the brand.
//
// This member is required.
AwsAccountId *string
// The ID of the Quick brand.
//
// This member is required.
BrandId *string
// The ID of the specific version. The default value is the latest version.
VersionId *string
// contains filtered or unexported fields
}
func (*DescribeBrandInput) Serialize ¶ added in v1.131.0
func (v *DescribeBrandInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeBrandInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeBrandInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeBrandOutput ¶ added in v1.79.0
type DescribeBrandOutput struct {
// The definition of the brand.
BrandDefinition *types.BrandDefinition
// The details of the brand.
BrandDetail *types.BrandDetail
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeBrandOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeBrandOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeBrandOutput) Serialize ¶ added in v1.131.0
func (v *DescribeBrandOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeBrandOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeBrandOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeBrandPublishedVersionInput ¶ added in v1.79.0
type DescribeBrandPublishedVersionInput struct {
// The ID of the Amazon Web Services account that owns the brand.
//
// This member is required.
AwsAccountId *string
// The ID of the Quick brand.
//
// This member is required.
BrandId *string
// contains filtered or unexported fields
}
func (*DescribeBrandPublishedVersionInput) Serialize ¶ added in v1.131.0
func (v *DescribeBrandPublishedVersionInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeBrandPublishedVersionInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeBrandPublishedVersionInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeBrandPublishedVersionOutput ¶ added in v1.79.0
type DescribeBrandPublishedVersionOutput struct {
// The definition of the brand.
BrandDefinition *types.BrandDefinition
// The details of the brand.
BrandDetail *types.BrandDetail
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeBrandPublishedVersionOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeBrandPublishedVersionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeBrandPublishedVersionOutput) Serialize ¶ added in v1.131.0
func (v *DescribeBrandPublishedVersionOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeBrandPublishedVersionOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeBrandPublishedVersionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeCustomPermissionsInput ¶ added in v1.79.0
type DescribeCustomPermissionsInput struct {
// The ID of the Amazon Web Services account that contains the custom permissions
// profile that you want described.
//
// This member is required.
AwsAccountId *string
// The name of the custom permissions profile to describe.
//
// This member is required.
CustomPermissionsName *string
// contains filtered or unexported fields
}
func (*DescribeCustomPermissionsInput) Serialize ¶ added in v1.131.0
func (v *DescribeCustomPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeCustomPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeCustomPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeCustomPermissionsOutput ¶ added in v1.79.0
type DescribeCustomPermissionsOutput struct {
// The custom permissions profile.
CustomPermissions *types.CustomPermissions
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeCustomPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeCustomPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeCustomPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *DescribeCustomPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeCustomPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeCustomPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDashboardDefinitionInput ¶ added in v1.28.0
type DescribeDashboardDefinitionInput struct {
// The ID of the Amazon Web Services account that contains the dashboard that
// you're describing.
//
// This member is required.
AwsAccountId *string
// The ID for the dashboard.
//
// This member is required.
DashboardId *string
// The alias name.
AliasName *string
// The version number for the dashboard. If a version number isn't passed, the
// latest published dashboard version is described.
VersionNumber *int64
// contains filtered or unexported fields
}
func (*DescribeDashboardDefinitionInput) Serialize ¶ added in v1.131.0
func (v *DescribeDashboardDefinitionInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDashboardDefinitionInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDashboardDefinitionInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDashboardDefinitionOutput ¶ added in v1.28.0
type DescribeDashboardDefinitionOutput struct {
// The ID of the dashboard described.
DashboardId *string
// Options for publishing the dashboard:
//
// - AvailabilityStatus for AdHocFilteringOption - This status can be either
// ENABLED or DISABLED . When this is set to DISABLED , Amazon Quick Sight
// disables the left filter pane on the published dashboard, which can be used for
// ad hoc (one-time) filtering. This option is ENABLED by default.
//
// - AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED
// or DISABLED . The visual option to export data to .CSV format isn't enabled
// when this is set to DISABLED . This option is ENABLED by default.
//
// - VisibilityState for SheetControlsOption - This visibility state can be
// either COLLAPSED or EXPANDED . This option is COLLAPSED by default.
//
// - AvailabilityStatus for QuickSuiteActionsOption - This status can be either
// ENABLED or DISABLED . Features related to Actions in Amazon Quick Suite on
// dashboards are disabled when this is set to DISABLED . This option is DISABLED
// by default.
//
// - AvailabilityStatus for ExecutiveSummaryOption - This status can be either
// ENABLED or DISABLED . The option to build an executive summary is disabled
// when this is set to DISABLED . This option is ENABLED by default.
//
// - AvailabilityStatus for DataStoriesSharingOption - This status can be either
// ENABLED or DISABLED . The option to share a data story is disabled when this
// is set to DISABLED . This option is ENABLED by default.
DashboardPublishOptions *types.DashboardPublishOptions
// The definition of a dashboard.
//
// A definition is the data model of all features in a Dashboard, Template, or
// Analysis.
Definition *types.DashboardVersionDefinition
// Errors associated with this dashboard version.
Errors []types.DashboardError
// The display name of the dashboard.
Name *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// Status associated with the dashboard version.
//
// - CREATION_IN_PROGRESS
//
// - CREATION_SUCCESSFUL
//
// - CREATION_FAILED
//
// - UPDATE_IN_PROGRESS
//
// - UPDATE_SUCCESSFUL
//
// - UPDATE_FAILED
//
// - DELETED
ResourceStatus types.ResourceStatus
// The HTTP status of the request.
Status int32
// The ARN of the theme of the dashboard.
ThemeArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeDashboardDefinitionOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeDashboardDefinitionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeDashboardDefinitionOutput) Serialize ¶ added in v1.131.0
func (v *DescribeDashboardDefinitionOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDashboardDefinitionOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDashboardDefinitionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDashboardInput ¶
type DescribeDashboardInput struct {
// The ID of the Amazon Web Services account that contains the dashboard that
// you're describing.
//
// This member is required.
AwsAccountId *string
// The ID for the dashboard.
//
// This member is required.
DashboardId *string
// The alias name.
AliasName *string
// The version number for the dashboard. If a version number isn't passed, the
// latest published dashboard version is described.
VersionNumber *int64
// contains filtered or unexported fields
}
func (*DescribeDashboardInput) Serialize ¶ added in v1.131.0
func (v *DescribeDashboardInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDashboardInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDashboardInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDashboardOutput ¶
type DescribeDashboardOutput struct {
// Information about the dashboard.
Dashboard *types.Dashboard
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of this request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeDashboardOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeDashboardOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeDashboardOutput) Serialize ¶ added in v1.131.0
func (v *DescribeDashboardOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDashboardOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDashboardOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDashboardPermissionsInput ¶
type DescribeDashboardPermissionsInput struct {
// The ID of the Amazon Web Services account that contains the dashboard that
// you're describing permissions for.
//
// This member is required.
AwsAccountId *string
// The ID for the dashboard, also added to the IAM policy.
//
// This member is required.
DashboardId *string
// contains filtered or unexported fields
}
func (*DescribeDashboardPermissionsInput) Serialize ¶ added in v1.131.0
func (v *DescribeDashboardPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDashboardPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDashboardPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDashboardPermissionsOutput ¶
type DescribeDashboardPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the dashboard.
DashboardArn *string
// The ID for the dashboard.
DashboardId *string
// A structure that contains the configuration of a shareable link that grants
// access to the dashboard. Your users can use the link to view and interact with
// the dashboard, if the dashboard has been shared with them. For more information
// about sharing dashboards, see [Sharing Dashboards].
//
// [Sharing Dashboards]: https://docs.aws.amazon.com/quicksight/latest/user/sharing-a-dashboard.html
LinkSharingConfiguration *types.LinkSharingConfiguration
// A structure that contains the permissions for the dashboard.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeDashboardPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeDashboardPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeDashboardPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *DescribeDashboardPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDashboardPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDashboardPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDashboardSnapshotJobInput ¶ added in v1.39.0
type DescribeDashboardSnapshotJobInput struct {
// The ID of the Amazon Web Services account that the dashboard snapshot job is
// executed in.
//
// This member is required.
AwsAccountId *string
// The ID of the dashboard that you have started a snapshot job for.
//
// This member is required.
DashboardId *string
// The ID of the job to be described. The job ID is set when you start a new job
// with a StartDashboardSnapshotJob API call.
//
// This member is required.
SnapshotJobId *string
// contains filtered or unexported fields
}
func (*DescribeDashboardSnapshotJobInput) Serialize ¶ added in v1.131.0
func (v *DescribeDashboardSnapshotJobInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDashboardSnapshotJobInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDashboardSnapshotJobInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDashboardSnapshotJobOutput ¶ added in v1.39.0
type DescribeDashboardSnapshotJobOutput struct {
// The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated
// when you start a new job with a StartDashboardSnapshotJob API call.
Arn *string
// The ID of the Amazon Web Services account that the dashboard snapshot job is
// executed in.
AwsAccountId *string
// The time that the snapshot job was created.
CreatedTime *time.Time
// The ID of the dashboard that you have started a snapshot job for.
DashboardId *string
// Indicates the status of a job. The status updates as the job executes. This
// shows one of the following values.
//
// - COMPLETED - The job was completed successfully.
//
// - FAILED - The job failed to execute.
//
// - QUEUED - The job is queued and hasn't started yet.
//
// - RUNNING - The job is still running.
JobStatus types.SnapshotJobStatus
// The time that the snapshot job status was last updated.
LastUpdatedTime *time.Time
// The Amazon Web Services request ID for this operation.
RequestId *string
// The snapshot configuration of the job. This information is provided when you
// make a StartDashboardSnapshotJob API call.
SnapshotConfiguration *types.SnapshotConfiguration
// The ID of the job to be described. The job ID is set when you start a new job
// with a StartDashboardSnapshotJob API call.
SnapshotJobId *string
// The HTTP status of the request
Status int32
// The user configuration for the snapshot job. This information is provided when
// you make a StartDashboardSnapshotJob API call.
UserConfiguration *types.SnapshotUserConfigurationRedacted
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeDashboardSnapshotJobOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeDashboardSnapshotJobOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeDashboardSnapshotJobOutput) Serialize ¶ added in v1.131.0
func (v *DescribeDashboardSnapshotJobOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDashboardSnapshotJobOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDashboardSnapshotJobOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDashboardSnapshotJobResultInput ¶ added in v1.39.0
type DescribeDashboardSnapshotJobResultInput struct {
// The ID of the Amazon Web Services account that the dashboard snapshot job is
// executed in.
//
// This member is required.
AwsAccountId *string
// The ID of the dashboard that you have started a snapshot job for.
//
// This member is required.
DashboardId *string
// The ID of the job to be described. The job ID is set when you start a new job
// with a StartDashboardSnapshotJob API call.
//
// This member is required.
SnapshotJobId *string
// contains filtered or unexported fields
}
func (*DescribeDashboardSnapshotJobResultInput) Serialize ¶ added in v1.131.0
func (v *DescribeDashboardSnapshotJobResultInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDashboardSnapshotJobResultInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDashboardSnapshotJobResultInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDashboardSnapshotJobResultOutput ¶ added in v1.39.0
type DescribeDashboardSnapshotJobResultOutput struct {
// The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated
// when you start a new job with a StartDashboardSnapshotJob API call.
Arn *string
// The time that a snapshot job was created.
CreatedTime *time.Time
// Displays information for the error that caused a job to fail.
ErrorInfo *types.SnapshotJobErrorInfo
// Indicates the status of a job after it has reached a terminal state. A finished
// snapshot job will retuen a COMPLETED or FAILED status.
JobStatus types.SnapshotJobStatus
// The time that a snapshot job status was last updated.
LastUpdatedTime *time.Time
// The Amazon Web Services request ID for this operation.
RequestId *string
// The result of the snapshot job. Jobs that have successfully completed will
// return the S3Uri where they are located. Jobs that have failedwill return
// information on the error that caused the job to fail.
Result *types.SnapshotJobResult
// The HTTP status of the request
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeDashboardSnapshotJobResultOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeDashboardSnapshotJobResultOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeDashboardSnapshotJobResultOutput) Serialize ¶ added in v1.131.0
func (v *DescribeDashboardSnapshotJobResultOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDashboardSnapshotJobResultOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDashboardSnapshotJobResultOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDashboardsQAConfigurationInput ¶ added in v1.80.0
type DescribeDashboardsQAConfigurationInput struct {
// The ID of the Amazon Web Services account that contains the dashboard QA
// configuration that you want described.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeDashboardsQAConfigurationInput) Serialize ¶ added in v1.131.0
func (v *DescribeDashboardsQAConfigurationInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDashboardsQAConfigurationInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDashboardsQAConfigurationInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDashboardsQAConfigurationOutput ¶ added in v1.80.0
type DescribeDashboardsQAConfigurationOutput struct {
// The status of dashboards QA configuration that you want described.
DashboardsQAStatus types.DashboardsQAStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeDashboardsQAConfigurationOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeDashboardsQAConfigurationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeDashboardsQAConfigurationOutput) Serialize ¶ added in v1.131.0
func (v *DescribeDashboardsQAConfigurationOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDashboardsQAConfigurationOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDashboardsQAConfigurationOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDataSetInput ¶
type DescribeDataSetInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// 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.
//
// This member is required.
DataSetId *string
// contains filtered or unexported fields
}
func (*DescribeDataSetInput) Serialize ¶ added in v1.131.0
func (v *DescribeDataSetInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDataSetInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDataSetInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDataSetOutput ¶
type DescribeDataSetOutput struct {
// Information on the dataset.
DataSet *types.DataSet
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeDataSetOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeDataSetOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeDataSetOutput) Serialize ¶ added in v1.131.0
func (v *DescribeDataSetOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDataSetOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDataSetOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDataSetPermissionsInput ¶
type DescribeDataSetPermissionsInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// 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.
//
// This member is required.
DataSetId *string
// contains filtered or unexported fields
}
func (*DescribeDataSetPermissionsInput) Serialize ¶ added in v1.131.0
func (v *DescribeDataSetPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDataSetPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDataSetPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDataSetPermissionsOutput ¶
type DescribeDataSetPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the dataset.
DataSetArn *string
// 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.
DataSetId *string
// A list of resource permissions on the dataset.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeDataSetPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeDataSetPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeDataSetPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *DescribeDataSetPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDataSetPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDataSetPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDataSetRefreshPropertiesInput ¶ added in v1.34.0
type DescribeDataSetRefreshPropertiesInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset.
//
// This member is required.
DataSetId *string
// contains filtered or unexported fields
}
func (*DescribeDataSetRefreshPropertiesInput) Serialize ¶ added in v1.131.0
func (v *DescribeDataSetRefreshPropertiesInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDataSetRefreshPropertiesInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDataSetRefreshPropertiesInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDataSetRefreshPropertiesOutput ¶ added in v1.34.0
type DescribeDataSetRefreshPropertiesOutput struct {
// The dataset refresh properties.
DataSetRefreshProperties *types.DataSetRefreshProperties
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeDataSetRefreshPropertiesOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeDataSetRefreshPropertiesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeDataSetRefreshPropertiesOutput) Serialize ¶ added in v1.131.0
func (v *DescribeDataSetRefreshPropertiesOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDataSetRefreshPropertiesOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDataSetRefreshPropertiesOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDataSourceInput ¶
type DescribeDataSourceInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
//
// This member is required.
DataSourceId *string
// contains filtered or unexported fields
}
func (*DescribeDataSourceInput) Serialize ¶ added in v1.131.0
func (v *DescribeDataSourceInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDataSourceInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDataSourceInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDataSourceOutput ¶
type DescribeDataSourceOutput struct {
// The information on the data source.
DataSource *types.DataSource
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeDataSourceOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeDataSourceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeDataSourceOutput) Serialize ¶ added in v1.131.0
func (v *DescribeDataSourceOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDataSourceOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDataSourceOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDataSourcePermissionsInput ¶
type DescribeDataSourcePermissionsInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
//
// This member is required.
DataSourceId *string
// contains filtered or unexported fields
}
func (*DescribeDataSourcePermissionsInput) Serialize ¶ added in v1.131.0
func (v *DescribeDataSourcePermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDataSourcePermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDataSourcePermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDataSourcePermissionsOutput ¶
type DescribeDataSourcePermissionsOutput struct {
// The Amazon Resource Name (ARN) of the data source.
DataSourceArn *string
// The ID of the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
DataSourceId *string
// A list of resource permissions on the data source.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeDataSourcePermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeDataSourcePermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeDataSourcePermissionsOutput) Serialize ¶ added in v1.131.0
func (v *DescribeDataSourcePermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDataSourcePermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDataSourcePermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDefaultQBusinessApplicationInput ¶ added in v1.81.0
type DescribeDefaultQBusinessApplicationInput struct {
// The ID of the Quick Sight account that is linked to the Amazon Q Business
// application that you want described.
//
// This member is required.
AwsAccountId *string
// 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.
Namespace *string
// contains filtered or unexported fields
}
func (*DescribeDefaultQBusinessApplicationInput) Serialize ¶ added in v1.131.0
func (v *DescribeDefaultQBusinessApplicationInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDefaultQBusinessApplicationInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDefaultQBusinessApplicationInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDefaultQBusinessApplicationOutput ¶ added in v1.81.0
type DescribeDefaultQBusinessApplicationOutput struct {
// The ID of the Amazon Q Business application that is linked to the Quick Sight
// account.
ApplicationId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeDefaultQBusinessApplicationOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeDefaultQBusinessApplicationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeDefaultQBusinessApplicationOutput) Serialize ¶ added in v1.131.0
func (v *DescribeDefaultQBusinessApplicationOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDefaultQBusinessApplicationOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDefaultQBusinessApplicationOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDlpSettingInput ¶ added in v1.124.0
type DescribeDlpSettingInput struct {
// The ID of the Amazon Web Services account that contains the DLP setting that
// you want to describe.
//
// This member is required.
AwsAccountId *string
// The ID of the DLP setting that you want to describe.
//
// This member is required.
DlpSettingId *string
// contains filtered or unexported fields
}
func (*DescribeDlpSettingInput) Serialize ¶ added in v1.131.0
func (v *DescribeDlpSettingInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDlpSettingInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDlpSettingInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeDlpSettingOutput ¶ added in v1.124.0
type DescribeDlpSettingOutput struct {
// The full configuration of the requested DLP setting, returned as a
// DlpSettingDetails object.
//
// This member is required.
DlpSetting *types.DlpSettingDetails
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeDlpSettingOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeDlpSettingOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeDlpSettingOutput) Serialize ¶ added in v1.131.0
func (v *DescribeDlpSettingOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeDlpSettingOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeDlpSettingOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeFlowInput ¶ added in v1.113.0
type DescribeFlowInput struct {
// The ID of the Amazon Web Services account that contains the flow that you are
// describing.
//
// This member is required.
AwsAccountId *string
// The unique identifier of the flow.
//
// This member is required.
FlowId *string
// The publish state of the flow version to describe. Valid values are DRAFT ,
// PUBLISHED , or PENDING_APPROVAL .
//
// This member is required.
PublishState types.FlowPublishState
// contains filtered or unexported fields
}
func (*DescribeFlowInput) Serialize ¶ added in v1.131.0
func (v *DescribeFlowInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeFlowInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeFlowInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeFlowOutput ¶ added in v1.113.0
type DescribeFlowOutput struct {
// The full details of the flow.
//
// This member is required.
Flow *types.FlowDetail
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeFlowOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeFlowOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeFlowOutput) Serialize ¶ added in v1.131.0
func (v *DescribeFlowOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeFlowOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeFlowOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeFolderInput ¶ added in v1.6.0
type DescribeFolderInput struct {
// The ID for the Amazon Web Services account that contains the folder.
//
// This member is required.
AwsAccountId *string
// The ID of the folder.
//
// This member is required.
FolderId *string
// contains filtered or unexported fields
}
func (*DescribeFolderInput) Serialize ¶ added in v1.131.0
func (v *DescribeFolderInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeFolderInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeFolderInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeFolderOutput ¶ added in v1.6.0
type DescribeFolderOutput struct {
// Information about the folder.
Folder *types.Folder
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeFolderOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeFolderOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeFolderOutput) Serialize ¶ added in v1.131.0
func (v *DescribeFolderOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeFolderOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeFolderOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeFolderPermissionsAPIClient ¶ added in v1.42.0
type DescribeFolderPermissionsAPIClient interface {
DescribeFolderPermissions(context.Context, *DescribeFolderPermissionsInput, ...func(*Options)) (*DescribeFolderPermissionsOutput, error)
}
DescribeFolderPermissionsAPIClient is a client that implements the DescribeFolderPermissions operation.
type DescribeFolderPermissionsInput ¶ added in v1.6.0
type DescribeFolderPermissionsInput struct {
// The ID for the Amazon Web Services account that contains the folder.
//
// This member is required.
AwsAccountId *string
// The ID of the folder.
//
// This member is required.
FolderId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The namespace of the folder whose permissions you want described.
Namespace *string
// A pagination token for the next set of results.
NextToken *string
// contains filtered or unexported fields
}
func (*DescribeFolderPermissionsInput) Serialize ¶ added in v1.131.0
func (v *DescribeFolderPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeFolderPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeFolderPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeFolderPermissionsOutput ¶ added in v1.6.0
type DescribeFolderPermissionsOutput struct {
// The Amazon Resource Name (ARN) for the folder.
Arn *string
// The ID of the folder.
FolderId *string
// The pagination token for the next set of results, or null if there are no more
// results.
NextToken *string
// Information about the permissions on the folder.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeFolderPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeFolderPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeFolderPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *DescribeFolderPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeFolderPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeFolderPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeFolderPermissionsPaginator ¶ added in v1.42.0
type DescribeFolderPermissionsPaginator struct {
// contains filtered or unexported fields
}
DescribeFolderPermissionsPaginator is a paginator for DescribeFolderPermissions
func NewDescribeFolderPermissionsPaginator ¶ added in v1.42.0
func NewDescribeFolderPermissionsPaginator(client DescribeFolderPermissionsAPIClient, params *DescribeFolderPermissionsInput, optFns ...func(*DescribeFolderPermissionsPaginatorOptions)) *DescribeFolderPermissionsPaginator
NewDescribeFolderPermissionsPaginator returns a new DescribeFolderPermissionsPaginator
func (*DescribeFolderPermissionsPaginator) HasMorePages ¶ added in v1.42.0
func (p *DescribeFolderPermissionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeFolderPermissionsPaginator) NextPage ¶ added in v1.42.0
func (p *DescribeFolderPermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeFolderPermissionsOutput, error)
NextPage retrieves the next DescribeFolderPermissions page.
type DescribeFolderPermissionsPaginatorOptions ¶ added in v1.42.0
type DescribeFolderPermissionsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
DescribeFolderPermissionsPaginatorOptions is the paginator options for DescribeFolderPermissions
type DescribeFolderResolvedPermissionsAPIClient ¶ added in v1.42.0
type DescribeFolderResolvedPermissionsAPIClient interface {
DescribeFolderResolvedPermissions(context.Context, *DescribeFolderResolvedPermissionsInput, ...func(*Options)) (*DescribeFolderResolvedPermissionsOutput, error)
}
DescribeFolderResolvedPermissionsAPIClient is a client that implements the DescribeFolderResolvedPermissions operation.
type DescribeFolderResolvedPermissionsInput ¶ added in v1.6.0
type DescribeFolderResolvedPermissionsInput struct {
// The ID for the Amazon Web Services account that contains the folder.
//
// This member is required.
AwsAccountId *string
// The ID of the folder.
//
// This member is required.
FolderId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The namespace of the folder whose permissions you want described.
Namespace *string
// A pagination token for the next set of results.
NextToken *string
// contains filtered or unexported fields
}
func (*DescribeFolderResolvedPermissionsInput) Serialize ¶ added in v1.131.0
func (v *DescribeFolderResolvedPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeFolderResolvedPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeFolderResolvedPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeFolderResolvedPermissionsOutput ¶ added in v1.6.0
type DescribeFolderResolvedPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the folder.
Arn *string
// The ID of the folder.
FolderId *string
// A pagination token for the next set of results, or null if there are no more
// results.
NextToken *string
// Information about the permissions for the folder.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeFolderResolvedPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeFolderResolvedPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeFolderResolvedPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *DescribeFolderResolvedPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeFolderResolvedPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeFolderResolvedPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeFolderResolvedPermissionsPaginator ¶ added in v1.42.0
type DescribeFolderResolvedPermissionsPaginator struct {
// contains filtered or unexported fields
}
DescribeFolderResolvedPermissionsPaginator is a paginator for DescribeFolderResolvedPermissions
func NewDescribeFolderResolvedPermissionsPaginator ¶ added in v1.42.0
func NewDescribeFolderResolvedPermissionsPaginator(client DescribeFolderResolvedPermissionsAPIClient, params *DescribeFolderResolvedPermissionsInput, optFns ...func(*DescribeFolderResolvedPermissionsPaginatorOptions)) *DescribeFolderResolvedPermissionsPaginator
NewDescribeFolderResolvedPermissionsPaginator returns a new DescribeFolderResolvedPermissionsPaginator
func (*DescribeFolderResolvedPermissionsPaginator) HasMorePages ¶ added in v1.42.0
func (p *DescribeFolderResolvedPermissionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeFolderResolvedPermissionsPaginator) NextPage ¶ added in v1.42.0
func (p *DescribeFolderResolvedPermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeFolderResolvedPermissionsOutput, error)
NextPage retrieves the next DescribeFolderResolvedPermissions page.
type DescribeFolderResolvedPermissionsPaginatorOptions ¶ added in v1.42.0
type DescribeFolderResolvedPermissionsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
DescribeFolderResolvedPermissionsPaginatorOptions is the paginator options for DescribeFolderResolvedPermissions
type DescribeGroupInput ¶
type DescribeGroupInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The name of the group that you want to describe.
//
// This member is required.
GroupName *string
// The namespace of the group that you want described.
//
// This member is required.
Namespace *string
// contains filtered or unexported fields
}
func (*DescribeGroupInput) Serialize ¶ added in v1.131.0
func (v *DescribeGroupInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeGroupInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeGroupInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeGroupMembershipInput ¶ added in v1.21.0
type DescribeGroupMembershipInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The name of the group that you want to search.
//
// This member is required.
GroupName *string
// The user name of the user that you want to search for.
//
// This member is required.
MemberName *string
// The namespace that includes the group you are searching within.
//
// This member is required.
Namespace *string
// contains filtered or unexported fields
}
func (*DescribeGroupMembershipInput) Serialize ¶ added in v1.131.0
func (v *DescribeGroupMembershipInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeGroupMembershipInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeGroupMembershipInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeGroupMembershipOutput ¶ added in v1.21.0
type DescribeGroupMembershipOutput struct {
// A member of an Quick Sight group. Currently, group members must be users.
// Groups can't be members of another group. .
GroupMember *types.GroupMember
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeGroupMembershipOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeGroupMembershipOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeGroupMembershipOutput) Serialize ¶ added in v1.131.0
func (v *DescribeGroupMembershipOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeGroupMembershipOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeGroupMembershipOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeGroupOutput ¶
type DescribeGroupOutput struct {
// The name of the group.
Group *types.Group
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeGroupOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeGroupOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeGroupOutput) Serialize ¶ added in v1.131.0
func (v *DescribeGroupOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeGroupOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeGroupOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeIAMPolicyAssignmentInput ¶
type DescribeIAMPolicyAssignmentInput struct {
// The name of the assignment, also called a rule.
//
// This member is required.
AssignmentName *string
// The ID of the Amazon Web Services account that contains the assignment that you
// want to describe.
//
// This member is required.
AwsAccountId *string
// The namespace that contains the assignment.
//
// This member is required.
Namespace *string
// contains filtered or unexported fields
}
func (*DescribeIAMPolicyAssignmentInput) Serialize ¶ added in v1.131.0
func (v *DescribeIAMPolicyAssignmentInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeIAMPolicyAssignmentInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeIAMPolicyAssignmentInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeIAMPolicyAssignmentOutput ¶
type DescribeIAMPolicyAssignmentOutput struct {
// Information describing the IAM policy assignment.
IAMPolicyAssignment *types.IAMPolicyAssignment
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeIAMPolicyAssignmentOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeIAMPolicyAssignmentOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeIAMPolicyAssignmentOutput) Serialize ¶ added in v1.131.0
func (v *DescribeIAMPolicyAssignmentOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeIAMPolicyAssignmentOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeIAMPolicyAssignmentOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeIngestionInput ¶
type DescribeIngestionInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset used in the ingestion.
//
// This member is required.
DataSetId *string
// An ID for the ingestion.
//
// This member is required.
IngestionId *string
// contains filtered or unexported fields
}
func (*DescribeIngestionInput) Serialize ¶ added in v1.131.0
func (v *DescribeIngestionInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeIngestionInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeIngestionInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeIngestionOutput ¶
type DescribeIngestionOutput struct {
// Information about the ingestion.
Ingestion *types.Ingestion
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeIngestionOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeIngestionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeIngestionOutput) Serialize ¶ added in v1.131.0
func (v *DescribeIngestionOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeIngestionOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeIngestionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeIpRestrictionInput ¶ added in v1.13.0
type DescribeIpRestrictionInput struct {
// The ID of the Amazon Web Services account that contains the IP rules.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeIpRestrictionInput) Serialize ¶ added in v1.131.0
func (v *DescribeIpRestrictionInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeIpRestrictionInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeIpRestrictionInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeIpRestrictionOutput ¶ added in v1.13.0
type DescribeIpRestrictionOutput struct {
// The ID of the Amazon Web Services account that contains the IP rules.
AwsAccountId *string
// A value that specifies whether IP rules are turned on.
Enabled *bool
// A map that describes the IP rules with CIDR range and description.
IpRestrictionRuleMap map[string]string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A map of allowed VPC endpoint IDs and their rule descriptions.
VpcEndpointIdRestrictionRuleMap map[string]string
// A map of allowed VPC IDs and their rule descriptions.
VpcIdRestrictionRuleMap map[string]string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeIpRestrictionOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeIpRestrictionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeIpRestrictionOutput) Serialize ¶ added in v1.131.0
func (v *DescribeIpRestrictionOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeIpRestrictionOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeIpRestrictionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeKeyRegistrationInput ¶ added in v1.64.0
type DescribeKeyRegistrationInput struct {
// The ID of the Amazon Web Services account that contains the customer managed
// key registration that you want to describe.
//
// This member is required.
AwsAccountId *string
// Determines whether the request returns the default key only.
DefaultKeyOnly bool
// contains filtered or unexported fields
}
func (*DescribeKeyRegistrationInput) Serialize ¶ added in v1.131.0
func (v *DescribeKeyRegistrationInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeKeyRegistrationInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeKeyRegistrationInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeKeyRegistrationOutput ¶ added in v1.64.0
type DescribeKeyRegistrationOutput struct {
// The ID of the Amazon Web Services account that contains the customer managed
// key registration specified in the request.
AwsAccountId *string
// A list of RegisteredCustomerManagedKey objects in a Quick Sight account.
KeyRegistration []types.RegisteredCustomerManagedKey
// A list of QDataKey objects in a Quick Sight account.
QDataKey *types.QDataKey
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeKeyRegistrationOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeKeyRegistrationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeKeyRegistrationOutput) Serialize ¶ added in v1.131.0
func (v *DescribeKeyRegistrationOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeKeyRegistrationOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeKeyRegistrationOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeKnowledgeBaseInput ¶ added in v1.114.0
type DescribeKnowledgeBaseInput struct {
// The ID of the Amazon Web Services account that contains the knowledge base.
//
// This member is required.
AwsAccountId *string
// The unique identifier for the knowledge base.
//
// This member is required.
KnowledgeBaseId *string
// contains filtered or unexported fields
}
func (*DescribeKnowledgeBaseInput) Serialize ¶ added in v1.131.0
func (v *DescribeKnowledgeBaseInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeKnowledgeBaseInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeKnowledgeBaseInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeKnowledgeBaseOutput ¶ added in v1.114.0
type DescribeKnowledgeBaseOutput struct {
// The knowledge base.
//
// This member is required.
KnowledgeBase *types.KnowledgeBase
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status *int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeKnowledgeBaseOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeKnowledgeBaseOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeKnowledgeBaseOutput) Serialize ¶ added in v1.131.0
func (v *DescribeKnowledgeBaseOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeKnowledgeBaseOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeKnowledgeBaseOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeKnowledgeBasePermissionsInput ¶ added in v1.114.0
type DescribeKnowledgeBasePermissionsInput struct {
// The ID of the Amazon Web Services account that contains the knowledge base.
//
// This member is required.
AwsAccountId *string
// The unique identifier for the knowledge base.
//
// This member is required.
KnowledgeBaseId *string
// contains filtered or unexported fields
}
func (*DescribeKnowledgeBasePermissionsInput) Serialize ¶ added in v1.131.0
func (v *DescribeKnowledgeBasePermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeKnowledgeBasePermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeKnowledgeBasePermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeKnowledgeBasePermissionsOutput ¶ added in v1.114.0
type DescribeKnowledgeBasePermissionsOutput struct {
// The Amazon Resource Name (ARN) of the knowledge base.
//
// This member is required.
KnowledgeBaseArn *string
// The unique identifier for the knowledge base.
//
// This member is required.
KnowledgeBaseId *string
// The resource permissions for the knowledge base.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status *int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeKnowledgeBasePermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeKnowledgeBasePermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeKnowledgeBasePermissionsOutput) Serialize ¶ added in v1.131.0
func (v *DescribeKnowledgeBasePermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeKnowledgeBasePermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeKnowledgeBasePermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeLimitsProfileInput ¶ added in v1.124.0
type DescribeLimitsProfileInput struct {
// The ID of the Amazon Web Services account that contains the limits profile.
//
// This member is required.
AccountId *string
// The unique identifier for the limits profile.
//
// This member is required.
ProfileId *string
// contains filtered or unexported fields
}
func (*DescribeLimitsProfileInput) Serialize ¶ added in v1.131.0
func (v *DescribeLimitsProfileInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeLimitsProfileInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeLimitsProfileInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeLimitsProfileOutput ¶ added in v1.124.0
type DescribeLimitsProfileOutput struct {
// The details of the requested limits profile, including its name, description,
// resource limits, and metadata.
//
// This member is required.
Profile *types.LimitsProfile
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeLimitsProfileOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeLimitsProfileOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeLimitsProfileOutput) Serialize ¶ added in v1.131.0
func (v *DescribeLimitsProfileOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeLimitsProfileOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeLimitsProfileOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeNamespaceInput ¶
type DescribeNamespaceInput struct {
// The ID for the Amazon Web Services account that contains the Quick Sight
// namespace that you want to describe.
//
// This member is required.
AwsAccountId *string
// The namespace that you want to describe.
//
// This member is required.
Namespace *string
// contains filtered or unexported fields
}
func (*DescribeNamespaceInput) Serialize ¶ added in v1.131.0
func (v *DescribeNamespaceInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeNamespaceInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeNamespaceInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeNamespaceOutput ¶
type DescribeNamespaceOutput struct {
// 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.
Namespace *types.NamespaceInfoV2
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeNamespaceOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeNamespaceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeNamespaceOutput) Serialize ¶ added in v1.131.0
func (v *DescribeNamespaceOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeNamespaceOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeNamespaceOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeOAuthClientApplicationInput ¶ added in v1.112.0
type DescribeOAuthClientApplicationInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the OAuthClientApplication that you want to describe.
//
// This member is required.
OAuthClientApplicationId *string
// contains filtered or unexported fields
}
func (*DescribeOAuthClientApplicationInput) Serialize ¶ added in v1.131.0
func (v *DescribeOAuthClientApplicationInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeOAuthClientApplicationInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeOAuthClientApplicationInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeOAuthClientApplicationOutput ¶ added in v1.112.0
type DescribeOAuthClientApplicationOutput struct {
// The information about the OAuthClientApplication.
OAuthClientApplication *types.OAuthClientApplication
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeOAuthClientApplicationOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeOAuthClientApplicationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeOAuthClientApplicationOutput) Serialize ¶ added in v1.131.0
func (v *DescribeOAuthClientApplicationOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeOAuthClientApplicationOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeOAuthClientApplicationOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeQPersonalizationConfigurationInput ¶ added in v1.74.0
type DescribeQPersonalizationConfigurationInput struct {
// The ID of the Amazon Web Services account that contains the personalization
// configuration that the user wants described.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeQPersonalizationConfigurationInput) Serialize ¶ added in v1.131.0
func (v *DescribeQPersonalizationConfigurationInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeQPersonalizationConfigurationInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeQPersonalizationConfigurationInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeQPersonalizationConfigurationOutput ¶ added in v1.74.0
type DescribeQPersonalizationConfigurationOutput struct {
// A value that indicates whether personalization is enabled or not.
PersonalizationMode types.PersonalizationMode
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeQPersonalizationConfigurationOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeQPersonalizationConfigurationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeQPersonalizationConfigurationOutput) Serialize ¶ added in v1.131.0
func (v *DescribeQPersonalizationConfigurationOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeQPersonalizationConfigurationOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeQPersonalizationConfigurationOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeQuickSightQSearchConfigurationInput ¶ added in v1.81.0
type DescribeQuickSightQSearchConfigurationInput struct {
// The ID of the Amazon Web Services account that contains the Quick Sight Q
// Search configuration that the user wants described.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeQuickSightQSearchConfigurationInput) Serialize ¶ added in v1.131.0
func (v *DescribeQuickSightQSearchConfigurationInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeQuickSightQSearchConfigurationInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeQuickSightQSearchConfigurationInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeQuickSightQSearchConfigurationOutput ¶ added in v1.81.0
type DescribeQuickSightQSearchConfigurationOutput struct {
// The status of Quick Sight Q Search configuration.
QSearchStatus types.QSearchStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeQuickSightQSearchConfigurationOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeQuickSightQSearchConfigurationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeQuickSightQSearchConfigurationOutput) Serialize ¶ added in v1.131.0
func (v *DescribeQuickSightQSearchConfigurationOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeQuickSightQSearchConfigurationOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeQuickSightQSearchConfigurationOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeRefreshScheduleInput ¶ added in v1.34.0
type DescribeRefreshScheduleInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset.
//
// This member is required.
DataSetId *string
// The ID of the refresh schedule.
//
// This member is required.
ScheduleId *string
// contains filtered or unexported fields
}
func (*DescribeRefreshScheduleInput) Serialize ¶ added in v1.131.0
func (v *DescribeRefreshScheduleInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeRefreshScheduleInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeRefreshScheduleInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeRefreshScheduleOutput ¶ added in v1.34.0
type DescribeRefreshScheduleOutput struct {
// The Amazon Resource Name (ARN) for the refresh schedule.
Arn *string
// The refresh schedule.
RefreshSchedule *types.RefreshSchedule
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeRefreshScheduleOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeRefreshScheduleOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeRefreshScheduleOutput) Serialize ¶ added in v1.131.0
func (v *DescribeRefreshScheduleOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeRefreshScheduleOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeRefreshScheduleOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeResourcePermissionsInput ¶ added in v1.139.0
type DescribeResourcePermissionsInput struct {
// The ID of the Amazon Web Services account whose service role configuration you
// want to describe.
//
// This member is required.
AwsAccountId *string
// contains filtered or unexported fields
}
func (*DescribeResourcePermissionsInput) Serialize ¶ added in v1.139.0
func (v *DescribeResourcePermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeResourcePermissionsInput) SerializeMembers ¶ added in v1.139.0
func (v *DescribeResourcePermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeResourcePermissionsOutput ¶ added in v1.139.0
type DescribeResourcePermissionsOutput struct {
// The ARN of the customer-managed role that Amazon Quick Sight uses for your
// account. Amazon Quick Sight returns this value only when RoleType is
// CUSTOMER_MANAGED .
CustomerManagedRoleArn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The type of service role that Amazon Quick Sight uses for your account.
RoleType types.ServiceRoleType
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeResourcePermissionsOutput) Deserialize ¶ added in v1.139.0
func (v *DescribeResourcePermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeResourcePermissionsOutput) Serialize ¶ added in v1.139.0
func (v *DescribeResourcePermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeResourcePermissionsOutput) SerializeMembers ¶ added in v1.139.0
func (v *DescribeResourcePermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeRoleCustomPermissionInput ¶ added in v1.51.0
type DescribeRoleCustomPermissionInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The namespace that contains the role.
//
// This member is required.
Namespace *string
// The name of the role whose permissions you want described.
//
// This member is required.
Role types.Role
// contains filtered or unexported fields
}
func (*DescribeRoleCustomPermissionInput) Serialize ¶ added in v1.131.0
func (v *DescribeRoleCustomPermissionInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeRoleCustomPermissionInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeRoleCustomPermissionInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeRoleCustomPermissionOutput ¶ added in v1.51.0
type DescribeRoleCustomPermissionOutput struct {
// The name of the custom permission that is described.
CustomPermissionsName *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeRoleCustomPermissionOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeRoleCustomPermissionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeRoleCustomPermissionOutput) Serialize ¶ added in v1.131.0
func (v *DescribeRoleCustomPermissionOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeRoleCustomPermissionOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeRoleCustomPermissionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeSelfUpgradeConfigurationInput ¶ added in v1.100.0
type DescribeSelfUpgradeConfigurationInput struct {
// The ID of the Amazon Web Services account that contains the Quick self-upgrade
// configuration.
//
// This member is required.
AwsAccountId *string
// The Quick namespace that you want to describe the Quick self-upgrade
// configuration for.
//
// This member is required.
Namespace *string
// contains filtered or unexported fields
}
func (*DescribeSelfUpgradeConfigurationInput) Serialize ¶ added in v1.131.0
func (v *DescribeSelfUpgradeConfigurationInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeSelfUpgradeConfigurationInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeSelfUpgradeConfigurationInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeSelfUpgradeConfigurationOutput ¶ added in v1.100.0
type DescribeSelfUpgradeConfigurationOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The self-upgrade configuration for the Quick account.
SelfUpgradeConfiguration *types.SelfUpgradeConfiguration
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeSelfUpgradeConfigurationOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeSelfUpgradeConfigurationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeSelfUpgradeConfigurationOutput) Serialize ¶ added in v1.131.0
func (v *DescribeSelfUpgradeConfigurationOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeSelfUpgradeConfigurationOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeSelfUpgradeConfigurationOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeSpaceInput ¶ added in v1.113.0
type DescribeSpaceInput struct {
// The ID of the Amazon Web Services account that contains the space.
//
// This member is required.
AwsAccountId *string
// The ID of the space that you want to describe.
//
// This member is required.
SpaceId *string
// The maximum number of contributors to include in the response.
MaxContributors *int32
// contains filtered or unexported fields
}
func (*DescribeSpaceInput) Serialize ¶ added in v1.131.0
func (v *DescribeSpaceInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeSpaceInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeSpaceInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeSpaceOutput ¶ added in v1.113.0
type DescribeSpaceOutput struct {
// The details of the space.
//
// This member is required.
Space *types.SpaceDetails
// The ID of the space.
//
// This member is required.
SpaceId *string
// A list of contributors to the space.
Contributors []types.SpaceContributor
// The Amazon Web Services request ID for this operation.
RequestId *string
// The ARN of the space.
SpaceArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeSpaceOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeSpaceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeSpaceOutput) Serialize ¶ added in v1.131.0
func (v *DescribeSpaceOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeSpaceOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeSpaceOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeSpacePermissionsInput ¶ added in v1.113.0
type DescribeSpacePermissionsInput struct {
// The ID of the Amazon Web Services account that contains the space.
//
// This member is required.
AwsAccountId *string
// The ID of the space that you want to describe permissions for.
//
// This member is required.
SpaceId *string
// contains filtered or unexported fields
}
func (*DescribeSpacePermissionsInput) Serialize ¶ added in v1.131.0
func (v *DescribeSpacePermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeSpacePermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeSpacePermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeSpacePermissionsOutput ¶ added in v1.113.0
type DescribeSpacePermissionsOutput struct {
// The ID of the space.
//
// This member is required.
SpaceId *string
// A list of resource permissions for the space.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The ARN of the space.
SpaceArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeSpacePermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeSpacePermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeSpacePermissionsOutput) Serialize ¶ added in v1.131.0
func (v *DescribeSpacePermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeSpacePermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeSpacePermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTemplateAliasInput ¶
type DescribeTemplateAliasInput struct {
// 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.
//
// This member is required.
AliasName *string
// The ID of the Amazon Web Services account that contains the template alias that
// you're describing.
//
// This member is required.
AwsAccountId *string
// The ID for the template.
//
// This member is required.
TemplateId *string
// contains filtered or unexported fields
}
func (*DescribeTemplateAliasInput) Serialize ¶ added in v1.131.0
func (v *DescribeTemplateAliasInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeTemplateAliasInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTemplateAliasInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTemplateAliasOutput ¶
type DescribeTemplateAliasOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Information about the template alias.
TemplateAlias *types.TemplateAlias
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeTemplateAliasOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeTemplateAliasOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeTemplateAliasOutput) Serialize ¶ added in v1.131.0
func (v *DescribeTemplateAliasOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeTemplateAliasOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTemplateAliasOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTemplateDefinitionInput ¶ added in v1.28.0
type DescribeTemplateDefinitionInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The ID of the template that you're describing.
//
// This member is required.
TemplateId *string
// 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.
AliasName *string
// The version number of the template.
VersionNumber *int64
// contains filtered or unexported fields
}
func (*DescribeTemplateDefinitionInput) Serialize ¶ added in v1.131.0
func (v *DescribeTemplateDefinitionInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeTemplateDefinitionInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTemplateDefinitionInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTemplateDefinitionOutput ¶ added in v1.28.0
type DescribeTemplateDefinitionOutput struct {
// The definition of the template.
//
// A definition is the data model of all features in a Dashboard, Template, or
// Analysis.
Definition *types.TemplateVersionDefinition
// Errors associated with the template version.
Errors []types.TemplateError
// The descriptive name of the template.
Name *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// Status associated with the template.
//
// - CREATION_IN_PROGRESS
//
// - CREATION_SUCCESSFUL
//
// - CREATION_FAILED
//
// - UPDATE_IN_PROGRESS
//
// - UPDATE_SUCCESSFUL
//
// - UPDATE_FAILED
//
// - DELETED
ResourceStatus types.ResourceStatus
// The HTTP status of the request.
Status int32
// The ID of the template described.
TemplateId *string
// The ARN of the theme of the template.
ThemeArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeTemplateDefinitionOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeTemplateDefinitionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeTemplateDefinitionOutput) Serialize ¶ added in v1.131.0
func (v *DescribeTemplateDefinitionOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeTemplateDefinitionOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTemplateDefinitionOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTemplateInput ¶
type DescribeTemplateInput struct {
// The ID of the Amazon Web Services account that contains the template that
// you're describing.
//
// This member is required.
AwsAccountId *string
// The ID for the template.
//
// This member is required.
TemplateId *string
// 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.
AliasName *string
// (Optional) The number for the version to describe. If a VersionNumber parameter
// value isn't provided, the latest version of the template is described.
VersionNumber *int64
// contains filtered or unexported fields
}
func (*DescribeTemplateInput) Serialize ¶ added in v1.131.0
func (v *DescribeTemplateInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeTemplateInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTemplateInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTemplateOutput ¶
type DescribeTemplateOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The template structure for the object you want to describe.
Template *types.Template
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeTemplateOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeTemplateOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeTemplateOutput) Serialize ¶ added in v1.131.0
func (v *DescribeTemplateOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeTemplateOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTemplateOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTemplatePermissionsInput ¶
type DescribeTemplatePermissionsInput struct {
// The ID of the Amazon Web Services account that contains the template that
// you're describing.
//
// This member is required.
AwsAccountId *string
// The ID for the template.
//
// This member is required.
TemplateId *string
// contains filtered or unexported fields
}
func (*DescribeTemplatePermissionsInput) Serialize ¶ added in v1.131.0
func (v *DescribeTemplatePermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeTemplatePermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTemplatePermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTemplatePermissionsOutput ¶
type DescribeTemplatePermissionsOutput struct {
// A list of resource permissions to be set on the template.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the template.
TemplateArn *string
// The ID for the template.
TemplateId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeTemplatePermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeTemplatePermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeTemplatePermissionsOutput) Serialize ¶ added in v1.131.0
func (v *DescribeTemplatePermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeTemplatePermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTemplatePermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeThemeAliasInput ¶
type DescribeThemeAliasInput struct {
// The name of the theme alias that you want to describe.
//
// This member is required.
AliasName *string
// The ID of the Amazon Web Services account that contains the theme alias that
// you're describing.
//
// This member is required.
AwsAccountId *string
// The ID for the theme.
//
// This member is required.
ThemeId *string
// contains filtered or unexported fields
}
func (*DescribeThemeAliasInput) Serialize ¶ added in v1.131.0
func (v *DescribeThemeAliasInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeThemeAliasInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeThemeAliasInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeThemeAliasOutput ¶
type DescribeThemeAliasOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Information about the theme alias.
ThemeAlias *types.ThemeAlias
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeThemeAliasOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeThemeAliasOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeThemeAliasOutput) Serialize ¶ added in v1.131.0
func (v *DescribeThemeAliasOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeThemeAliasOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeThemeAliasOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeThemeInput ¶
type DescribeThemeInput struct {
// The ID of the Amazon Web Services account that contains the theme that you're
// describing.
//
// This member is required.
AwsAccountId *string
// The ID for the theme.
//
// This member is required.
ThemeId *string
// 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.
AliasName *string
// The version number for the version to describe. If a VersionNumber parameter
// value isn't provided, the latest version of the theme is described.
VersionNumber *int64
// contains filtered or unexported fields
}
func (*DescribeThemeInput) Serialize ¶ added in v1.131.0
func (v *DescribeThemeInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeThemeInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeThemeInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeThemeOutput ¶
type DescribeThemeOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The information about the theme that you are describing.
Theme *types.Theme
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeThemeOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeThemeOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeThemeOutput) Serialize ¶ added in v1.131.0
func (v *DescribeThemeOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeThemeOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeThemeOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeThemePermissionsInput ¶
type DescribeThemePermissionsInput struct {
// The ID of the Amazon Web Services account that contains the theme that you're
// describing.
//
// This member is required.
AwsAccountId *string
// The ID for the theme that you want to describe permissions for.
//
// This member is required.
ThemeId *string
// contains filtered or unexported fields
}
func (*DescribeThemePermissionsInput) Serialize ¶ added in v1.131.0
func (v *DescribeThemePermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeThemePermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeThemePermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeThemePermissionsOutput ¶
type DescribeThemePermissionsOutput struct {
// A list of resource permissions set on the theme.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the theme.
ThemeArn *string
// The ID for the theme.
ThemeId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeThemePermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeThemePermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeThemePermissionsOutput) Serialize ¶ added in v1.131.0
func (v *DescribeThemePermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeThemePermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeThemePermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTopicInput ¶ added in v1.35.0
type DescribeTopicInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// 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.
//
// This member is required.
TopicId *string
// contains filtered or unexported fields
}
func (*DescribeTopicInput) Serialize ¶ added in v1.131.0
func (v *DescribeTopicInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeTopicInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTopicInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTopicOutput ¶ added in v1.35.0
type DescribeTopicOutput struct {
// The Amazon Resource Name (ARN) of the topic.
Arn *string
// Custom instructions for the topic.
CustomInstructions *types.CustomInstructions
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The definition of a topic.
Topic *types.TopicDetails
// 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.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeTopicOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeTopicOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeTopicOutput) Serialize ¶ added in v1.131.0
func (v *DescribeTopicOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeTopicOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTopicOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTopicPermissionsInput ¶ added in v1.35.0
type DescribeTopicPermissionsInput struct {
// The ID of the Amazon Web Services account that contains the topic that you want
// described.
//
// This member is required.
AwsAccountId *string
// 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.
//
// This member is required.
TopicId *string
// contains filtered or unexported fields
}
func (*DescribeTopicPermissionsInput) Serialize ¶ added in v1.131.0
func (v *DescribeTopicPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeTopicPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTopicPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTopicPermissionsOutput ¶ added in v1.35.0
type DescribeTopicPermissionsOutput struct {
// A list of resource permissions that are configured to the topic.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the topic.
TopicArn *string
// 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.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeTopicPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeTopicPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeTopicPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *DescribeTopicPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeTopicPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTopicPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTopicPermissionsV2Input ¶ added in v1.123.0
type DescribeTopicPermissionsV2Input struct {
// The ID of the Amazon Web Services account that contains the topic that you want
// described.
//
// This member is required.
AwsAccountId *string
// 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.
//
// This member is required.
TopicId *string
// contains filtered or unexported fields
}
func (*DescribeTopicPermissionsV2Input) Serialize ¶ added in v1.131.0
func (v *DescribeTopicPermissionsV2Input) Serialize(s smithy.ShapeSerializer)
func (*DescribeTopicPermissionsV2Input) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTopicPermissionsV2Input) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTopicPermissionsV2Output ¶ added in v1.123.0
type DescribeTopicPermissionsV2Output struct {
// A list of resource permissions that are configured to the topic.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the topic.
TopicArn *string
// 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.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeTopicPermissionsV2Output) Deserialize ¶ added in v1.131.0
func (v *DescribeTopicPermissionsV2Output) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeTopicPermissionsV2Output) Serialize ¶ added in v1.131.0
func (v *DescribeTopicPermissionsV2Output) Serialize(s smithy.ShapeSerializer)
func (*DescribeTopicPermissionsV2Output) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTopicPermissionsV2Output) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTopicRefreshInput ¶ added in v1.35.0
type DescribeTopicRefreshInput struct {
// The ID of the Amazon Web Services account that contains the topic whose refresh
// you want to describe.
//
// This member is required.
AwsAccountId *string
// The ID of the refresh, which is performed when the topic is created or updated.
//
// This member is required.
RefreshId *string
// 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.
//
// This member is required.
TopicId *string
// contains filtered or unexported fields
}
func (*DescribeTopicRefreshInput) Serialize ¶ added in v1.131.0
func (v *DescribeTopicRefreshInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeTopicRefreshInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTopicRefreshInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTopicRefreshOutput ¶ added in v1.35.0
type DescribeTopicRefreshOutput struct {
// Details of the refresh, which is performed when the topic is created or updated.
RefreshDetails *types.TopicRefreshDetails
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeTopicRefreshOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeTopicRefreshOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeTopicRefreshOutput) Serialize ¶ added in v1.131.0
func (v *DescribeTopicRefreshOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeTopicRefreshOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTopicRefreshOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTopicRefreshScheduleInput ¶ added in v1.35.0
type DescribeTopicRefreshScheduleInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset.
//
// This member is required.
DatasetId *string
// 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.
//
// This member is required.
TopicId *string
// contains filtered or unexported fields
}
func (*DescribeTopicRefreshScheduleInput) Serialize ¶ added in v1.131.0
func (v *DescribeTopicRefreshScheduleInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeTopicRefreshScheduleInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTopicRefreshScheduleInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTopicRefreshScheduleOutput ¶ added in v1.35.0
type DescribeTopicRefreshScheduleOutput struct {
// The Amazon Resource Name (ARN) of the dataset.
DatasetArn *string
// The definition of a refresh schedule.
RefreshSchedule *types.TopicRefreshSchedule
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the topic.
TopicArn *string
// 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.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeTopicRefreshScheduleOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeTopicRefreshScheduleOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeTopicRefreshScheduleOutput) Serialize ¶ added in v1.131.0
func (v *DescribeTopicRefreshScheduleOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeTopicRefreshScheduleOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTopicRefreshScheduleOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTopicV2Input ¶ added in v1.123.0
type DescribeTopicV2Input struct {
// The ID of the Amazon Web Services account that contains the topic that you want
// to describe.
//
// This member is required.
AwsAccountId *string
// 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.
//
// This member is required.
TopicId *string
// contains filtered or unexported fields
}
func (*DescribeTopicV2Input) Serialize ¶ added in v1.131.0
func (v *DescribeTopicV2Input) Serialize(s smithy.ShapeSerializer)
func (*DescribeTopicV2Input) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTopicV2Input) SerializeMembers(s smithy.ShapeSerializer)
type DescribeTopicV2Output ¶ added in v1.123.0
type DescribeTopicV2Output struct {
// The Amazon Resource Name (ARN) of the topic.
Arn *string
// Instructions that provide additional guidance and context for response
// generation.
CustomInstructions *types.CustomInstructions
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The definition of a topic.
Topic *types.TopicV2Details
// 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.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeTopicV2Output) Deserialize ¶ added in v1.131.0
func (v *DescribeTopicV2Output) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeTopicV2Output) Serialize ¶ added in v1.131.0
func (v *DescribeTopicV2Output) Serialize(s smithy.ShapeSerializer)
func (*DescribeTopicV2Output) SerializeMembers ¶ added in v1.131.0
func (v *DescribeTopicV2Output) SerializeMembers(s smithy.ShapeSerializer)
type DescribeUserInput ¶
type DescribeUserInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The namespace. Currently, you should set this to default .
//
// This member is required.
Namespace *string
// The name of the user that you want to describe.
//
// This member is required.
UserName *string
// contains filtered or unexported fields
}
func (*DescribeUserInput) Serialize ¶ added in v1.131.0
func (v *DescribeUserInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeUserInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeUserInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeUserOutput ¶
type DescribeUserOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The user name.
User *types.User
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeUserOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeUserOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeUserOutput) Serialize ¶ added in v1.131.0
func (v *DescribeUserOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeUserOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeUserOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeVPCConnectionInput ¶ added in v1.35.0
type DescribeVPCConnectionInput struct {
// The Amazon Web Services account ID of the account that contains the VPC
// connection that you want described.
//
// This member is required.
AwsAccountId *string
// 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.
//
// This member is required.
VPCConnectionId *string
// contains filtered or unexported fields
}
func (*DescribeVPCConnectionInput) Serialize ¶ added in v1.131.0
func (v *DescribeVPCConnectionInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeVPCConnectionInput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeVPCConnectionInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeVPCConnectionOutput ¶ added in v1.35.0
type DescribeVPCConnectionOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A response object that provides information for the specified VPC connection.
VPCConnection *types.VPCConnection
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeVPCConnectionOutput) Deserialize ¶ added in v1.131.0
func (v *DescribeVPCConnectionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeVPCConnectionOutput) Serialize ¶ added in v1.131.0
func (v *DescribeVPCConnectionOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeVPCConnectionOutput) SerializeMembers ¶ added in v1.131.0
func (v *DescribeVPCConnectionOutput) SerializeMembers(s smithy.ShapeSerializer)
type EndpointParameters ¶ added in v1.40.0
type EndpointParameters struct {
// The AWS region used to dispatch the request.
//
// Parameter is
// required.
//
// AWS::Region
Region *string
// When true, use the dual-stack endpoint. If the configured endpoint does not
// support dual-stack, dispatching the request MAY return an error.
//
// Defaults to
// false if no value is provided.
//
// AWS::UseDualStack
UseDualStack *bool
// When true, send this request to the FIPS-compliant regional endpoint. If the
// configured endpoint does not have a FIPS compliant endpoint, dispatching the
// request will return an error.
//
// Defaults to false if no value is
// provided.
//
// AWS::UseFIPS
UseFIPS *bool
// Override the endpoint used to send this request
//
// Parameter is
// required.
//
// SDK::Endpoint
Endpoint *string
}
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶ added in v1.40.0
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶ added in v1.40.0
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v1.1.0
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶ added in v0.29.0
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶ added in v1.40.0
type EndpointResolverV2 interface {
ResolveEndpoint(ctx context.Context, params EndpointParameters) (
smithyendpoints.Endpoint, error,
)
}
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶ added in v1.40.0
func NewDefaultEndpointResolverV2() EndpointResolverV2
type GenerateEmbedUrlForAnonymousUserInput ¶ added in v1.7.0
type GenerateEmbedUrlForAnonymousUserInput struct {
// 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.
//
// This member is required.
AuthorizedResourceArns []string
// The ID for the Amazon Web Services account that contains the dashboard that
// you're embedding.
//
// This member is required.
AwsAccountId *string
// The configuration of the experience that you are embedding.
//
// This member is required.
ExperienceConfiguration *types.AnonymousUserEmbeddingExperienceConfiguration
// 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 .
//
// This member is required.
Namespace *string
// 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 .
AllowedDomains []string
// How many minutes the session is valid. The session lifetime must be in [15-600]
// minutes range.
SessionLifetimeInMinutes *int64
// 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.
//
// [Using Row-Level Security (RLS) with Tags]: https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html
SessionTags []types.SessionTag
// contains filtered or unexported fields
}
func (*GenerateEmbedUrlForAnonymousUserInput) Serialize ¶ added in v1.131.0
func (v *GenerateEmbedUrlForAnonymousUserInput) Serialize(s smithy.ShapeSerializer)
func (*GenerateEmbedUrlForAnonymousUserInput) SerializeMembers ¶ added in v1.131.0
func (v *GenerateEmbedUrlForAnonymousUserInput) SerializeMembers(s smithy.ShapeSerializer)
type GenerateEmbedUrlForAnonymousUserOutput ¶ added in v1.7.0
type GenerateEmbedUrlForAnonymousUserOutput struct {
// The Amazon Resource Name (ARN) to use for the anonymous Amazon Quick user.
//
// This member is required.
AnonymousUserArn *string
// The embed URL for the dashboard.
//
// This member is required.
EmbedUrl *string
// The Amazon Web Services request ID for this operation.
//
// This member is required.
RequestId *string
// The HTTP status of the request.
//
// This member is required.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GenerateEmbedUrlForAnonymousUserOutput) Deserialize ¶ added in v1.131.0
func (v *GenerateEmbedUrlForAnonymousUserOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GenerateEmbedUrlForAnonymousUserOutput) Serialize ¶ added in v1.131.0
func (v *GenerateEmbedUrlForAnonymousUserOutput) Serialize(s smithy.ShapeSerializer)
func (*GenerateEmbedUrlForAnonymousUserOutput) SerializeMembers ¶ added in v1.131.0
func (v *GenerateEmbedUrlForAnonymousUserOutput) SerializeMembers(s smithy.ShapeSerializer)
type GenerateEmbedUrlForRegisteredUserInput ¶ added in v1.7.0
type GenerateEmbedUrlForRegisteredUserInput struct {
// The ID for the Amazon Web Services account that contains the dashboard that
// you're embedding.
//
// This member is required.
AwsAccountId *string
// 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.
//
// This member is required.
ExperienceConfiguration *types.RegisteredUserEmbeddingExperienceConfiguration
// The Amazon Resource Name for the registered user.
//
// This member is required.
UserArn *string
// 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 .
AllowedDomains []string
// How many minutes the session is valid. The session lifetime must be in [15-600]
// minutes range.
SessionLifetimeInMinutes *int64
// contains filtered or unexported fields
}
func (*GenerateEmbedUrlForRegisteredUserInput) Serialize ¶ added in v1.131.0
func (v *GenerateEmbedUrlForRegisteredUserInput) Serialize(s smithy.ShapeSerializer)
func (*GenerateEmbedUrlForRegisteredUserInput) SerializeMembers ¶ added in v1.131.0
func (v *GenerateEmbedUrlForRegisteredUserInput) SerializeMembers(s smithy.ShapeSerializer)
type GenerateEmbedUrlForRegisteredUserOutput ¶ added in v1.7.0
type GenerateEmbedUrlForRegisteredUserOutput struct {
// The embed URL for the Amazon Quick Sight dashboard, visual, Q search bar,
// Generative Q&A experience, or console.
//
// This member is required.
EmbedUrl *string
// The Amazon Web Services request ID for this operation.
//
// This member is required.
RequestId *string
// The HTTP status of the request.
//
// This member is required.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GenerateEmbedUrlForRegisteredUserOutput) Deserialize ¶ added in v1.131.0
func (v *GenerateEmbedUrlForRegisteredUserOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GenerateEmbedUrlForRegisteredUserOutput) Serialize ¶ added in v1.131.0
func (v *GenerateEmbedUrlForRegisteredUserOutput) Serialize(s smithy.ShapeSerializer)
func (*GenerateEmbedUrlForRegisteredUserOutput) SerializeMembers ¶ added in v1.131.0
func (v *GenerateEmbedUrlForRegisteredUserOutput) SerializeMembers(s smithy.ShapeSerializer)
type GenerateEmbedUrlForRegisteredUserWithIdentityInput ¶ added in v1.81.0
type GenerateEmbedUrlForRegisteredUserWithIdentityInput struct {
// The ID of the Amazon Web Services registered user.
//
// This member is required.
AwsAccountId *string
// 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.
//
// This member is required.
ExperienceConfiguration *types.RegisteredUserEmbeddingExperienceConfiguration
// A list of domains to be allowed to generate the embed URL.
AllowedDomains []string
// The validity of the session in minutes.
SessionLifetimeInMinutes *int64
// contains filtered or unexported fields
}
func (*GenerateEmbedUrlForRegisteredUserWithIdentityInput) Serialize ¶ added in v1.131.0
func (v *GenerateEmbedUrlForRegisteredUserWithIdentityInput) Serialize(s smithy.ShapeSerializer)
func (*GenerateEmbedUrlForRegisteredUserWithIdentityInput) SerializeMembers ¶ added in v1.131.0
func (v *GenerateEmbedUrlForRegisteredUserWithIdentityInput) SerializeMembers(s smithy.ShapeSerializer)
type GenerateEmbedUrlForRegisteredUserWithIdentityOutput ¶ added in v1.81.0
type GenerateEmbedUrlForRegisteredUserWithIdentityOutput struct {
// The generated embed URL for the registered user.
//
// This member is required.
EmbedUrl *string
// The Amazon Web Services request ID for this operation.
//
// This member is required.
RequestId *string
// The HTTP status of the request.
//
// This member is required.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GenerateEmbedUrlForRegisteredUserWithIdentityOutput) Deserialize ¶ added in v1.131.0
func (v *GenerateEmbedUrlForRegisteredUserWithIdentityOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GenerateEmbedUrlForRegisteredUserWithIdentityOutput) Serialize ¶ added in v1.131.0
func (v *GenerateEmbedUrlForRegisteredUserWithIdentityOutput) Serialize(s smithy.ShapeSerializer)
func (*GenerateEmbedUrlForRegisteredUserWithIdentityOutput) SerializeMembers ¶ added in v1.131.0
func (v *GenerateEmbedUrlForRegisteredUserWithIdentityOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetDashboardEmbedUrlInput ¶
type GetDashboardEmbedUrlInput struct {
// The ID for the Amazon Web Services account that contains the dashboard that
// you're embedding.
//
// This member is required.
AwsAccountId *string
// The ID for the dashboard, also added to the Identity and Access Management
// (IAM) policy.
//
// This member is required.
DashboardId *string
// The authentication method that the user uses to sign in.
//
// This member is required.
IdentityType types.EmbeddingIdentityType
// 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.
AdditionalDashboardIds []string
// The Amazon Quick Sight namespace that contains the dashboard IDs in this
// request. If you're not using a custom namespace, set Namespace = default .
Namespace *string
// Remove the reset button on the embedded dashboard. The default is FALSE, which
// enables the reset button.
ResetDisabled bool
// How many minutes the session is valid. The session lifetime must be 15-600
// minutes.
SessionLifetimeInMinutes *int64
// 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 .
StatePersistenceEnabled bool
// Remove the undo/redo button on the embedded dashboard. The default is FALSE,
// which enables the undo/redo button.
UndoRedoDisabled bool
// 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.
UserArn *string
// contains filtered or unexported fields
}
func (*GetDashboardEmbedUrlInput) Serialize ¶ added in v1.131.0
func (v *GetDashboardEmbedUrlInput) Serialize(s smithy.ShapeSerializer)
func (*GetDashboardEmbedUrlInput) SerializeMembers ¶ added in v1.131.0
func (v *GetDashboardEmbedUrlInput) SerializeMembers(s smithy.ShapeSerializer)
type GetDashboardEmbedUrlOutput ¶
type GetDashboardEmbedUrlOutput struct {
// 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.
EmbedUrl *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
Output returned from the GetDashboardEmbedUrl operation.
func (*GetDashboardEmbedUrlOutput) Deserialize ¶ added in v1.131.0
func (v *GetDashboardEmbedUrlOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetDashboardEmbedUrlOutput) Serialize ¶ added in v1.131.0
func (v *GetDashboardEmbedUrlOutput) Serialize(s smithy.ShapeSerializer)
func (*GetDashboardEmbedUrlOutput) SerializeMembers ¶ added in v1.131.0
func (v *GetDashboardEmbedUrlOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetFlowMetadataInput ¶ added in v1.95.0
type GetFlowMetadataInput struct {
// The ID of the Amazon Web Services account that contains the flow that you are
// getting metadata for.
//
// This member is required.
AwsAccountId *string
// The unique identifier of the flow.
//
// This member is required.
FlowId *string
// contains filtered or unexported fields
}
func (*GetFlowMetadataInput) Serialize ¶ added in v1.131.0
func (v *GetFlowMetadataInput) Serialize(s smithy.ShapeSerializer)
func (*GetFlowMetadataInput) SerializeMembers ¶ added in v1.131.0
func (v *GetFlowMetadataInput) SerializeMembers(s smithy.ShapeSerializer)
type GetFlowMetadataOutput ¶ added in v1.95.0
type GetFlowMetadataOutput struct {
// The Amazon Resource Name (ARN) of the flow.
//
// This member is required.
Arn *string
// The time this flow was created.
//
// This member is required.
CreatedTime *time.Time
// The unique identifier of the flow.
//
// This member is required.
FlowId *string
// A display name for the flow.
//
// This member is required.
Name *string
// The description for the flow.
Description *string
// The last time this flow was modified.
LastUpdatedTime *time.Time
// The publish state for the flow. Valid values are DRAFT , PUBLISHED , or
// PENDING_APPROVAL .
PublishState types.FlowPublishState
// The Amazon Web Services request ID for this operation.
RequestId *string
// The number of runs done for the flow.
RunCount int32
// The HTTP status of the request.
Status int32
// The number of users who have used the flow.
UserCount int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetFlowMetadataOutput) Deserialize ¶ added in v1.131.0
func (v *GetFlowMetadataOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetFlowMetadataOutput) Serialize ¶ added in v1.131.0
func (v *GetFlowMetadataOutput) Serialize(s smithy.ShapeSerializer)
func (*GetFlowMetadataOutput) SerializeMembers ¶ added in v1.131.0
func (v *GetFlowMetadataOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetFlowPermissionsInput ¶ added in v1.95.0
type GetFlowPermissionsInput struct {
// The ID of the Amazon Web Services account that contains the flow that you are
// getting permissions for.
//
// This member is required.
AwsAccountId *string
// The unique identifier of the flow to get permissions from.
//
// This member is required.
FlowId *string
// contains filtered or unexported fields
}
func (*GetFlowPermissionsInput) Serialize ¶ added in v1.131.0
func (v *GetFlowPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*GetFlowPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *GetFlowPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type GetFlowPermissionsOutput ¶ added in v1.95.0
type GetFlowPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the flow you are getting permissions against.
//
// This member is required.
Arn *string
// The unique identifier of the flow with permissions.
//
// This member is required.
FlowId *string
// A structure that contains the permissions for the flow.
//
// This member is required.
Permissions []types.Permission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetFlowPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *GetFlowPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetFlowPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *GetFlowPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*GetFlowPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *GetFlowPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetIdentityContextInput ¶ added in v1.99.0
type GetIdentityContextInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The identifier for the user whose identity context you want to retrieve.
//
// This member is required.
UserIdentifier types.UserIdentifier
// 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.
ContextRegion *string
// 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.
Namespace *string
// The timestamp at which the session will expire.
SessionExpiresAt *time.Time
// contains filtered or unexported fields
}
///////////////////////// /////////////////////////
func (*GetIdentityContextInput) Serialize ¶ added in v1.131.0
func (v *GetIdentityContextInput) Serialize(s smithy.ShapeSerializer)
func (*GetIdentityContextInput) SerializeMembers ¶ added in v1.131.0
func (v *GetIdentityContextInput) SerializeMembers(s smithy.ShapeSerializer)
type GetIdentityContextOutput ¶ added in v1.99.0
type GetIdentityContextOutput struct {
// The Amazon Web Services request ID for this operation.
//
// This member is required.
RequestId *string
// The HTTP status of the request.
//
// This member is required.
Status *int32
// 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.
//
// [STS AssumeRole API]: https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html
Context *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetIdentityContextOutput) Deserialize ¶ added in v1.131.0
func (v *GetIdentityContextOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetIdentityContextOutput) Serialize ¶ added in v1.131.0
func (v *GetIdentityContextOutput) Serialize(s smithy.ShapeSerializer)
func (*GetIdentityContextOutput) SerializeMembers ¶ added in v1.131.0
func (v *GetIdentityContextOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetSessionEmbedUrlInput ¶
type GetSessionEmbedUrlInput struct {
// The ID for the Amazon Web Services account associated with your Amazon Quick
// Sight subscription.
//
// This member is required.
AwsAccountId *string
// 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
EntryPoint *string
// How many minutes the session is valid. The session lifetime must be 15-600
// minutes.
SessionLifetimeInMinutes *int64
// 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.
UserArn *string
// contains filtered or unexported fields
}
func (*GetSessionEmbedUrlInput) Serialize ¶ added in v1.131.0
func (v *GetSessionEmbedUrlInput) Serialize(s smithy.ShapeSerializer)
func (*GetSessionEmbedUrlInput) SerializeMembers ¶ added in v1.131.0
func (v *GetSessionEmbedUrlInput) SerializeMembers(s smithy.ShapeSerializer)
type GetSessionEmbedUrlOutput ¶
type GetSessionEmbedUrlOutput struct {
// 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.
EmbedUrl *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetSessionEmbedUrlOutput) Deserialize ¶ added in v1.131.0
func (v *GetSessionEmbedUrlOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetSessionEmbedUrlOutput) Serialize ¶ added in v1.131.0
func (v *GetSessionEmbedUrlOutput) Serialize(s smithy.ShapeSerializer)
func (*GetSessionEmbedUrlOutput) SerializeMembers ¶ added in v1.131.0
func (v *GetSessionEmbedUrlOutput) SerializeMembers(s smithy.ShapeSerializer)
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶ added in v1.113.0
IdempotencyTokenProvider interface for providing idempotency token
type ListActionConnectorsAPIClient ¶ added in v1.95.0
type ListActionConnectorsAPIClient interface {
ListActionConnectors(context.Context, *ListActionConnectorsInput, ...func(*Options)) (*ListActionConnectorsOutput, error)
}
ListActionConnectorsAPIClient is a client that implements the ListActionConnectors operation.
type ListActionConnectorsInput ¶ added in v1.95.0
type ListActionConnectorsInput struct {
// The Amazon Web Services account ID for which to list action connectors.
//
// This member is required.
AwsAccountId *string
// The maximum number of action connectors to return in a single response. Valid
// range is 1 to 100.
MaxResults *int32
// A pagination token to retrieve the next set of results. Use the token returned
// from a previous call to continue listing action connectors.
NextToken *string
// contains filtered or unexported fields
}
func (*ListActionConnectorsInput) Serialize ¶ added in v1.131.0
func (v *ListActionConnectorsInput) Serialize(s smithy.ShapeSerializer)
func (*ListActionConnectorsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListActionConnectorsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListActionConnectorsOutput ¶ added in v1.95.0
type ListActionConnectorsOutput struct {
// A list of action connector summaries containing basic information about each
// connector.
//
// This member is required.
ActionConnectorSummaries []types.ActionConnectorSummary
// A pagination token to retrieve the next set of results. If null, there are no
// more results to retrieve.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status code of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListActionConnectorsOutput) Deserialize ¶ added in v1.131.0
func (v *ListActionConnectorsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListActionConnectorsOutput) Serialize ¶ added in v1.131.0
func (v *ListActionConnectorsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListActionConnectorsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListActionConnectorsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListActionConnectorsPaginator ¶ added in v1.95.0
type ListActionConnectorsPaginator struct {
// contains filtered or unexported fields
}
ListActionConnectorsPaginator is a paginator for ListActionConnectors
func NewListActionConnectorsPaginator ¶ added in v1.95.0
func NewListActionConnectorsPaginator(client ListActionConnectorsAPIClient, params *ListActionConnectorsInput, optFns ...func(*ListActionConnectorsPaginatorOptions)) *ListActionConnectorsPaginator
NewListActionConnectorsPaginator returns a new ListActionConnectorsPaginator
func (*ListActionConnectorsPaginator) HasMorePages ¶ added in v1.95.0
func (p *ListActionConnectorsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListActionConnectorsPaginator) NextPage ¶ added in v1.95.0
func (p *ListActionConnectorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListActionConnectorsOutput, error)
NextPage retrieves the next ListActionConnectors page.
type ListActionConnectorsPaginatorOptions ¶ added in v1.95.0
type ListActionConnectorsPaginatorOptions struct {
// The maximum number of action connectors to return in a single response. Valid
// range is 1 to 100.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListActionConnectorsPaginatorOptions is the paginator options for ListActionConnectors
type ListAgentsInput ¶ added in v1.113.0
type ListAgentsInput struct {
// The ID of the Amazon Web Services account that contains the agents.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to return.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListAgentsInput) Serialize ¶ added in v1.131.0
func (v *ListAgentsInput) Serialize(s smithy.ShapeSerializer)
func (*ListAgentsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListAgentsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListAgentsOutput ¶ added in v1.113.0
type ListAgentsOutput struct {
// A list of agent summaries.
//
// This member is required.
AgentSummaries []types.AgentSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListAgentsOutput) Deserialize ¶ added in v1.131.0
func (v *ListAgentsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListAgentsOutput) Serialize ¶ added in v1.131.0
func (v *ListAgentsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListAgentsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListAgentsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListAnalysesAPIClient ¶ added in v0.30.0
type ListAnalysesAPIClient interface {
ListAnalyses(context.Context, *ListAnalysesInput, ...func(*Options)) (*ListAnalysesOutput, error)
}
ListAnalysesAPIClient is a client that implements the ListAnalyses operation.
type ListAnalysesInput ¶ added in v0.29.0
type ListAnalysesInput struct {
// The ID of the Amazon Web Services account that contains the analyses.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to return.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
// contains filtered or unexported fields
}
func (*ListAnalysesInput) Serialize ¶ added in v1.131.0
func (v *ListAnalysesInput) Serialize(s smithy.ShapeSerializer)
func (*ListAnalysesInput) SerializeMembers ¶ added in v1.131.0
func (v *ListAnalysesInput) SerializeMembers(s smithy.ShapeSerializer)
type ListAnalysesOutput ¶ added in v0.29.0
type ListAnalysesOutput struct {
// Metadata describing each of the analyses that are listed.
AnalysisSummaryList []types.AnalysisSummary
// A pagination token that can be used in a subsequent request.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListAnalysesOutput) Deserialize ¶ added in v1.131.0
func (v *ListAnalysesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListAnalysesOutput) Serialize ¶ added in v1.131.0
func (v *ListAnalysesOutput) Serialize(s smithy.ShapeSerializer)
func (*ListAnalysesOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListAnalysesOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListAnalysesPaginator ¶ added in v0.30.0
type ListAnalysesPaginator struct {
// contains filtered or unexported fields
}
ListAnalysesPaginator is a paginator for ListAnalyses
func NewListAnalysesPaginator ¶ added in v0.30.0
func NewListAnalysesPaginator(client ListAnalysesAPIClient, params *ListAnalysesInput, optFns ...func(*ListAnalysesPaginatorOptions)) *ListAnalysesPaginator
NewListAnalysesPaginator returns a new ListAnalysesPaginator
func (*ListAnalysesPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListAnalysesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAnalysesPaginator) NextPage ¶ added in v0.30.0
func (p *ListAnalysesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAnalysesOutput, error)
NextPage retrieves the next ListAnalyses page.
type ListAnalysesPaginatorOptions ¶ added in v0.30.0
type ListAnalysesPaginatorOptions struct {
// The maximum number of results to return.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListAnalysesPaginatorOptions is the paginator options for ListAnalyses
type ListApprovalPoliciesAPIClient ¶ added in v1.124.0
type ListApprovalPoliciesAPIClient interface {
ListApprovalPolicies(context.Context, *ListApprovalPoliciesInput, ...func(*Options)) (*ListApprovalPoliciesOutput, error)
}
ListApprovalPoliciesAPIClient is a client that implements the ListApprovalPolicies operation.
type ListApprovalPoliciesInput ¶ added in v1.124.0
type ListApprovalPoliciesInput struct {
// The maximum number of results to return in a single call. If you don't specify
// a value, the service returns a default number of results. Use the NextToken
// value in the response to retrieve additional results.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListApprovalPoliciesInput) Serialize ¶ added in v1.131.0
func (v *ListApprovalPoliciesInput) Serialize(s smithy.ShapeSerializer)
func (*ListApprovalPoliciesInput) SerializeMembers ¶ added in v1.131.0
func (v *ListApprovalPoliciesInput) SerializeMembers(s smithy.ShapeSerializer)
type ListApprovalPoliciesOutput ¶ added in v1.124.0
type ListApprovalPoliciesOutput struct {
// The list of approval policies.
//
// This member is required.
Policies []types.ApprovalPolicy
// The token for the next set of results, or null if there are no more results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListApprovalPoliciesOutput) Deserialize ¶ added in v1.131.0
func (v *ListApprovalPoliciesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListApprovalPoliciesOutput) Serialize ¶ added in v1.131.0
func (v *ListApprovalPoliciesOutput) Serialize(s smithy.ShapeSerializer)
func (*ListApprovalPoliciesOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListApprovalPoliciesOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListApprovalPoliciesPaginator ¶ added in v1.124.0
type ListApprovalPoliciesPaginator struct {
// contains filtered or unexported fields
}
ListApprovalPoliciesPaginator is a paginator for ListApprovalPolicies
func NewListApprovalPoliciesPaginator ¶ added in v1.124.0
func NewListApprovalPoliciesPaginator(client ListApprovalPoliciesAPIClient, params *ListApprovalPoliciesInput, optFns ...func(*ListApprovalPoliciesPaginatorOptions)) *ListApprovalPoliciesPaginator
NewListApprovalPoliciesPaginator returns a new ListApprovalPoliciesPaginator
func (*ListApprovalPoliciesPaginator) HasMorePages ¶ added in v1.124.0
func (p *ListApprovalPoliciesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListApprovalPoliciesPaginator) NextPage ¶ added in v1.124.0
func (p *ListApprovalPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListApprovalPoliciesOutput, error)
NextPage retrieves the next ListApprovalPolicies page.
type ListApprovalPoliciesPaginatorOptions ¶ added in v1.124.0
type ListApprovalPoliciesPaginatorOptions struct {
// The maximum number of results to return in a single call. If you don't specify
// a value, the service returns a default number of results. Use the NextToken
// value in the response to retrieve additional results.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListApprovalPoliciesPaginatorOptions is the paginator options for ListApprovalPolicies
type ListAppsAPIClient ¶ added in v1.127.0
type ListAppsAPIClient interface {
ListApps(context.Context, *ListAppsInput, ...func(*Options)) (*ListAppsOutput, error)
}
ListAppsAPIClient is a client that implements the ListApps operation.
type ListAppsInput ¶ added in v1.127.0
type ListAppsInput struct {
// The ID of the Amazon Web Services account that contains the apps.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to return in a single request. Valid range is 1
// to 100. If you don't specify a value, the default is 20.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListAppsInput) Serialize ¶ added in v1.131.0
func (v *ListAppsInput) Serialize(s smithy.ShapeSerializer)
func (*ListAppsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListAppsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListAppsOutput ¶ added in v1.127.0
type ListAppsOutput struct {
// A list of app summaries.
//
// This member is required.
AppSummaryList []types.AppSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListAppsOutput) Deserialize ¶ added in v1.131.0
func (v *ListAppsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListAppsOutput) Serialize ¶ added in v1.131.0
func (v *ListAppsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListAppsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListAppsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListAppsPaginator ¶ added in v1.127.0
type ListAppsPaginator struct {
// contains filtered or unexported fields
}
ListAppsPaginator is a paginator for ListApps
func NewListAppsPaginator ¶ added in v1.127.0
func NewListAppsPaginator(client ListAppsAPIClient, params *ListAppsInput, optFns ...func(*ListAppsPaginatorOptions)) *ListAppsPaginator
NewListAppsPaginator returns a new ListAppsPaginator
func (*ListAppsPaginator) HasMorePages ¶ added in v1.127.0
func (p *ListAppsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAppsPaginator) NextPage ¶ added in v1.127.0
func (p *ListAppsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppsOutput, error)
NextPage retrieves the next ListApps page.
type ListAppsPaginatorOptions ¶ added in v1.127.0
type ListAppsPaginatorOptions struct {
// The maximum number of results to return in a single request. Valid range is 1
// to 100. If you don't specify a value, the default is 20.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListAppsPaginatorOptions is the paginator options for ListApps
type ListAssetBundleExportJobsAPIClient ¶ added in v1.36.0
type ListAssetBundleExportJobsAPIClient interface {
ListAssetBundleExportJobs(context.Context, *ListAssetBundleExportJobsInput, ...func(*Options)) (*ListAssetBundleExportJobsOutput, error)
}
ListAssetBundleExportJobsAPIClient is a client that implements the ListAssetBundleExportJobs operation.
type ListAssetBundleExportJobsInput ¶ added in v1.36.0
type ListAssetBundleExportJobsInput struct {
// The ID of the Amazon Web Services account that the export jobs were executed
// in.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListAssetBundleExportJobsInput) Serialize ¶ added in v1.131.0
func (v *ListAssetBundleExportJobsInput) Serialize(s smithy.ShapeSerializer)
func (*ListAssetBundleExportJobsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListAssetBundleExportJobsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListAssetBundleExportJobsOutput ¶ added in v1.36.0
type ListAssetBundleExportJobsOutput struct {
// A list of export job summaries.
AssetBundleExportJobSummaryList []types.AssetBundleExportJobSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListAssetBundleExportJobsOutput) Deserialize ¶ added in v1.131.0
func (v *ListAssetBundleExportJobsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListAssetBundleExportJobsOutput) Serialize ¶ added in v1.131.0
func (v *ListAssetBundleExportJobsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListAssetBundleExportJobsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListAssetBundleExportJobsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListAssetBundleExportJobsPaginator ¶ added in v1.36.0
type ListAssetBundleExportJobsPaginator struct {
// contains filtered or unexported fields
}
ListAssetBundleExportJobsPaginator is a paginator for ListAssetBundleExportJobs
func NewListAssetBundleExportJobsPaginator ¶ added in v1.36.0
func NewListAssetBundleExportJobsPaginator(client ListAssetBundleExportJobsAPIClient, params *ListAssetBundleExportJobsInput, optFns ...func(*ListAssetBundleExportJobsPaginatorOptions)) *ListAssetBundleExportJobsPaginator
NewListAssetBundleExportJobsPaginator returns a new ListAssetBundleExportJobsPaginator
func (*ListAssetBundleExportJobsPaginator) HasMorePages ¶ added in v1.36.0
func (p *ListAssetBundleExportJobsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAssetBundleExportJobsPaginator) NextPage ¶ added in v1.36.0
func (p *ListAssetBundleExportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetBundleExportJobsOutput, error)
NextPage retrieves the next ListAssetBundleExportJobs page.
type ListAssetBundleExportJobsPaginatorOptions ¶ added in v1.36.0
type ListAssetBundleExportJobsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListAssetBundleExportJobsPaginatorOptions is the paginator options for ListAssetBundleExportJobs
type ListAssetBundleImportJobsAPIClient ¶ added in v1.36.0
type ListAssetBundleImportJobsAPIClient interface {
ListAssetBundleImportJobs(context.Context, *ListAssetBundleImportJobsInput, ...func(*Options)) (*ListAssetBundleImportJobsOutput, error)
}
ListAssetBundleImportJobsAPIClient is a client that implements the ListAssetBundleImportJobs operation.
type ListAssetBundleImportJobsInput ¶ added in v1.36.0
type ListAssetBundleImportJobsInput struct {
// The ID of the Amazon Web Services account that the import jobs were executed in.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListAssetBundleImportJobsInput) Serialize ¶ added in v1.131.0
func (v *ListAssetBundleImportJobsInput) Serialize(s smithy.ShapeSerializer)
func (*ListAssetBundleImportJobsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListAssetBundleImportJobsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListAssetBundleImportJobsOutput ¶ added in v1.36.0
type ListAssetBundleImportJobsOutput struct {
// A list of import job summaries.
AssetBundleImportJobSummaryList []types.AssetBundleImportJobSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the response.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListAssetBundleImportJobsOutput) Deserialize ¶ added in v1.131.0
func (v *ListAssetBundleImportJobsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListAssetBundleImportJobsOutput) Serialize ¶ added in v1.131.0
func (v *ListAssetBundleImportJobsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListAssetBundleImportJobsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListAssetBundleImportJobsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListAssetBundleImportJobsPaginator ¶ added in v1.36.0
type ListAssetBundleImportJobsPaginator struct {
// contains filtered or unexported fields
}
ListAssetBundleImportJobsPaginator is a paginator for ListAssetBundleImportJobs
func NewListAssetBundleImportJobsPaginator ¶ added in v1.36.0
func NewListAssetBundleImportJobsPaginator(client ListAssetBundleImportJobsAPIClient, params *ListAssetBundleImportJobsInput, optFns ...func(*ListAssetBundleImportJobsPaginatorOptions)) *ListAssetBundleImportJobsPaginator
NewListAssetBundleImportJobsPaginator returns a new ListAssetBundleImportJobsPaginator
func (*ListAssetBundleImportJobsPaginator) HasMorePages ¶ added in v1.36.0
func (p *ListAssetBundleImportJobsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAssetBundleImportJobsPaginator) NextPage ¶ added in v1.36.0
func (p *ListAssetBundleImportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAssetBundleImportJobsOutput, error)
NextPage retrieves the next ListAssetBundleImportJobs page.
type ListAssetBundleImportJobsPaginatorOptions ¶ added in v1.36.0
type ListAssetBundleImportJobsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListAssetBundleImportJobsPaginatorOptions is the paginator options for ListAssetBundleImportJobs
type ListBrandsAPIClient ¶ added in v1.79.0
type ListBrandsAPIClient interface {
ListBrands(context.Context, *ListBrandsInput, ...func(*Options)) (*ListBrandsOutput, error)
}
ListBrandsAPIClient is a client that implements the ListBrands operation.
type ListBrandsInput ¶ added in v1.79.0
type ListBrandsInput struct {
// The ID of the Amazon Web Services account that owns the brands that you want to
// list.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned in a single request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListBrandsInput) Serialize ¶ added in v1.131.0
func (v *ListBrandsInput) Serialize(s smithy.ShapeSerializer)
func (*ListBrandsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListBrandsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListBrandsOutput ¶ added in v1.79.0
type ListBrandsOutput struct {
// A list of all brands in your Amazon Web Services account. This structure
// provides basic information about each brand.
Brands []types.BrandSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListBrandsOutput) Deserialize ¶ added in v1.131.0
func (v *ListBrandsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListBrandsOutput) Serialize ¶ added in v1.131.0
func (v *ListBrandsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListBrandsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListBrandsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListBrandsPaginator ¶ added in v1.79.0
type ListBrandsPaginator struct {
// contains filtered or unexported fields
}
ListBrandsPaginator is a paginator for ListBrands
func NewListBrandsPaginator ¶ added in v1.79.0
func NewListBrandsPaginator(client ListBrandsAPIClient, params *ListBrandsInput, optFns ...func(*ListBrandsPaginatorOptions)) *ListBrandsPaginator
NewListBrandsPaginator returns a new ListBrandsPaginator
func (*ListBrandsPaginator) HasMorePages ¶ added in v1.79.0
func (p *ListBrandsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListBrandsPaginator) NextPage ¶ added in v1.79.0
func (p *ListBrandsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBrandsOutput, error)
NextPage retrieves the next ListBrands page.
type ListBrandsPaginatorOptions ¶ added in v1.79.0
type ListBrandsPaginatorOptions struct {
// The maximum number of results to be returned in a single request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListBrandsPaginatorOptions is the paginator options for ListBrands
type ListCustomPermissionsAPIClient ¶ added in v1.79.0
type ListCustomPermissionsAPIClient interface {
ListCustomPermissions(context.Context, *ListCustomPermissionsInput, ...func(*Options)) (*ListCustomPermissionsOutput, error)
}
ListCustomPermissionsAPIClient is a client that implements the ListCustomPermissions operation.
type ListCustomPermissionsInput ¶ added in v1.79.0
type ListCustomPermissionsInput struct {
// The ID of the Amazon Web Services account that contains the custom permissions
// profiles that you want to list.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to return.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListCustomPermissionsInput) Serialize ¶ added in v1.131.0
func (v *ListCustomPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*ListCustomPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListCustomPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListCustomPermissionsOutput ¶ added in v1.79.0
type ListCustomPermissionsOutput struct {
// A list of custom permissions profiles.
CustomPermissionsList []types.CustomPermissions
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListCustomPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *ListCustomPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListCustomPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *ListCustomPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListCustomPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListCustomPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListCustomPermissionsPaginator ¶ added in v1.79.0
type ListCustomPermissionsPaginator struct {
// contains filtered or unexported fields
}
ListCustomPermissionsPaginator is a paginator for ListCustomPermissions
func NewListCustomPermissionsPaginator ¶ added in v1.79.0
func NewListCustomPermissionsPaginator(client ListCustomPermissionsAPIClient, params *ListCustomPermissionsInput, optFns ...func(*ListCustomPermissionsPaginatorOptions)) *ListCustomPermissionsPaginator
NewListCustomPermissionsPaginator returns a new ListCustomPermissionsPaginator
func (*ListCustomPermissionsPaginator) HasMorePages ¶ added in v1.79.0
func (p *ListCustomPermissionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListCustomPermissionsPaginator) NextPage ¶ added in v1.79.0
func (p *ListCustomPermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCustomPermissionsOutput, error)
NextPage retrieves the next ListCustomPermissions page.
type ListCustomPermissionsPaginatorOptions ¶ added in v1.79.0
type ListCustomPermissionsPaginatorOptions struct {
// The maximum number of results to return.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListCustomPermissionsPaginatorOptions is the paginator options for ListCustomPermissions
type ListDashboardVersionsAPIClient ¶ added in v0.30.0
type ListDashboardVersionsAPIClient interface {
ListDashboardVersions(context.Context, *ListDashboardVersionsInput, ...func(*Options)) (*ListDashboardVersionsOutput, error)
}
ListDashboardVersionsAPIClient is a client that implements the ListDashboardVersions operation.
type ListDashboardVersionsInput ¶
type ListDashboardVersionsInput struct {
// The ID of the Amazon Web Services account that contains the dashboard that
// you're listing versions for.
//
// This member is required.
AwsAccountId *string
// The ID for the dashboard.
//
// This member is required.
DashboardId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListDashboardVersionsInput) Serialize ¶ added in v1.131.0
func (v *ListDashboardVersionsInput) Serialize(s smithy.ShapeSerializer)
func (*ListDashboardVersionsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListDashboardVersionsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListDashboardVersionsOutput ¶
type ListDashboardVersionsOutput struct {
// A structure that contains information about each version of the dashboard.
DashboardVersionSummaryList []types.DashboardVersionSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListDashboardVersionsOutput) Deserialize ¶ added in v1.131.0
func (v *ListDashboardVersionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListDashboardVersionsOutput) Serialize ¶ added in v1.131.0
func (v *ListDashboardVersionsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListDashboardVersionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListDashboardVersionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListDashboardVersionsPaginator ¶ added in v0.30.0
type ListDashboardVersionsPaginator struct {
// contains filtered or unexported fields
}
ListDashboardVersionsPaginator is a paginator for ListDashboardVersions
func NewListDashboardVersionsPaginator ¶ added in v0.30.0
func NewListDashboardVersionsPaginator(client ListDashboardVersionsAPIClient, params *ListDashboardVersionsInput, optFns ...func(*ListDashboardVersionsPaginatorOptions)) *ListDashboardVersionsPaginator
NewListDashboardVersionsPaginator returns a new ListDashboardVersionsPaginator
func (*ListDashboardVersionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListDashboardVersionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDashboardVersionsPaginator) NextPage ¶ added in v0.30.0
func (p *ListDashboardVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDashboardVersionsOutput, error)
NextPage retrieves the next ListDashboardVersions page.
type ListDashboardVersionsPaginatorOptions ¶ added in v0.30.0
type ListDashboardVersionsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListDashboardVersionsPaginatorOptions is the paginator options for ListDashboardVersions
type ListDashboardsAPIClient ¶ added in v0.30.0
type ListDashboardsAPIClient interface {
ListDashboards(context.Context, *ListDashboardsInput, ...func(*Options)) (*ListDashboardsOutput, error)
}
ListDashboardsAPIClient is a client that implements the ListDashboards operation.
type ListDashboardsInput ¶
type ListDashboardsInput struct {
// The ID of the Amazon Web Services account that contains the dashboards that
// you're listing.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListDashboardsInput) Serialize ¶ added in v1.131.0
func (v *ListDashboardsInput) Serialize(s smithy.ShapeSerializer)
func (*ListDashboardsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListDashboardsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListDashboardsOutput ¶
type ListDashboardsOutput struct {
// A structure that contains all of the dashboards in your Amazon Web Services
// account. This structure provides basic information about the dashboards.
DashboardSummaryList []types.DashboardSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListDashboardsOutput) Deserialize ¶ added in v1.131.0
func (v *ListDashboardsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListDashboardsOutput) Serialize ¶ added in v1.131.0
func (v *ListDashboardsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListDashboardsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListDashboardsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListDashboardsPaginator ¶ added in v0.30.0
type ListDashboardsPaginator struct {
// contains filtered or unexported fields
}
ListDashboardsPaginator is a paginator for ListDashboards
func NewListDashboardsPaginator ¶ added in v0.30.0
func NewListDashboardsPaginator(client ListDashboardsAPIClient, params *ListDashboardsInput, optFns ...func(*ListDashboardsPaginatorOptions)) *ListDashboardsPaginator
NewListDashboardsPaginator returns a new ListDashboardsPaginator
func (*ListDashboardsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListDashboardsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDashboardsPaginator) NextPage ¶ added in v0.30.0
func (p *ListDashboardsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDashboardsOutput, error)
NextPage retrieves the next ListDashboards page.
type ListDashboardsPaginatorOptions ¶ added in v0.30.0
type ListDashboardsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListDashboardsPaginatorOptions is the paginator options for ListDashboards
type ListDataSetsAPIClient ¶ added in v0.30.0
type ListDataSetsAPIClient interface {
ListDataSets(context.Context, *ListDataSetsInput, ...func(*Options)) (*ListDataSetsOutput, error)
}
ListDataSetsAPIClient is a client that implements the ListDataSets operation.
type ListDataSetsInput ¶
type ListDataSetsInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListDataSetsInput) Serialize ¶ added in v1.131.0
func (v *ListDataSetsInput) Serialize(s smithy.ShapeSerializer)
func (*ListDataSetsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListDataSetsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListDataSetsOutput ¶
type ListDataSetsOutput struct {
// The list of dataset summaries.
DataSetSummaries []types.DataSetSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListDataSetsOutput) Deserialize ¶ added in v1.131.0
func (v *ListDataSetsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListDataSetsOutput) Serialize ¶ added in v1.131.0
func (v *ListDataSetsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListDataSetsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListDataSetsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListDataSetsPaginator ¶ added in v0.30.0
type ListDataSetsPaginator struct {
// contains filtered or unexported fields
}
ListDataSetsPaginator is a paginator for ListDataSets
func NewListDataSetsPaginator ¶ added in v0.30.0
func NewListDataSetsPaginator(client ListDataSetsAPIClient, params *ListDataSetsInput, optFns ...func(*ListDataSetsPaginatorOptions)) *ListDataSetsPaginator
NewListDataSetsPaginator returns a new ListDataSetsPaginator
func (*ListDataSetsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListDataSetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDataSetsPaginator) NextPage ¶ added in v0.30.0
func (p *ListDataSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataSetsOutput, error)
NextPage retrieves the next ListDataSets page.
type ListDataSetsPaginatorOptions ¶ added in v0.30.0
type ListDataSetsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListDataSetsPaginatorOptions is the paginator options for ListDataSets
type ListDataSourcesAPIClient ¶ added in v0.30.0
type ListDataSourcesAPIClient interface {
ListDataSources(context.Context, *ListDataSourcesInput, ...func(*Options)) (*ListDataSourcesOutput, error)
}
ListDataSourcesAPIClient is a client that implements the ListDataSources operation.
type ListDataSourcesInput ¶
type ListDataSourcesInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListDataSourcesInput) Serialize ¶ added in v1.131.0
func (v *ListDataSourcesInput) Serialize(s smithy.ShapeSerializer)
func (*ListDataSourcesInput) SerializeMembers ¶ added in v1.131.0
func (v *ListDataSourcesInput) SerializeMembers(s smithy.ShapeSerializer)
type ListDataSourcesOutput ¶
type ListDataSourcesOutput struct {
// A list of data sources.
DataSources []types.DataSource
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListDataSourcesOutput) Deserialize ¶ added in v1.131.0
func (v *ListDataSourcesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListDataSourcesOutput) Serialize ¶ added in v1.131.0
func (v *ListDataSourcesOutput) Serialize(s smithy.ShapeSerializer)
func (*ListDataSourcesOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListDataSourcesOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListDataSourcesPaginator ¶ added in v0.30.0
type ListDataSourcesPaginator struct {
// contains filtered or unexported fields
}
ListDataSourcesPaginator is a paginator for ListDataSources
func NewListDataSourcesPaginator ¶ added in v0.30.0
func NewListDataSourcesPaginator(client ListDataSourcesAPIClient, params *ListDataSourcesInput, optFns ...func(*ListDataSourcesPaginatorOptions)) *ListDataSourcesPaginator
NewListDataSourcesPaginator returns a new ListDataSourcesPaginator
func (*ListDataSourcesPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListDataSourcesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDataSourcesPaginator) NextPage ¶ added in v0.30.0
func (p *ListDataSourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDataSourcesOutput, error)
NextPage retrieves the next ListDataSources page.
type ListDataSourcesPaginatorOptions ¶ added in v0.30.0
type ListDataSourcesPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListDataSourcesPaginatorOptions is the paginator options for ListDataSources
type ListDlpSettingsAPIClient ¶ added in v1.124.0
type ListDlpSettingsAPIClient interface {
ListDlpSettings(context.Context, *ListDlpSettingsInput, ...func(*Options)) (*ListDlpSettingsOutput, error)
}
ListDlpSettingsAPIClient is a client that implements the ListDlpSettings operation.
type ListDlpSettingsInput ¶ added in v1.124.0
type ListDlpSettingsInput struct {
// The ID of the Amazon Web Services account that contains the DLP settings that
// you want to list.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to return per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListDlpSettingsInput) Serialize ¶ added in v1.131.0
func (v *ListDlpSettingsInput) Serialize(s smithy.ShapeSerializer)
func (*ListDlpSettingsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListDlpSettingsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListDlpSettingsOutput ¶ added in v1.124.0
type ListDlpSettingsOutput struct {
// A list of DlpSettingSummary objects for the DLP settings in the account. The
// list is empty if no DLP settings have been configured.
//
// This member is required.
DlpSettingSummaries []types.DlpSettingSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListDlpSettingsOutput) Deserialize ¶ added in v1.131.0
func (v *ListDlpSettingsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListDlpSettingsOutput) Serialize ¶ added in v1.131.0
func (v *ListDlpSettingsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListDlpSettingsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListDlpSettingsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListDlpSettingsPaginator ¶ added in v1.124.0
type ListDlpSettingsPaginator struct {
// contains filtered or unexported fields
}
ListDlpSettingsPaginator is a paginator for ListDlpSettings
func NewListDlpSettingsPaginator ¶ added in v1.124.0
func NewListDlpSettingsPaginator(client ListDlpSettingsAPIClient, params *ListDlpSettingsInput, optFns ...func(*ListDlpSettingsPaginatorOptions)) *ListDlpSettingsPaginator
NewListDlpSettingsPaginator returns a new ListDlpSettingsPaginator
func (*ListDlpSettingsPaginator) HasMorePages ¶ added in v1.124.0
func (p *ListDlpSettingsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDlpSettingsPaginator) NextPage ¶ added in v1.124.0
func (p *ListDlpSettingsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDlpSettingsOutput, error)
NextPage retrieves the next ListDlpSettings page.
type ListDlpSettingsPaginatorOptions ¶ added in v1.124.0
type ListDlpSettingsPaginatorOptions struct {
// The maximum number of results to return per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListDlpSettingsPaginatorOptions is the paginator options for ListDlpSettings
type ListFlowsAPIClient ¶ added in v1.95.0
type ListFlowsAPIClient interface {
ListFlows(context.Context, *ListFlowsInput, ...func(*Options)) (*ListFlowsOutput, error)
}
ListFlowsAPIClient is a client that implements the ListFlows operation.
type ListFlowsInput ¶ added in v1.95.0
type ListFlowsInput struct {
// The ID of the Amazon Web Services account that contains the flow list that you
// are getting.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token to request the next set of results, or null if you want to retrieve
// the first set.
NextToken *string
// contains filtered or unexported fields
}
func (*ListFlowsInput) Serialize ¶ added in v1.131.0
func (v *ListFlowsInput) Serialize(s smithy.ShapeSerializer)
func (*ListFlowsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListFlowsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListFlowsOutput ¶ added in v1.95.0
type ListFlowsOutput struct {
// A structure that contains all of the flows in your Amazon Web Services account.
// This structure provides basic information about the flows.
FlowSummaryList []types.FlowSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListFlowsOutput) Deserialize ¶ added in v1.131.0
func (v *ListFlowsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListFlowsOutput) Serialize ¶ added in v1.131.0
func (v *ListFlowsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListFlowsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListFlowsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListFlowsPaginator ¶ added in v1.95.0
type ListFlowsPaginator struct {
// contains filtered or unexported fields
}
ListFlowsPaginator is a paginator for ListFlows
func NewListFlowsPaginator ¶ added in v1.95.0
func NewListFlowsPaginator(client ListFlowsAPIClient, params *ListFlowsInput, optFns ...func(*ListFlowsPaginatorOptions)) *ListFlowsPaginator
NewListFlowsPaginator returns a new ListFlowsPaginator
func (*ListFlowsPaginator) HasMorePages ¶ added in v1.95.0
func (p *ListFlowsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListFlowsPaginator) NextPage ¶ added in v1.95.0
func (p *ListFlowsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFlowsOutput, error)
NextPage retrieves the next ListFlows page.
type ListFlowsPaginatorOptions ¶ added in v1.95.0
type ListFlowsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListFlowsPaginatorOptions is the paginator options for ListFlows
type ListFolderMembersAPIClient ¶ added in v1.42.0
type ListFolderMembersAPIClient interface {
ListFolderMembers(context.Context, *ListFolderMembersInput, ...func(*Options)) (*ListFolderMembersOutput, error)
}
ListFolderMembersAPIClient is a client that implements the ListFolderMembers operation.
type ListFolderMembersInput ¶ added in v1.6.0
type ListFolderMembersInput struct {
// The ID for the Amazon Web Services account that contains the folder.
//
// This member is required.
AwsAccountId *string
// The ID of the folder.
//
// This member is required.
FolderId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListFolderMembersInput) Serialize ¶ added in v1.131.0
func (v *ListFolderMembersInput) Serialize(s smithy.ShapeSerializer)
func (*ListFolderMembersInput) SerializeMembers ¶ added in v1.131.0
func (v *ListFolderMembersInput) SerializeMembers(s smithy.ShapeSerializer)
type ListFolderMembersOutput ¶ added in v1.6.0
type ListFolderMembersOutput struct {
// A structure that contains all of the folder members (dashboards, analyses, and
// datasets) in the folder.
FolderMemberList []types.MemberIdArnPair
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListFolderMembersOutput) Deserialize ¶ added in v1.131.0
func (v *ListFolderMembersOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListFolderMembersOutput) Serialize ¶ added in v1.131.0
func (v *ListFolderMembersOutput) Serialize(s smithy.ShapeSerializer)
func (*ListFolderMembersOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListFolderMembersOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListFolderMembersPaginator ¶ added in v1.42.0
type ListFolderMembersPaginator struct {
// contains filtered or unexported fields
}
ListFolderMembersPaginator is a paginator for ListFolderMembers
func NewListFolderMembersPaginator ¶ added in v1.42.0
func NewListFolderMembersPaginator(client ListFolderMembersAPIClient, params *ListFolderMembersInput, optFns ...func(*ListFolderMembersPaginatorOptions)) *ListFolderMembersPaginator
NewListFolderMembersPaginator returns a new ListFolderMembersPaginator
func (*ListFolderMembersPaginator) HasMorePages ¶ added in v1.42.0
func (p *ListFolderMembersPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListFolderMembersPaginator) NextPage ¶ added in v1.42.0
func (p *ListFolderMembersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFolderMembersOutput, error)
NextPage retrieves the next ListFolderMembers page.
type ListFolderMembersPaginatorOptions ¶ added in v1.42.0
type ListFolderMembersPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListFolderMembersPaginatorOptions is the paginator options for ListFolderMembers
type ListFoldersAPIClient ¶ added in v1.42.0
type ListFoldersAPIClient interface {
ListFolders(context.Context, *ListFoldersInput, ...func(*Options)) (*ListFoldersOutput, error)
}
ListFoldersAPIClient is a client that implements the ListFolders operation.
type ListFoldersForResourceAPIClient ¶ added in v1.72.0
type ListFoldersForResourceAPIClient interface {
ListFoldersForResource(context.Context, *ListFoldersForResourceInput, ...func(*Options)) (*ListFoldersForResourceOutput, error)
}
ListFoldersForResourceAPIClient is a client that implements the ListFoldersForResource operation.
type ListFoldersForResourceInput ¶ added in v1.72.0
type ListFoldersForResourceInput struct {
// The ID for the Amazon Web Services account that contains the resource.
//
// This member is required.
AwsAccountId *string
// The Amazon Resource Name (ARN) the resource whose folders you need to list.
//
// This member is required.
ResourceArn *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListFoldersForResourceInput) Serialize ¶ added in v1.131.0
func (v *ListFoldersForResourceInput) Serialize(s smithy.ShapeSerializer)
func (*ListFoldersForResourceInput) SerializeMembers ¶ added in v1.131.0
func (v *ListFoldersForResourceInput) SerializeMembers(s smithy.ShapeSerializer)
type ListFoldersForResourceOutput ¶ added in v1.72.0
type ListFoldersForResourceOutput struct {
// A list that contains the Amazon Resource Names (ARNs) of all folders that the
// resource is a member of.
Folders []string
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListFoldersForResourceOutput) Deserialize ¶ added in v1.131.0
func (v *ListFoldersForResourceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListFoldersForResourceOutput) Serialize ¶ added in v1.131.0
func (v *ListFoldersForResourceOutput) Serialize(s smithy.ShapeSerializer)
func (*ListFoldersForResourceOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListFoldersForResourceOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListFoldersForResourcePaginator ¶ added in v1.72.0
type ListFoldersForResourcePaginator struct {
// contains filtered or unexported fields
}
ListFoldersForResourcePaginator is a paginator for ListFoldersForResource
func NewListFoldersForResourcePaginator ¶ added in v1.72.0
func NewListFoldersForResourcePaginator(client ListFoldersForResourceAPIClient, params *ListFoldersForResourceInput, optFns ...func(*ListFoldersForResourcePaginatorOptions)) *ListFoldersForResourcePaginator
NewListFoldersForResourcePaginator returns a new ListFoldersForResourcePaginator
func (*ListFoldersForResourcePaginator) HasMorePages ¶ added in v1.72.0
func (p *ListFoldersForResourcePaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListFoldersForResourcePaginator) NextPage ¶ added in v1.72.0
func (p *ListFoldersForResourcePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFoldersForResourceOutput, error)
NextPage retrieves the next ListFoldersForResource page.
type ListFoldersForResourcePaginatorOptions ¶ added in v1.72.0
type ListFoldersForResourcePaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListFoldersForResourcePaginatorOptions is the paginator options for ListFoldersForResource
type ListFoldersInput ¶ added in v1.6.0
type ListFoldersInput struct {
// The ID for the Amazon Web Services account that contains the folder.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListFoldersInput) Serialize ¶ added in v1.131.0
func (v *ListFoldersInput) Serialize(s smithy.ShapeSerializer)
func (*ListFoldersInput) SerializeMembers ¶ added in v1.131.0
func (v *ListFoldersInput) SerializeMembers(s smithy.ShapeSerializer)
type ListFoldersOutput ¶ added in v1.6.0
type ListFoldersOutput struct {
// A structure that contains all of the folders in the Amazon Web Services
// account. This structure provides basic information about the folders.
FolderSummaryList []types.FolderSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListFoldersOutput) Deserialize ¶ added in v1.131.0
func (v *ListFoldersOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListFoldersOutput) Serialize ¶ added in v1.131.0
func (v *ListFoldersOutput) Serialize(s smithy.ShapeSerializer)
func (*ListFoldersOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListFoldersOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListFoldersPaginator ¶ added in v1.42.0
type ListFoldersPaginator struct {
// contains filtered or unexported fields
}
ListFoldersPaginator is a paginator for ListFolders
func NewListFoldersPaginator ¶ added in v1.42.0
func NewListFoldersPaginator(client ListFoldersAPIClient, params *ListFoldersInput, optFns ...func(*ListFoldersPaginatorOptions)) *ListFoldersPaginator
NewListFoldersPaginator returns a new ListFoldersPaginator
func (*ListFoldersPaginator) HasMorePages ¶ added in v1.42.0
func (p *ListFoldersPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListFoldersPaginator) NextPage ¶ added in v1.42.0
func (p *ListFoldersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFoldersOutput, error)
NextPage retrieves the next ListFolders page.
type ListFoldersPaginatorOptions ¶ added in v1.42.0
type ListFoldersPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListFoldersPaginatorOptions is the paginator options for ListFolders
type ListGroupMembershipsAPIClient ¶ added in v1.39.0
type ListGroupMembershipsAPIClient interface {
ListGroupMemberships(context.Context, *ListGroupMembershipsInput, ...func(*Options)) (*ListGroupMembershipsOutput, error)
}
ListGroupMembershipsAPIClient is a client that implements the ListGroupMemberships operation.
type ListGroupMembershipsInput ¶
type ListGroupMembershipsInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The name of the group that you want to see a membership list of.
//
// This member is required.
GroupName *string
// The namespace of the group that you want a list of users from.
//
// This member is required.
Namespace *string
// The maximum number of results to return from this request.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
// contains filtered or unexported fields
}
func (*ListGroupMembershipsInput) Serialize ¶ added in v1.131.0
func (v *ListGroupMembershipsInput) Serialize(s smithy.ShapeSerializer)
func (*ListGroupMembershipsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListGroupMembershipsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListGroupMembershipsOutput ¶
type ListGroupMembershipsOutput struct {
// The list of the members of the group.
GroupMemberList []types.GroupMember
// A pagination token that can be used in a subsequent request.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListGroupMembershipsOutput) Deserialize ¶ added in v1.131.0
func (v *ListGroupMembershipsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListGroupMembershipsOutput) Serialize ¶ added in v1.131.0
func (v *ListGroupMembershipsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListGroupMembershipsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListGroupMembershipsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListGroupMembershipsPaginator ¶ added in v1.39.0
type ListGroupMembershipsPaginator struct {
// contains filtered or unexported fields
}
ListGroupMembershipsPaginator is a paginator for ListGroupMemberships
func NewListGroupMembershipsPaginator ¶ added in v1.39.0
func NewListGroupMembershipsPaginator(client ListGroupMembershipsAPIClient, params *ListGroupMembershipsInput, optFns ...func(*ListGroupMembershipsPaginatorOptions)) *ListGroupMembershipsPaginator
NewListGroupMembershipsPaginator returns a new ListGroupMembershipsPaginator
func (*ListGroupMembershipsPaginator) HasMorePages ¶ added in v1.39.0
func (p *ListGroupMembershipsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListGroupMembershipsPaginator) NextPage ¶ added in v1.39.0
func (p *ListGroupMembershipsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGroupMembershipsOutput, error)
NextPage retrieves the next ListGroupMemberships page.
type ListGroupMembershipsPaginatorOptions ¶ added in v1.39.0
type ListGroupMembershipsPaginatorOptions struct {
// The maximum number of results to return from this request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListGroupMembershipsPaginatorOptions is the paginator options for ListGroupMemberships
type ListGroupsAPIClient ¶ added in v1.39.0
type ListGroupsAPIClient interface {
ListGroups(context.Context, *ListGroupsInput, ...func(*Options)) (*ListGroupsOutput, error)
}
ListGroupsAPIClient is a client that implements the ListGroups operation.
type ListGroupsInput ¶
type ListGroupsInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The namespace that you want a list of groups from.
//
// This member is required.
Namespace *string
// The maximum number of results to return.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
// contains filtered or unexported fields
}
func (*ListGroupsInput) Serialize ¶ added in v1.131.0
func (v *ListGroupsInput) Serialize(s smithy.ShapeSerializer)
func (*ListGroupsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListGroupsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListGroupsOutput ¶
type ListGroupsOutput struct {
// The list of the groups.
GroupList []types.Group
// A pagination token that can be used in a subsequent request.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListGroupsOutput) Deserialize ¶ added in v1.131.0
func (v *ListGroupsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListGroupsOutput) Serialize ¶ added in v1.131.0
func (v *ListGroupsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListGroupsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListGroupsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListGroupsPaginator ¶ added in v1.39.0
type ListGroupsPaginator struct {
// contains filtered or unexported fields
}
ListGroupsPaginator is a paginator for ListGroups
func NewListGroupsPaginator ¶ added in v1.39.0
func NewListGroupsPaginator(client ListGroupsAPIClient, params *ListGroupsInput, optFns ...func(*ListGroupsPaginatorOptions)) *ListGroupsPaginator
NewListGroupsPaginator returns a new ListGroupsPaginator
func (*ListGroupsPaginator) HasMorePages ¶ added in v1.39.0
func (p *ListGroupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListGroupsPaginator) NextPage ¶ added in v1.39.0
func (p *ListGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListGroupsOutput, error)
NextPage retrieves the next ListGroups page.
type ListGroupsPaginatorOptions ¶ added in v1.39.0
type ListGroupsPaginatorOptions struct {
// The maximum number of results to return.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListGroupsPaginatorOptions is the paginator options for ListGroups
type ListIAMPolicyAssignmentsAPIClient ¶ added in v1.39.0
type ListIAMPolicyAssignmentsAPIClient interface {
ListIAMPolicyAssignments(context.Context, *ListIAMPolicyAssignmentsInput, ...func(*Options)) (*ListIAMPolicyAssignmentsOutput, error)
}
ListIAMPolicyAssignmentsAPIClient is a client that implements the ListIAMPolicyAssignments operation.
type ListIAMPolicyAssignmentsForUserAPIClient ¶ added in v1.39.0
type ListIAMPolicyAssignmentsForUserAPIClient interface {
ListIAMPolicyAssignmentsForUser(context.Context, *ListIAMPolicyAssignmentsForUserInput, ...func(*Options)) (*ListIAMPolicyAssignmentsForUserOutput, error)
}
ListIAMPolicyAssignmentsForUserAPIClient is a client that implements the ListIAMPolicyAssignmentsForUser operation.
type ListIAMPolicyAssignmentsForUserInput ¶
type ListIAMPolicyAssignmentsForUserInput struct {
// The ID of the Amazon Web Services account that contains the assignments.
//
// This member is required.
AwsAccountId *string
// The namespace of the assignment.
//
// This member is required.
Namespace *string
// The name of the user.
//
// This member is required.
UserName *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListIAMPolicyAssignmentsForUserInput) Serialize ¶ added in v1.131.0
func (v *ListIAMPolicyAssignmentsForUserInput) Serialize(s smithy.ShapeSerializer)
func (*ListIAMPolicyAssignmentsForUserInput) SerializeMembers ¶ added in v1.131.0
func (v *ListIAMPolicyAssignmentsForUserInput) SerializeMembers(s smithy.ShapeSerializer)
type ListIAMPolicyAssignmentsForUserOutput ¶
type ListIAMPolicyAssignmentsForUserOutput struct {
// The active assignments for this user.
ActiveAssignments []types.ActiveIAMPolicyAssignment
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListIAMPolicyAssignmentsForUserOutput) Deserialize ¶ added in v1.131.0
func (v *ListIAMPolicyAssignmentsForUserOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListIAMPolicyAssignmentsForUserOutput) Serialize ¶ added in v1.131.0
func (v *ListIAMPolicyAssignmentsForUserOutput) Serialize(s smithy.ShapeSerializer)
func (*ListIAMPolicyAssignmentsForUserOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListIAMPolicyAssignmentsForUserOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListIAMPolicyAssignmentsForUserPaginator ¶ added in v1.39.0
type ListIAMPolicyAssignmentsForUserPaginator struct {
// contains filtered or unexported fields
}
ListIAMPolicyAssignmentsForUserPaginator is a paginator for ListIAMPolicyAssignmentsForUser
func NewListIAMPolicyAssignmentsForUserPaginator ¶ added in v1.39.0
func NewListIAMPolicyAssignmentsForUserPaginator(client ListIAMPolicyAssignmentsForUserAPIClient, params *ListIAMPolicyAssignmentsForUserInput, optFns ...func(*ListIAMPolicyAssignmentsForUserPaginatorOptions)) *ListIAMPolicyAssignmentsForUserPaginator
NewListIAMPolicyAssignmentsForUserPaginator returns a new ListIAMPolicyAssignmentsForUserPaginator
func (*ListIAMPolicyAssignmentsForUserPaginator) HasMorePages ¶ added in v1.39.0
func (p *ListIAMPolicyAssignmentsForUserPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListIAMPolicyAssignmentsForUserPaginator) NextPage ¶ added in v1.39.0
func (p *ListIAMPolicyAssignmentsForUserPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIAMPolicyAssignmentsForUserOutput, error)
NextPage retrieves the next ListIAMPolicyAssignmentsForUser page.
type ListIAMPolicyAssignmentsForUserPaginatorOptions ¶ added in v1.39.0
type ListIAMPolicyAssignmentsForUserPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListIAMPolicyAssignmentsForUserPaginatorOptions is the paginator options for ListIAMPolicyAssignmentsForUser
type ListIAMPolicyAssignmentsInput ¶
type ListIAMPolicyAssignmentsInput struct {
// The ID of the Amazon Web Services account that contains these IAM policy
// assignments.
//
// This member is required.
AwsAccountId *string
// The namespace for the assignments.
//
// This member is required.
Namespace *string
// The status of the assignments.
AssignmentStatus types.AssignmentStatus
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListIAMPolicyAssignmentsInput) Serialize ¶ added in v1.131.0
func (v *ListIAMPolicyAssignmentsInput) Serialize(s smithy.ShapeSerializer)
func (*ListIAMPolicyAssignmentsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListIAMPolicyAssignmentsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListIAMPolicyAssignmentsOutput ¶
type ListIAMPolicyAssignmentsOutput struct {
// Information describing the IAM policy assignments.
IAMPolicyAssignments []types.IAMPolicyAssignmentSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListIAMPolicyAssignmentsOutput) Deserialize ¶ added in v1.131.0
func (v *ListIAMPolicyAssignmentsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListIAMPolicyAssignmentsOutput) Serialize ¶ added in v1.131.0
func (v *ListIAMPolicyAssignmentsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListIAMPolicyAssignmentsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListIAMPolicyAssignmentsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListIAMPolicyAssignmentsPaginator ¶ added in v1.39.0
type ListIAMPolicyAssignmentsPaginator struct {
// contains filtered or unexported fields
}
ListIAMPolicyAssignmentsPaginator is a paginator for ListIAMPolicyAssignments
func NewListIAMPolicyAssignmentsPaginator ¶ added in v1.39.0
func NewListIAMPolicyAssignmentsPaginator(client ListIAMPolicyAssignmentsAPIClient, params *ListIAMPolicyAssignmentsInput, optFns ...func(*ListIAMPolicyAssignmentsPaginatorOptions)) *ListIAMPolicyAssignmentsPaginator
NewListIAMPolicyAssignmentsPaginator returns a new ListIAMPolicyAssignmentsPaginator
func (*ListIAMPolicyAssignmentsPaginator) HasMorePages ¶ added in v1.39.0
func (p *ListIAMPolicyAssignmentsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListIAMPolicyAssignmentsPaginator) NextPage ¶ added in v1.39.0
func (p *ListIAMPolicyAssignmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIAMPolicyAssignmentsOutput, error)
NextPage retrieves the next ListIAMPolicyAssignments page.
type ListIAMPolicyAssignmentsPaginatorOptions ¶ added in v1.39.0
type ListIAMPolicyAssignmentsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListIAMPolicyAssignmentsPaginatorOptions is the paginator options for ListIAMPolicyAssignments
type ListIdentityPropagationConfigsInput ¶ added in v1.52.0
type ListIdentityPropagationConfigsInput struct {
// The ID of the Amazon Web Services account that contain the identity propagation
// configurations of.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListIdentityPropagationConfigsInput) Serialize ¶ added in v1.131.0
func (v *ListIdentityPropagationConfigsInput) Serialize(s smithy.ShapeSerializer)
func (*ListIdentityPropagationConfigsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListIdentityPropagationConfigsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListIdentityPropagationConfigsOutput ¶ added in v1.52.0
type ListIdentityPropagationConfigsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// A list of services and their authorized targets that the Quick Sight IAM
// Identity Center application can access.
Services []types.AuthorizedTargetsByService
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListIdentityPropagationConfigsOutput) Deserialize ¶ added in v1.131.0
func (v *ListIdentityPropagationConfigsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListIdentityPropagationConfigsOutput) Serialize ¶ added in v1.131.0
func (v *ListIdentityPropagationConfigsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListIdentityPropagationConfigsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListIdentityPropagationConfigsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListIngestionsAPIClient ¶ added in v0.30.0
type ListIngestionsAPIClient interface {
ListIngestions(context.Context, *ListIngestionsInput, ...func(*Options)) (*ListIngestionsOutput, error)
}
ListIngestionsAPIClient is a client that implements the ListIngestions operation.
type ListIngestionsInput ¶
type ListIngestionsInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset used in the ingestion.
//
// This member is required.
DataSetId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListIngestionsInput) Serialize ¶ added in v1.131.0
func (v *ListIngestionsInput) Serialize(s smithy.ShapeSerializer)
func (*ListIngestionsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListIngestionsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListIngestionsOutput ¶
type ListIngestionsOutput struct {
// A list of the ingestions.
Ingestions []types.Ingestion
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListIngestionsOutput) Deserialize ¶ added in v1.131.0
func (v *ListIngestionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListIngestionsOutput) Serialize ¶ added in v1.131.0
func (v *ListIngestionsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListIngestionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListIngestionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListIngestionsPaginator ¶ added in v0.30.0
type ListIngestionsPaginator struct {
// contains filtered or unexported fields
}
ListIngestionsPaginator is a paginator for ListIngestions
func NewListIngestionsPaginator ¶ added in v0.30.0
func NewListIngestionsPaginator(client ListIngestionsAPIClient, params *ListIngestionsInput, optFns ...func(*ListIngestionsPaginatorOptions)) *ListIngestionsPaginator
NewListIngestionsPaginator returns a new ListIngestionsPaginator
func (*ListIngestionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListIngestionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListIngestionsPaginator) NextPage ¶ added in v0.30.0
func (p *ListIngestionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIngestionsOutput, error)
NextPage retrieves the next ListIngestions page.
type ListIngestionsPaginatorOptions ¶ added in v0.30.0
type ListIngestionsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListIngestionsPaginatorOptions is the paginator options for ListIngestions
type ListKnowledgeBasesAPIClient ¶ added in v1.114.0
type ListKnowledgeBasesAPIClient interface {
ListKnowledgeBases(context.Context, *ListKnowledgeBasesInput, ...func(*Options)) (*ListKnowledgeBasesOutput, error)
}
ListKnowledgeBasesAPIClient is a client that implements the ListKnowledgeBases operation.
type ListKnowledgeBasesInput ¶ added in v1.114.0
type ListKnowledgeBasesInput struct {
// The ID of the Amazon Web Services account that contains the knowledge base.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to return.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListKnowledgeBasesInput) Serialize ¶ added in v1.131.0
func (v *ListKnowledgeBasesInput) Serialize(s smithy.ShapeSerializer)
func (*ListKnowledgeBasesInput) SerializeMembers ¶ added in v1.131.0
func (v *ListKnowledgeBasesInput) SerializeMembers(s smithy.ShapeSerializer)
type ListKnowledgeBasesOutput ¶ added in v1.114.0
type ListKnowledgeBasesOutput struct {
// A list of knowledge base summaries.
//
// This member is required.
KnowledgeBaseSummaries []types.KnowledgeBaseSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status *int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListKnowledgeBasesOutput) Deserialize ¶ added in v1.131.0
func (v *ListKnowledgeBasesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListKnowledgeBasesOutput) Serialize ¶ added in v1.131.0
func (v *ListKnowledgeBasesOutput) Serialize(s smithy.ShapeSerializer)
func (*ListKnowledgeBasesOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListKnowledgeBasesOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListKnowledgeBasesPaginator ¶ added in v1.114.0
type ListKnowledgeBasesPaginator struct {
// contains filtered or unexported fields
}
ListKnowledgeBasesPaginator is a paginator for ListKnowledgeBases
func NewListKnowledgeBasesPaginator ¶ added in v1.114.0
func NewListKnowledgeBasesPaginator(client ListKnowledgeBasesAPIClient, params *ListKnowledgeBasesInput, optFns ...func(*ListKnowledgeBasesPaginatorOptions)) *ListKnowledgeBasesPaginator
NewListKnowledgeBasesPaginator returns a new ListKnowledgeBasesPaginator
func (*ListKnowledgeBasesPaginator) HasMorePages ¶ added in v1.114.0
func (p *ListKnowledgeBasesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListKnowledgeBasesPaginator) NextPage ¶ added in v1.114.0
func (p *ListKnowledgeBasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListKnowledgeBasesOutput, error)
NextPage retrieves the next ListKnowledgeBases page.
type ListKnowledgeBasesPaginatorOptions ¶ added in v1.114.0
type ListKnowledgeBasesPaginatorOptions struct {
// The maximum number of results to return.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListKnowledgeBasesPaginatorOptions is the paginator options for ListKnowledgeBases
type ListLimitsProfilesAPIClient ¶ added in v1.124.0
type ListLimitsProfilesAPIClient interface {
ListLimitsProfiles(context.Context, *ListLimitsProfilesInput, ...func(*Options)) (*ListLimitsProfilesOutput, error)
}
ListLimitsProfilesAPIClient is a client that implements the ListLimitsProfiles operation.
type ListLimitsProfilesInput ¶ added in v1.124.0
type ListLimitsProfilesInput struct {
// The ID of the Amazon Web Services account that contains the limits profiles.
//
// This member is required.
AccountId *string
// The maximum number of results to return in a single call. If you don't specify
// a value, the service uses the default maximum.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// An optional filter that limits the results to profiles that contain the
// specified resource type. If you don't specify a value, the operation returns all
// profiles.
ResourceType types.ResourceType
// contains filtered or unexported fields
}
func (*ListLimitsProfilesInput) Serialize ¶ added in v1.131.0
func (v *ListLimitsProfilesInput) Serialize(s smithy.ShapeSerializer)
func (*ListLimitsProfilesInput) SerializeMembers ¶ added in v1.131.0
func (v *ListLimitsProfilesInput) SerializeMembers(s smithy.ShapeSerializer)
type ListLimitsProfilesOutput ¶ added in v1.124.0
type ListLimitsProfilesOutput struct {
// A list of limits profiles.
//
// This member is required.
Profiles []types.LimitsProfile
// The token for the next set of results, or null if there are no more results.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListLimitsProfilesOutput) Deserialize ¶ added in v1.131.0
func (v *ListLimitsProfilesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListLimitsProfilesOutput) Serialize ¶ added in v1.131.0
func (v *ListLimitsProfilesOutput) Serialize(s smithy.ShapeSerializer)
func (*ListLimitsProfilesOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListLimitsProfilesOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListLimitsProfilesPaginator ¶ added in v1.124.0
type ListLimitsProfilesPaginator struct {
// contains filtered or unexported fields
}
ListLimitsProfilesPaginator is a paginator for ListLimitsProfiles
func NewListLimitsProfilesPaginator ¶ added in v1.124.0
func NewListLimitsProfilesPaginator(client ListLimitsProfilesAPIClient, params *ListLimitsProfilesInput, optFns ...func(*ListLimitsProfilesPaginatorOptions)) *ListLimitsProfilesPaginator
NewListLimitsProfilesPaginator returns a new ListLimitsProfilesPaginator
func (*ListLimitsProfilesPaginator) HasMorePages ¶ added in v1.124.0
func (p *ListLimitsProfilesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListLimitsProfilesPaginator) NextPage ¶ added in v1.124.0
func (p *ListLimitsProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLimitsProfilesOutput, error)
NextPage retrieves the next ListLimitsProfiles page.
type ListLimitsProfilesPaginatorOptions ¶ added in v1.124.0
type ListLimitsProfilesPaginatorOptions struct {
// The maximum number of results to return in a single call. If you don't specify
// a value, the service uses the default maximum.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListLimitsProfilesPaginatorOptions is the paginator options for ListLimitsProfiles
type ListNamespacesAPIClient ¶ added in v0.30.0
type ListNamespacesAPIClient interface {
ListNamespaces(context.Context, *ListNamespacesInput, ...func(*Options)) (*ListNamespacesOutput, error)
}
ListNamespacesAPIClient is a client that implements the ListNamespaces operation.
type ListNamespacesInput ¶
type ListNamespacesInput struct {
// The ID for the Amazon Web Services account that contains the Quick Sight
// namespaces that you want to list.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to return.
MaxResults *int32
// 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.
NextToken *string
// contains filtered or unexported fields
}
func (*ListNamespacesInput) Serialize ¶ added in v1.131.0
func (v *ListNamespacesInput) Serialize(s smithy.ShapeSerializer)
func (*ListNamespacesInput) SerializeMembers ¶ added in v1.131.0
func (v *ListNamespacesInput) SerializeMembers(s smithy.ShapeSerializer)
type ListNamespacesOutput ¶
type ListNamespacesOutput struct {
// 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.
Namespaces []types.NamespaceInfoV2
// 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.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListNamespacesOutput) Deserialize ¶ added in v1.131.0
func (v *ListNamespacesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListNamespacesOutput) Serialize ¶ added in v1.131.0
func (v *ListNamespacesOutput) Serialize(s smithy.ShapeSerializer)
func (*ListNamespacesOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListNamespacesOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListNamespacesPaginator ¶ added in v0.30.0
type ListNamespacesPaginator struct {
// contains filtered or unexported fields
}
ListNamespacesPaginator is a paginator for ListNamespaces
func NewListNamespacesPaginator ¶ added in v0.30.0
func NewListNamespacesPaginator(client ListNamespacesAPIClient, params *ListNamespacesInput, optFns ...func(*ListNamespacesPaginatorOptions)) *ListNamespacesPaginator
NewListNamespacesPaginator returns a new ListNamespacesPaginator
func (*ListNamespacesPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListNamespacesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListNamespacesPaginator) NextPage ¶ added in v0.30.0
func (p *ListNamespacesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListNamespacesOutput, error)
NextPage retrieves the next ListNamespaces page.
type ListNamespacesPaginatorOptions ¶ added in v0.30.0
type ListNamespacesPaginatorOptions struct {
// The maximum number of results to return.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListNamespacesPaginatorOptions is the paginator options for ListNamespaces
type ListOAuthClientApplicationsAPIClient ¶ added in v1.112.0
type ListOAuthClientApplicationsAPIClient interface {
ListOAuthClientApplications(context.Context, *ListOAuthClientApplicationsInput, ...func(*Options)) (*ListOAuthClientApplicationsOutput, error)
}
ListOAuthClientApplicationsAPIClient is a client that implements the ListOAuthClientApplications operation.
type ListOAuthClientApplicationsInput ¶ added in v1.112.0
type ListOAuthClientApplicationsInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to return.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
// contains filtered or unexported fields
}
func (*ListOAuthClientApplicationsInput) Serialize ¶ added in v1.131.0
func (v *ListOAuthClientApplicationsInput) Serialize(s smithy.ShapeSerializer)
func (*ListOAuthClientApplicationsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListOAuthClientApplicationsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListOAuthClientApplicationsOutput ¶ added in v1.112.0
type ListOAuthClientApplicationsOutput struct {
// A pagination token that can be used in a subsequent request.
NextToken *string
// A list of OAuthClientApplication summaries.
OAuthClientApplications []types.OAuthClientApplicationSummary
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListOAuthClientApplicationsOutput) Deserialize ¶ added in v1.131.0
func (v *ListOAuthClientApplicationsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListOAuthClientApplicationsOutput) Serialize ¶ added in v1.131.0
func (v *ListOAuthClientApplicationsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListOAuthClientApplicationsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListOAuthClientApplicationsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListOAuthClientApplicationsPaginator ¶ added in v1.112.0
type ListOAuthClientApplicationsPaginator struct {
// contains filtered or unexported fields
}
ListOAuthClientApplicationsPaginator is a paginator for ListOAuthClientApplications
func NewListOAuthClientApplicationsPaginator ¶ added in v1.112.0
func NewListOAuthClientApplicationsPaginator(client ListOAuthClientApplicationsAPIClient, params *ListOAuthClientApplicationsInput, optFns ...func(*ListOAuthClientApplicationsPaginatorOptions)) *ListOAuthClientApplicationsPaginator
NewListOAuthClientApplicationsPaginator returns a new ListOAuthClientApplicationsPaginator
func (*ListOAuthClientApplicationsPaginator) HasMorePages ¶ added in v1.112.0
func (p *ListOAuthClientApplicationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListOAuthClientApplicationsPaginator) NextPage ¶ added in v1.112.0
func (p *ListOAuthClientApplicationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListOAuthClientApplicationsOutput, error)
NextPage retrieves the next ListOAuthClientApplications page.
type ListOAuthClientApplicationsPaginatorOptions ¶ added in v1.112.0
type ListOAuthClientApplicationsPaginatorOptions struct {
// The maximum number of results to return.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListOAuthClientApplicationsPaginatorOptions is the paginator options for ListOAuthClientApplications
type ListRefreshSchedulesInput ¶ added in v1.34.0
type ListRefreshSchedulesInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset.
//
// This member is required.
DataSetId *string
// contains filtered or unexported fields
}
func (*ListRefreshSchedulesInput) Serialize ¶ added in v1.131.0
func (v *ListRefreshSchedulesInput) Serialize(s smithy.ShapeSerializer)
func (*ListRefreshSchedulesInput) SerializeMembers ¶ added in v1.131.0
func (v *ListRefreshSchedulesInput) SerializeMembers(s smithy.ShapeSerializer)
type ListRefreshSchedulesOutput ¶ added in v1.34.0
type ListRefreshSchedulesOutput struct {
// The list of refresh schedules for the dataset.
RefreshSchedules []types.RefreshSchedule
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListRefreshSchedulesOutput) Deserialize ¶ added in v1.131.0
func (v *ListRefreshSchedulesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListRefreshSchedulesOutput) Serialize ¶ added in v1.131.0
func (v *ListRefreshSchedulesOutput) Serialize(s smithy.ShapeSerializer)
func (*ListRefreshSchedulesOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListRefreshSchedulesOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListRoleMembershipsAPIClient ¶ added in v1.51.0
type ListRoleMembershipsAPIClient interface {
ListRoleMemberships(context.Context, *ListRoleMembershipsInput, ...func(*Options)) (*ListRoleMembershipsOutput, error)
}
ListRoleMembershipsAPIClient is a client that implements the ListRoleMemberships operation.
type ListRoleMembershipsInput ¶ added in v1.51.0
type ListRoleMembershipsInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The namespace that includes the role.
//
// This member is required.
Namespace *string
// The name of the role.
//
// This member is required.
Role types.Role
// The maximum number of results to return.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
// contains filtered or unexported fields
}
func (*ListRoleMembershipsInput) Serialize ¶ added in v1.131.0
func (v *ListRoleMembershipsInput) Serialize(s smithy.ShapeSerializer)
func (*ListRoleMembershipsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListRoleMembershipsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListRoleMembershipsOutput ¶ added in v1.51.0
type ListRoleMembershipsOutput struct {
// The list of groups associated with a role
MembersList []string
// A pagination token that can be used in a subsequent request.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListRoleMembershipsOutput) Deserialize ¶ added in v1.131.0
func (v *ListRoleMembershipsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListRoleMembershipsOutput) Serialize ¶ added in v1.131.0
func (v *ListRoleMembershipsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListRoleMembershipsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListRoleMembershipsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListRoleMembershipsPaginator ¶ added in v1.51.0
type ListRoleMembershipsPaginator struct {
// contains filtered or unexported fields
}
ListRoleMembershipsPaginator is a paginator for ListRoleMemberships
func NewListRoleMembershipsPaginator ¶ added in v1.51.0
func NewListRoleMembershipsPaginator(client ListRoleMembershipsAPIClient, params *ListRoleMembershipsInput, optFns ...func(*ListRoleMembershipsPaginatorOptions)) *ListRoleMembershipsPaginator
NewListRoleMembershipsPaginator returns a new ListRoleMembershipsPaginator
func (*ListRoleMembershipsPaginator) HasMorePages ¶ added in v1.51.0
func (p *ListRoleMembershipsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListRoleMembershipsPaginator) NextPage ¶ added in v1.51.0
func (p *ListRoleMembershipsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRoleMembershipsOutput, error)
NextPage retrieves the next ListRoleMemberships page.
type ListRoleMembershipsPaginatorOptions ¶ added in v1.51.0
type ListRoleMembershipsPaginatorOptions struct {
// The maximum number of results to return.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListRoleMembershipsPaginatorOptions is the paginator options for ListRoleMemberships
type ListSelfUpgradesInput ¶ added in v1.100.0
type ListSelfUpgradesInput struct {
// The ID of the Amazon Web Services account that contains the self-upgrade
// requests.
//
// This member is required.
AwsAccountId *string
// The Quick namespace for the self-upgrade requests.
//
// This member is required.
Namespace *string
// The maximum number of results to return.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListSelfUpgradesInput) Serialize ¶ added in v1.131.0
func (v *ListSelfUpgradesInput) Serialize(s smithy.ShapeSerializer)
func (*ListSelfUpgradesInput) SerializeMembers ¶ added in v1.131.0
func (v *ListSelfUpgradesInput) SerializeMembers(s smithy.ShapeSerializer)
type ListSelfUpgradesOutput ¶ added in v1.100.0
type ListSelfUpgradesOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// A list of self-upgrade request details.
SelfUpgradeRequestDetails []types.SelfUpgradeRequestDetail
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListSelfUpgradesOutput) Deserialize ¶ added in v1.131.0
func (v *ListSelfUpgradesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListSelfUpgradesOutput) Serialize ¶ added in v1.131.0
func (v *ListSelfUpgradesOutput) Serialize(s smithy.ShapeSerializer)
func (*ListSelfUpgradesOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListSelfUpgradesOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListSpaceResourcesInput ¶ added in v1.113.0
type ListSpaceResourcesInput struct {
// The ID of the Amazon Web Services account that contains the space.
//
// This member is required.
AwsAccountId *string
// The ID of the space that you want to list resources for.
//
// This member is required.
SpaceId *string
// contains filtered or unexported fields
}
func (*ListSpaceResourcesInput) Serialize ¶ added in v1.131.0
func (v *ListSpaceResourcesInput) Serialize(s smithy.ShapeSerializer)
func (*ListSpaceResourcesInput) SerializeMembers ¶ added in v1.131.0
func (v *ListSpaceResourcesInput) SerializeMembers(s smithy.ShapeSerializer)
type ListSpaceResourcesOutput ¶ added in v1.113.0
type ListSpaceResourcesOutput struct {
// The ID of the space.
//
// This member is required.
SpaceId *string
// A list of resource summaries in the space.
//
// This member is required.
SpaceResources []types.SpaceResourceSummary
// The Amazon Web Services request ID for this operation.
RequestId *string
// The ARN of the space.
SpaceArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListSpaceResourcesOutput) Deserialize ¶ added in v1.131.0
func (v *ListSpaceResourcesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListSpaceResourcesOutput) Serialize ¶ added in v1.131.0
func (v *ListSpaceResourcesOutput) Serialize(s smithy.ShapeSerializer)
func (*ListSpaceResourcesOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListSpaceResourcesOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListSpacesInput ¶ added in v1.113.0
type ListSpacesInput struct {
// The ID of the Amazon Web Services account that contains the spaces.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to return.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListSpacesInput) Serialize ¶ added in v1.131.0
func (v *ListSpacesInput) Serialize(s smithy.ShapeSerializer)
func (*ListSpacesInput) SerializeMembers ¶ added in v1.131.0
func (v *ListSpacesInput) SerializeMembers(s smithy.ShapeSerializer)
type ListSpacesOutput ¶ added in v1.113.0
type ListSpacesOutput struct {
// The ID of the space.
//
// This member is required.
SpaceId *string
// A list of space summaries.
//
// This member is required.
SpaceSummaries []types.SpaceSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The ARN of the space.
SpaceArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListSpacesOutput) Deserialize ¶ added in v1.131.0
func (v *ListSpacesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListSpacesOutput) Serialize ¶ added in v1.131.0
func (v *ListSpacesOutput) Serialize(s smithy.ShapeSerializer)
func (*ListSpacesOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListSpacesOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct {
// The Amazon Resource Name (ARN) of the resource that you want a list of tags for.
//
// This member is required.
ResourceArn *string
// contains filtered or unexported fields
}
func (*ListTagsForResourceInput) Serialize ¶ added in v1.131.0
func (v *ListTagsForResourceInput) Serialize(s smithy.ShapeSerializer)
func (*ListTagsForResourceInput) SerializeMembers ¶ added in v1.131.0
func (v *ListTagsForResourceInput) SerializeMembers(s smithy.ShapeSerializer)
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Contains a map of the key-value pairs for the resource tag or tags assigned to
// the resource.
Tags []types.Tag
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListTagsForResourceOutput) Deserialize ¶ added in v1.131.0
func (v *ListTagsForResourceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListTagsForResourceOutput) Serialize ¶ added in v1.131.0
func (v *ListTagsForResourceOutput) Serialize(s smithy.ShapeSerializer)
func (*ListTagsForResourceOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListTagsForResourceOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListTemplateAliasesAPIClient ¶ added in v0.30.0
type ListTemplateAliasesAPIClient interface {
ListTemplateAliases(context.Context, *ListTemplateAliasesInput, ...func(*Options)) (*ListTemplateAliasesOutput, error)
}
ListTemplateAliasesAPIClient is a client that implements the ListTemplateAliases operation.
type ListTemplateAliasesInput ¶
type ListTemplateAliasesInput struct {
// The ID of the Amazon Web Services account that contains the template aliases
// that you're listing.
//
// This member is required.
AwsAccountId *string
// The ID for the template.
//
// This member is required.
TemplateId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListTemplateAliasesInput) Serialize ¶ added in v1.131.0
func (v *ListTemplateAliasesInput) Serialize(s smithy.ShapeSerializer)
func (*ListTemplateAliasesInput) SerializeMembers ¶ added in v1.131.0
func (v *ListTemplateAliasesInput) SerializeMembers(s smithy.ShapeSerializer)
type ListTemplateAliasesOutput ¶
type ListTemplateAliasesOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A structure containing the list of the template's aliases.
TemplateAliasList []types.TemplateAlias
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListTemplateAliasesOutput) Deserialize ¶ added in v1.131.0
func (v *ListTemplateAliasesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListTemplateAliasesOutput) Serialize ¶ added in v1.131.0
func (v *ListTemplateAliasesOutput) Serialize(s smithy.ShapeSerializer)
func (*ListTemplateAliasesOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListTemplateAliasesOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListTemplateAliasesPaginator ¶ added in v0.30.0
type ListTemplateAliasesPaginator struct {
// contains filtered or unexported fields
}
ListTemplateAliasesPaginator is a paginator for ListTemplateAliases
func NewListTemplateAliasesPaginator ¶ added in v0.30.0
func NewListTemplateAliasesPaginator(client ListTemplateAliasesAPIClient, params *ListTemplateAliasesInput, optFns ...func(*ListTemplateAliasesPaginatorOptions)) *ListTemplateAliasesPaginator
NewListTemplateAliasesPaginator returns a new ListTemplateAliasesPaginator
func (*ListTemplateAliasesPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListTemplateAliasesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTemplateAliasesPaginator) NextPage ¶ added in v0.30.0
func (p *ListTemplateAliasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTemplateAliasesOutput, error)
NextPage retrieves the next ListTemplateAliases page.
type ListTemplateAliasesPaginatorOptions ¶ added in v0.30.0
type ListTemplateAliasesPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListTemplateAliasesPaginatorOptions is the paginator options for ListTemplateAliases
type ListTemplateVersionsAPIClient ¶ added in v0.30.0
type ListTemplateVersionsAPIClient interface {
ListTemplateVersions(context.Context, *ListTemplateVersionsInput, ...func(*Options)) (*ListTemplateVersionsOutput, error)
}
ListTemplateVersionsAPIClient is a client that implements the ListTemplateVersions operation.
type ListTemplateVersionsInput ¶
type ListTemplateVersionsInput struct {
// The ID of the Amazon Web Services account that contains the templates that
// you're listing.
//
// This member is required.
AwsAccountId *string
// The ID for the template.
//
// This member is required.
TemplateId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListTemplateVersionsInput) Serialize ¶ added in v1.131.0
func (v *ListTemplateVersionsInput) Serialize(s smithy.ShapeSerializer)
func (*ListTemplateVersionsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListTemplateVersionsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListTemplateVersionsOutput ¶
type ListTemplateVersionsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A structure containing a list of all the versions of the specified template.
TemplateVersionSummaryList []types.TemplateVersionSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListTemplateVersionsOutput) Deserialize ¶ added in v1.131.0
func (v *ListTemplateVersionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListTemplateVersionsOutput) Serialize ¶ added in v1.131.0
func (v *ListTemplateVersionsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListTemplateVersionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListTemplateVersionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListTemplateVersionsPaginator ¶ added in v0.30.0
type ListTemplateVersionsPaginator struct {
// contains filtered or unexported fields
}
ListTemplateVersionsPaginator is a paginator for ListTemplateVersions
func NewListTemplateVersionsPaginator ¶ added in v0.30.0
func NewListTemplateVersionsPaginator(client ListTemplateVersionsAPIClient, params *ListTemplateVersionsInput, optFns ...func(*ListTemplateVersionsPaginatorOptions)) *ListTemplateVersionsPaginator
NewListTemplateVersionsPaginator returns a new ListTemplateVersionsPaginator
func (*ListTemplateVersionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListTemplateVersionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTemplateVersionsPaginator) NextPage ¶ added in v0.30.0
func (p *ListTemplateVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTemplateVersionsOutput, error)
NextPage retrieves the next ListTemplateVersions page.
type ListTemplateVersionsPaginatorOptions ¶ added in v0.30.0
type ListTemplateVersionsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListTemplateVersionsPaginatorOptions is the paginator options for ListTemplateVersions
type ListTemplatesAPIClient ¶ added in v0.30.0
type ListTemplatesAPIClient interface {
ListTemplates(context.Context, *ListTemplatesInput, ...func(*Options)) (*ListTemplatesOutput, error)
}
ListTemplatesAPIClient is a client that implements the ListTemplates operation.
type ListTemplatesInput ¶
type ListTemplatesInput struct {
// The ID of the Amazon Web Services account that contains the templates that
// you're listing.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListTemplatesInput) Serialize ¶ added in v1.131.0
func (v *ListTemplatesInput) Serialize(s smithy.ShapeSerializer)
func (*ListTemplatesInput) SerializeMembers ¶ added in v1.131.0
func (v *ListTemplatesInput) SerializeMembers(s smithy.ShapeSerializer)
type ListTemplatesOutput ¶
type ListTemplatesOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A structure containing information about the templates in the list.
TemplateSummaryList []types.TemplateSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListTemplatesOutput) Deserialize ¶ added in v1.131.0
func (v *ListTemplatesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListTemplatesOutput) Serialize ¶ added in v1.131.0
func (v *ListTemplatesOutput) Serialize(s smithy.ShapeSerializer)
func (*ListTemplatesOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListTemplatesOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListTemplatesPaginator ¶ added in v0.30.0
type ListTemplatesPaginator struct {
// contains filtered or unexported fields
}
ListTemplatesPaginator is a paginator for ListTemplates
func NewListTemplatesPaginator ¶ added in v0.30.0
func NewListTemplatesPaginator(client ListTemplatesAPIClient, params *ListTemplatesInput, optFns ...func(*ListTemplatesPaginatorOptions)) *ListTemplatesPaginator
NewListTemplatesPaginator returns a new ListTemplatesPaginator
func (*ListTemplatesPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListTemplatesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTemplatesPaginator) NextPage ¶ added in v0.30.0
func (p *ListTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTemplatesOutput, error)
NextPage retrieves the next ListTemplates page.
type ListTemplatesPaginatorOptions ¶ added in v0.30.0
type ListTemplatesPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListTemplatesPaginatorOptions is the paginator options for ListTemplates
type ListThemeAliasesInput ¶
type ListThemeAliasesInput struct {
// The ID of the Amazon Web Services account that contains the theme aliases that
// you're listing.
//
// This member is required.
AwsAccountId *string
// The ID for the theme.
//
// This member is required.
ThemeId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListThemeAliasesInput) Serialize ¶ added in v1.131.0
func (v *ListThemeAliasesInput) Serialize(s smithy.ShapeSerializer)
func (*ListThemeAliasesInput) SerializeMembers ¶ added in v1.131.0
func (v *ListThemeAliasesInput) SerializeMembers(s smithy.ShapeSerializer)
type ListThemeAliasesOutput ¶
type ListThemeAliasesOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A structure containing the list of the theme's aliases.
ThemeAliasList []types.ThemeAlias
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListThemeAliasesOutput) Deserialize ¶ added in v1.131.0
func (v *ListThemeAliasesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListThemeAliasesOutput) Serialize ¶ added in v1.131.0
func (v *ListThemeAliasesOutput) Serialize(s smithy.ShapeSerializer)
func (*ListThemeAliasesOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListThemeAliasesOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListThemeVersionsAPIClient ¶ added in v1.2.0
type ListThemeVersionsAPIClient interface {
ListThemeVersions(context.Context, *ListThemeVersionsInput, ...func(*Options)) (*ListThemeVersionsOutput, error)
}
ListThemeVersionsAPIClient is a client that implements the ListThemeVersions operation.
type ListThemeVersionsInput ¶
type ListThemeVersionsInput struct {
// The ID of the Amazon Web Services account that contains the themes that you're
// listing.
//
// This member is required.
AwsAccountId *string
// The ID for the theme.
//
// This member is required.
ThemeId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListThemeVersionsInput) Serialize ¶ added in v1.131.0
func (v *ListThemeVersionsInput) Serialize(s smithy.ShapeSerializer)
func (*ListThemeVersionsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListThemeVersionsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListThemeVersionsOutput ¶
type ListThemeVersionsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A structure containing a list of all the versions of the specified theme.
ThemeVersionSummaryList []types.ThemeVersionSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListThemeVersionsOutput) Deserialize ¶ added in v1.131.0
func (v *ListThemeVersionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListThemeVersionsOutput) Serialize ¶ added in v1.131.0
func (v *ListThemeVersionsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListThemeVersionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListThemeVersionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListThemeVersionsPaginator ¶ added in v1.2.0
type ListThemeVersionsPaginator struct {
// contains filtered or unexported fields
}
ListThemeVersionsPaginator is a paginator for ListThemeVersions
func NewListThemeVersionsPaginator ¶ added in v1.2.0
func NewListThemeVersionsPaginator(client ListThemeVersionsAPIClient, params *ListThemeVersionsInput, optFns ...func(*ListThemeVersionsPaginatorOptions)) *ListThemeVersionsPaginator
NewListThemeVersionsPaginator returns a new ListThemeVersionsPaginator
func (*ListThemeVersionsPaginator) HasMorePages ¶ added in v1.2.0
func (p *ListThemeVersionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListThemeVersionsPaginator) NextPage ¶ added in v1.2.0
func (p *ListThemeVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThemeVersionsOutput, error)
NextPage retrieves the next ListThemeVersions page.
type ListThemeVersionsPaginatorOptions ¶ added in v1.2.0
type ListThemeVersionsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListThemeVersionsPaginatorOptions is the paginator options for ListThemeVersions
type ListThemesAPIClient ¶ added in v1.2.0
type ListThemesAPIClient interface {
ListThemes(context.Context, *ListThemesInput, ...func(*Options)) (*ListThemesOutput, error)
}
ListThemesAPIClient is a client that implements the ListThemes operation.
type ListThemesInput ¶
type ListThemesInput struct {
// The ID of the Amazon Web Services account that contains the themes that you're
// listing.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// 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.
Type types.ThemeType
// contains filtered or unexported fields
}
func (*ListThemesInput) Serialize ¶ added in v1.131.0
func (v *ListThemesInput) Serialize(s smithy.ShapeSerializer)
func (*ListThemesInput) SerializeMembers ¶ added in v1.131.0
func (v *ListThemesInput) SerializeMembers(s smithy.ShapeSerializer)
type ListThemesOutput ¶
type ListThemesOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Information about the themes in the list.
ThemeSummaryList []types.ThemeSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListThemesOutput) Deserialize ¶ added in v1.131.0
func (v *ListThemesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListThemesOutput) Serialize ¶ added in v1.131.0
func (v *ListThemesOutput) Serialize(s smithy.ShapeSerializer)
func (*ListThemesOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListThemesOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListThemesPaginator ¶ added in v1.2.0
type ListThemesPaginator struct {
// contains filtered or unexported fields
}
ListThemesPaginator is a paginator for ListThemes
func NewListThemesPaginator ¶ added in v1.2.0
func NewListThemesPaginator(client ListThemesAPIClient, params *ListThemesInput, optFns ...func(*ListThemesPaginatorOptions)) *ListThemesPaginator
NewListThemesPaginator returns a new ListThemesPaginator
func (*ListThemesPaginator) HasMorePages ¶ added in v1.2.0
func (p *ListThemesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListThemesPaginator) NextPage ¶ added in v1.2.0
func (p *ListThemesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThemesOutput, error)
NextPage retrieves the next ListThemes page.
type ListThemesPaginatorOptions ¶ added in v1.2.0
type ListThemesPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListThemesPaginatorOptions is the paginator options for ListThemes
type ListTopicRefreshSchedulesInput ¶ added in v1.35.0
type ListTopicRefreshSchedulesInput struct {
// The ID of the Amazon Web Services account that contains the topic whose refresh
// schedule you want described.
//
// This member is required.
AwsAccountId *string
// 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.
//
// This member is required.
TopicId *string
// contains filtered or unexported fields
}
func (*ListTopicRefreshSchedulesInput) Serialize ¶ added in v1.131.0
func (v *ListTopicRefreshSchedulesInput) Serialize(s smithy.ShapeSerializer)
func (*ListTopicRefreshSchedulesInput) SerializeMembers ¶ added in v1.131.0
func (v *ListTopicRefreshSchedulesInput) SerializeMembers(s smithy.ShapeSerializer)
type ListTopicRefreshSchedulesOutput ¶ added in v1.35.0
type ListTopicRefreshSchedulesOutput struct {
// The list of topic refresh schedules.
RefreshSchedules []types.TopicRefreshScheduleSummary
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the topic.
TopicArn *string
// 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.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListTopicRefreshSchedulesOutput) Deserialize ¶ added in v1.131.0
func (v *ListTopicRefreshSchedulesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListTopicRefreshSchedulesOutput) Serialize ¶ added in v1.131.0
func (v *ListTopicRefreshSchedulesOutput) Serialize(s smithy.ShapeSerializer)
func (*ListTopicRefreshSchedulesOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListTopicRefreshSchedulesOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListTopicReviewedAnswersInput ¶ added in v1.68.0
type ListTopicReviewedAnswersInput struct {
// The ID of the Amazon Web Services account that containd the reviewed answers
// that you want listed.
//
// This member is required.
AwsAccountId *string
// 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.
//
// This member is required.
TopicId *string
// contains filtered or unexported fields
}
func (*ListTopicReviewedAnswersInput) Serialize ¶ added in v1.131.0
func (v *ListTopicReviewedAnswersInput) Serialize(s smithy.ShapeSerializer)
func (*ListTopicReviewedAnswersInput) SerializeMembers ¶ added in v1.131.0
func (v *ListTopicReviewedAnswersInput) SerializeMembers(s smithy.ShapeSerializer)
type ListTopicReviewedAnswersOutput ¶ added in v1.68.0
type ListTopicReviewedAnswersOutput struct {
// The definition of all Answers in the topic.
Answers []types.TopicReviewedAnswer
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the topic.
TopicArn *string
// 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.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListTopicReviewedAnswersOutput) Deserialize ¶ added in v1.131.0
func (v *ListTopicReviewedAnswersOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListTopicReviewedAnswersOutput) Serialize ¶ added in v1.131.0
func (v *ListTopicReviewedAnswersOutput) Serialize(s smithy.ShapeSerializer)
func (*ListTopicReviewedAnswersOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListTopicReviewedAnswersOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListTopicsAPIClient ¶ added in v1.35.0
type ListTopicsAPIClient interface {
ListTopics(context.Context, *ListTopicsInput, ...func(*Options)) (*ListTopicsOutput, error)
}
ListTopicsAPIClient is a client that implements the ListTopics operation.
type ListTopicsInput ¶ added in v1.35.0
type ListTopicsInput struct {
// The ID of the Amazon Web Services account that contains the topics that you
// want to list.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListTopicsInput) Serialize ¶ added in v1.131.0
func (v *ListTopicsInput) Serialize(s smithy.ShapeSerializer)
func (*ListTopicsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListTopicsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListTopicsOutput ¶ added in v1.35.0
type ListTopicsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A list of topic summaries.
TopicsSummaries []types.TopicSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListTopicsOutput) Deserialize ¶ added in v1.131.0
func (v *ListTopicsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListTopicsOutput) Serialize ¶ added in v1.131.0
func (v *ListTopicsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListTopicsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListTopicsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListTopicsPaginator ¶ added in v1.35.0
type ListTopicsPaginator struct {
// contains filtered or unexported fields
}
ListTopicsPaginator is a paginator for ListTopics
func NewListTopicsPaginator ¶ added in v1.35.0
func NewListTopicsPaginator(client ListTopicsAPIClient, params *ListTopicsInput, optFns ...func(*ListTopicsPaginatorOptions)) *ListTopicsPaginator
NewListTopicsPaginator returns a new ListTopicsPaginator
func (*ListTopicsPaginator) HasMorePages ¶ added in v1.35.0
func (p *ListTopicsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTopicsPaginator) NextPage ¶ added in v1.35.0
func (p *ListTopicsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTopicsOutput, error)
NextPage retrieves the next ListTopics page.
type ListTopicsPaginatorOptions ¶ added in v1.35.0
type ListTopicsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListTopicsPaginatorOptions is the paginator options for ListTopics
type ListTopicsV2APIClient ¶ added in v1.123.0
type ListTopicsV2APIClient interface {
ListTopicsV2(context.Context, *ListTopicsV2Input, ...func(*Options)) (*ListTopicsV2Output, error)
}
ListTopicsV2APIClient is a client that implements the ListTopicsV2 operation.
type ListTopicsV2Input ¶ added in v1.123.0
type ListTopicsV2Input struct {
// The ID of the Amazon Web Services account that contains the topics that you
// want to list.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListTopicsV2Input) Serialize ¶ added in v1.131.0
func (v *ListTopicsV2Input) Serialize(s smithy.ShapeSerializer)
func (*ListTopicsV2Input) SerializeMembers ¶ added in v1.131.0
func (v *ListTopicsV2Input) SerializeMembers(s smithy.ShapeSerializer)
type ListTopicsV2Output ¶ added in v1.123.0
type ListTopicsV2Output struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A list of topic summaries.
TopicSummaryList []types.TopicV2Summary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListTopicsV2Output) Deserialize ¶ added in v1.131.0
func (v *ListTopicsV2Output) Deserialize(d smithy.ShapeDeserializer) error
func (*ListTopicsV2Output) Serialize ¶ added in v1.131.0
func (v *ListTopicsV2Output) Serialize(s smithy.ShapeSerializer)
func (*ListTopicsV2Output) SerializeMembers ¶ added in v1.131.0
func (v *ListTopicsV2Output) SerializeMembers(s smithy.ShapeSerializer)
type ListTopicsV2Paginator ¶ added in v1.123.0
type ListTopicsV2Paginator struct {
// contains filtered or unexported fields
}
ListTopicsV2Paginator is a paginator for ListTopicsV2
func NewListTopicsV2Paginator ¶ added in v1.123.0
func NewListTopicsV2Paginator(client ListTopicsV2APIClient, params *ListTopicsV2Input, optFns ...func(*ListTopicsV2PaginatorOptions)) *ListTopicsV2Paginator
NewListTopicsV2Paginator returns a new ListTopicsV2Paginator
func (*ListTopicsV2Paginator) HasMorePages ¶ added in v1.123.0
func (p *ListTopicsV2Paginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTopicsV2Paginator) NextPage ¶ added in v1.123.0
func (p *ListTopicsV2Paginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTopicsV2Output, error)
NextPage retrieves the next ListTopicsV2 page.
type ListTopicsV2PaginatorOptions ¶ added in v1.123.0
type ListTopicsV2PaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListTopicsV2PaginatorOptions is the paginator options for ListTopicsV2
type ListUserGroupsAPIClient ¶ added in v1.39.0
type ListUserGroupsAPIClient interface {
ListUserGroups(context.Context, *ListUserGroupsInput, ...func(*Options)) (*ListUserGroupsOutput, error)
}
ListUserGroupsAPIClient is a client that implements the ListUserGroups operation.
type ListUserGroupsInput ¶
type ListUserGroupsInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The namespace. Currently, you should set this to default .
//
// This member is required.
Namespace *string
// The Amazon Quick Sight user name that you want to list group memberships for.
//
// This member is required.
UserName *string
// The maximum number of results to return from this request.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
// contains filtered or unexported fields
}
func (*ListUserGroupsInput) Serialize ¶ added in v1.131.0
func (v *ListUserGroupsInput) Serialize(s smithy.ShapeSerializer)
func (*ListUserGroupsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListUserGroupsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListUserGroupsOutput ¶
type ListUserGroupsOutput struct {
// The list of groups the user is a member of.
GroupList []types.Group
// A pagination token that can be used in a subsequent request.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListUserGroupsOutput) Deserialize ¶ added in v1.131.0
func (v *ListUserGroupsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListUserGroupsOutput) Serialize ¶ added in v1.131.0
func (v *ListUserGroupsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListUserGroupsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListUserGroupsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListUserGroupsPaginator ¶ added in v1.39.0
type ListUserGroupsPaginator struct {
// contains filtered or unexported fields
}
ListUserGroupsPaginator is a paginator for ListUserGroups
func NewListUserGroupsPaginator ¶ added in v1.39.0
func NewListUserGroupsPaginator(client ListUserGroupsAPIClient, params *ListUserGroupsInput, optFns ...func(*ListUserGroupsPaginatorOptions)) *ListUserGroupsPaginator
NewListUserGroupsPaginator returns a new ListUserGroupsPaginator
func (*ListUserGroupsPaginator) HasMorePages ¶ added in v1.39.0
func (p *ListUserGroupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListUserGroupsPaginator) NextPage ¶ added in v1.39.0
func (p *ListUserGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUserGroupsOutput, error)
NextPage retrieves the next ListUserGroups page.
type ListUserGroupsPaginatorOptions ¶ added in v1.39.0
type ListUserGroupsPaginatorOptions struct {
// The maximum number of results to return from this request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListUserGroupsPaginatorOptions is the paginator options for ListUserGroups
type ListUsersAPIClient ¶ added in v1.39.0
type ListUsersAPIClient interface {
ListUsers(context.Context, *ListUsersInput, ...func(*Options)) (*ListUsersOutput, error)
}
ListUsersAPIClient is a client that implements the ListUsers operation.
type ListUsersIndexCapacityInput ¶ added in v1.114.0
type ListUsersIndexCapacityInput struct {
// The ID of the Amazon Web Services account that contains the index capacity data.
//
// This member is required.
AwsAccountId *string
// Filters to apply. Only one filter is supported per request. The userNameOrEmail
// and totalCapacityBytes filters are mutually exclusive.
Filters []types.UserIndexCapacityFilter
// The maximum number of results to return per page.
MaxResults *int32
// The namespace to scope the user search to. Required when the userNameOrEmail
// filter is present.
Namespace *string
// The token for the next set of results, received from a previous call.
NextToken *string
// The field to sort results by.
SortBy types.UserIndexCapacitySortBy
// The sort order for results. Defaults to DESC if not specified.
SortOrder types.UserIndexCapacitySortOrder
// contains filtered or unexported fields
}
func (*ListUsersIndexCapacityInput) Serialize ¶ added in v1.131.0
func (v *ListUsersIndexCapacityInput) Serialize(s smithy.ShapeSerializer)
func (*ListUsersIndexCapacityInput) SerializeMembers ¶ added in v1.131.0
func (v *ListUsersIndexCapacityInput) SerializeMembers(s smithy.ShapeSerializer)
type ListUsersIndexCapacityOutput ¶ added in v1.114.0
type ListUsersIndexCapacityOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The list of users with their index capacity metrics.
Users []types.UserIndexCapacity
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListUsersIndexCapacityOutput) Deserialize ¶ added in v1.131.0
func (v *ListUsersIndexCapacityOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListUsersIndexCapacityOutput) Serialize ¶ added in v1.131.0
func (v *ListUsersIndexCapacityOutput) Serialize(s smithy.ShapeSerializer)
func (*ListUsersIndexCapacityOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListUsersIndexCapacityOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListUsersInput ¶
type ListUsersInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The namespace. Currently, you should set this to default .
//
// This member is required.
Namespace *string
// The maximum number of results to return from this request.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
// contains filtered or unexported fields
}
func (*ListUsersInput) Serialize ¶ added in v1.131.0
func (v *ListUsersInput) Serialize(s smithy.ShapeSerializer)
func (*ListUsersInput) SerializeMembers ¶ added in v1.131.0
func (v *ListUsersInput) SerializeMembers(s smithy.ShapeSerializer)
type ListUsersOutput ¶
type ListUsersOutput struct {
// A pagination token that can be used in a subsequent request.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The list of users.
UserList []types.User
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListUsersOutput) Deserialize ¶ added in v1.131.0
func (v *ListUsersOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListUsersOutput) Serialize ¶ added in v1.131.0
func (v *ListUsersOutput) Serialize(s smithy.ShapeSerializer)
func (*ListUsersOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListUsersOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListUsersPaginator ¶ added in v1.39.0
type ListUsersPaginator struct {
// contains filtered or unexported fields
}
ListUsersPaginator is a paginator for ListUsers
func NewListUsersPaginator ¶ added in v1.39.0
func NewListUsersPaginator(client ListUsersAPIClient, params *ListUsersInput, optFns ...func(*ListUsersPaginatorOptions)) *ListUsersPaginator
NewListUsersPaginator returns a new ListUsersPaginator
func (*ListUsersPaginator) HasMorePages ¶ added in v1.39.0
func (p *ListUsersPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListUsersPaginator) NextPage ¶ added in v1.39.0
func (p *ListUsersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListUsersOutput, error)
NextPage retrieves the next ListUsers page.
type ListUsersPaginatorOptions ¶ added in v1.39.0
type ListUsersPaginatorOptions struct {
// The maximum number of results to return from this request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListUsersPaginatorOptions is the paginator options for ListUsers
type ListVPCConnectionsAPIClient ¶ added in v1.35.0
type ListVPCConnectionsAPIClient interface {
ListVPCConnections(context.Context, *ListVPCConnectionsInput, ...func(*Options)) (*ListVPCConnectionsOutput, error)
}
ListVPCConnectionsAPIClient is a client that implements the ListVPCConnections operation.
type ListVPCConnectionsInput ¶ added in v1.35.0
type ListVPCConnectionsInput struct {
// The Amazon Web Services account ID of the account that contains the VPC
// connections that you want to list.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*ListVPCConnectionsInput) Serialize ¶ added in v1.131.0
func (v *ListVPCConnectionsInput) Serialize(s smithy.ShapeSerializer)
func (*ListVPCConnectionsInput) SerializeMembers ¶ added in v1.131.0
func (v *ListVPCConnectionsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListVPCConnectionsOutput ¶ added in v1.35.0
type ListVPCConnectionsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A VPCConnectionSummaries object that returns a summary of VPC connection
// objects.
VPCConnectionSummaries []types.VPCConnectionSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListVPCConnectionsOutput) Deserialize ¶ added in v1.131.0
func (v *ListVPCConnectionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListVPCConnectionsOutput) Serialize ¶ added in v1.131.0
func (v *ListVPCConnectionsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListVPCConnectionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *ListVPCConnectionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListVPCConnectionsPaginator ¶ added in v1.35.0
type ListVPCConnectionsPaginator struct {
// contains filtered or unexported fields
}
ListVPCConnectionsPaginator is a paginator for ListVPCConnections
func NewListVPCConnectionsPaginator ¶ added in v1.35.0
func NewListVPCConnectionsPaginator(client ListVPCConnectionsAPIClient, params *ListVPCConnectionsInput, optFns ...func(*ListVPCConnectionsPaginatorOptions)) *ListVPCConnectionsPaginator
NewListVPCConnectionsPaginator returns a new ListVPCConnectionsPaginator
func (*ListVPCConnectionsPaginator) HasMorePages ¶ added in v1.35.0
func (p *ListVPCConnectionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListVPCConnectionsPaginator) NextPage ¶ added in v1.35.0
func (p *ListVPCConnectionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVPCConnectionsOutput, error)
NextPage retrieves the next ListVPCConnections page.
type ListVPCConnectionsPaginatorOptions ¶ added in v1.35.0
type ListVPCConnectionsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListVPCConnectionsPaginatorOptions is the paginator options for ListVPCConnections
type Options ¶
type Options struct {
// Set of options to modify how an operation is invoked. These apply to all
// operations invoked for this client. Use functional options on operation call to
// modify this list for per operation behavior.
APIOptions []func(*middleware.Stack) error
// The optional application specific identifier appended to the User-Agent header.
AppID string
// This endpoint will be given as input to an EndpointResolverV2. It is used for
// providing a custom base endpoint that is subject to modifications by the
// processing EndpointResolverV2.
BaseEndpoint *string
// Configures the events that will be sent to the configured logger.
ClientLogMode aws.ClientLogMode
// The credentials object to use when signing requests.
Credentials aws.CredentialsProvider
// The configuration DefaultsMode that the SDK should use when constructing the
// clients initial default settings.
DefaultsMode aws.DefaultsMode
// Disables SDK clock skew correction. When set, the SDK will not adjust request
// signing timestamps to compensate for clock drift between the client and the
// service.
DisableClockSkewCorrection bool
// The endpoint options to be used when attempting to resolve an endpoint.
EndpointOptions EndpointResolverOptions
// The service endpoint resolver.
//
// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
// value for this field will likely prevent you from using any endpoint-related
// service features released after the introduction of EndpointResolverV2 and
// BaseEndpoint.
//
// To migrate an EndpointResolver implementation that uses a custom endpoint, set
// the client option BaseEndpoint instead.
EndpointResolver EndpointResolver
// Resolves the endpoint used for a particular service operation.
EndpointResolverV2 EndpointResolverV2
// Signature Version 4 (SigV4) Signer
HTTPSignerV4 HTTPSignerV4
// Provides idempotency tokens values that will be automatically populated into
// idempotent API operations.
IdempotencyTokenProvider IdempotencyTokenProvider
// The logger writer interface to write logging messages to.
Logger logging.Logger
// The client meter provider.
MeterProvider metrics.MeterProvider
// The region to send requests to. (Required)
Region string
// RetryMaxAttempts specifies the maximum number attempts an API client will call
// an operation that fails with a retryable error. A value of 0 is ignored, and
// will not be used to configure the API client created default retryer, or modify
// per operation call's retry max attempts.
//
// If specified in an operation call's functional options with a value that is
// different than the constructed client's Options, the Client's Retryer will be
// wrapped to use the operation's specific RetryMaxAttempts value.
RetryMaxAttempts int
// RetryMode specifies the retry mode the API client will be created with, if
// Retryer option is not also specified.
//
// When creating a new API Clients this member will only be used if the Retryer
// Options member is nil. This value will be ignored if Retryer is not nil.
//
// Currently does not support per operation call overrides, may in the future.
RetryMode aws.RetryMode
// Retryer guides how HTTP requests should be retried in case of recoverable
// failures. When nil the API client will use a default retryer. The kind of
// default retry created by the API client can be changed with the RetryMode
// option.
Retryer aws.Retryer
// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
// should not populate this structure programmatically, or rely on the values here
// within your applications.
RuntimeEnvironment aws.RuntimeEnvironment
// The client tracer provider.
TracerProvider tracing.TracerProvider
Protocol smithyhttp.ClientProtocol
// The HTTP client to invoke API calls with. Defaults to client's default HTTP
// implementation if nil.
HTTPClient HTTPClient
// Client registry of operation interceptors.
Interceptors smithyhttp.InterceptorRegistry
// The auth scheme resolver which determines how to authenticate for each
// operation.
AuthSchemeResolver AuthSchemeResolver
// The list of auth schemes supported by the client.
AuthSchemes []smithyhttp.AuthScheme
// Priority list of preferred auth scheme names (e.g. sigv4a).
AuthSchemePreference []string
// contains filtered or unexported fields
}
func (Options) GetIdentityResolver ¶ added in v1.50.2
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type PredictQAResultsInput ¶ added in v1.81.0
type PredictQAResultsInput struct {
// The ID of the Amazon Web Services account that the user wants to execute
// Predict QA results in.
//
// This member is required.
AwsAccountId *string
// The query text to be used to predict QA results.
//
// This member is required.
QueryText *string
// Indicates whether generated answers are included or excluded.
IncludeGeneratedAnswer types.IncludeGeneratedAnswer
// Indicates whether Q indicies are included or excluded.
IncludeQuickSightQIndex types.IncludeQuickSightQIndex
// The number of maximum topics to be considered to predict QA results.
MaxTopicsToConsider *int32
// contains filtered or unexported fields
}
func (*PredictQAResultsInput) Serialize ¶ added in v1.131.0
func (v *PredictQAResultsInput) Serialize(s smithy.ShapeSerializer)
func (*PredictQAResultsInput) SerializeMembers ¶ added in v1.131.0
func (v *PredictQAResultsInput) SerializeMembers(s smithy.ShapeSerializer)
type PredictQAResultsOutput ¶ added in v1.81.0
type PredictQAResultsOutput struct {
// Additional visual responses.
AdditionalResults []types.QAResult
// The primary visual response.
PrimaryResult *types.QAResult
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*PredictQAResultsOutput) Deserialize ¶ added in v1.131.0
func (v *PredictQAResultsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*PredictQAResultsOutput) Serialize ¶ added in v1.131.0
func (v *PredictQAResultsOutput) Serialize(s smithy.ShapeSerializer)
func (*PredictQAResultsOutput) SerializeMembers ¶ added in v1.131.0
func (v *PredictQAResultsOutput) SerializeMembers(s smithy.ShapeSerializer)
type PutDataSetRefreshPropertiesInput ¶ added in v1.34.0
type PutDataSetRefreshPropertiesInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset.
//
// This member is required.
DataSetId *string
// The dataset refresh properties.
//
// This member is required.
DataSetRefreshProperties *types.DataSetRefreshProperties
// contains filtered or unexported fields
}
func (*PutDataSetRefreshPropertiesInput) Serialize ¶ added in v1.131.0
func (v *PutDataSetRefreshPropertiesInput) Serialize(s smithy.ShapeSerializer)
func (*PutDataSetRefreshPropertiesInput) SerializeMembers ¶ added in v1.131.0
func (v *PutDataSetRefreshPropertiesInput) SerializeMembers(s smithy.ShapeSerializer)
type PutDataSetRefreshPropertiesOutput ¶ added in v1.34.0
type PutDataSetRefreshPropertiesOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*PutDataSetRefreshPropertiesOutput) Deserialize ¶ added in v1.131.0
func (v *PutDataSetRefreshPropertiesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*PutDataSetRefreshPropertiesOutput) Serialize ¶ added in v1.131.0
func (v *PutDataSetRefreshPropertiesOutput) Serialize(s smithy.ShapeSerializer)
func (*PutDataSetRefreshPropertiesOutput) SerializeMembers ¶ added in v1.131.0
func (v *PutDataSetRefreshPropertiesOutput) SerializeMembers(s smithy.ShapeSerializer)
type RegisterUserInput ¶
type RegisterUserInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The email address of the user that you want to register.
//
// This member is required.
Email *string
// The identity type that your Quick Sight account uses to manage the identity of
// users.
//
// This member is required.
IdentityType types.IdentityType
// The namespace. Currently, you should set this to default .
//
// This member is required.
Namespace *string
// 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.
//
// This member is required.
UserRole types.UserRole
// 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 .
CustomFederationProviderUrl *string
// (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.
//
// [UpdateUser]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html
CustomPermissionsName *string
// 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.
ExternalLoginFederationProviderType *string
// The identity ID for a user in the external login provider.
ExternalLoginId *string
// The ARN of the IAM user or role that you are registering with Amazon Quick
// Sight.
IamArn *string
// 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]
// assume-role in the CLI Reference.
//
// [assume-role]: https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html
SessionName *string
// The tags to associate with the user.
Tags []types.Tag
// The Amazon Quick Sight user name that you want to create for the user you are
// registering.
UserName *string
// contains filtered or unexported fields
}
func (*RegisterUserInput) Serialize ¶ added in v1.131.0
func (v *RegisterUserInput) Serialize(s smithy.ShapeSerializer)
func (*RegisterUserInput) SerializeMembers ¶ added in v1.131.0
func (v *RegisterUserInput) SerializeMembers(s smithy.ShapeSerializer)
type RegisterUserOutput ¶
type RegisterUserOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The user's user name.
User *types.User
// The URL the user visits to complete registration and provide a password. This
// is returned only for users with an identity type of QUICKSIGHT .
UserInvitationUrl *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*RegisterUserOutput) Deserialize ¶ added in v1.131.0
func (v *RegisterUserOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*RegisterUserOutput) Serialize ¶ added in v1.131.0
func (v *RegisterUserOutput) Serialize(s smithy.ShapeSerializer)
func (*RegisterUserOutput) SerializeMembers ¶ added in v1.131.0
func (v *RegisterUserOutput) SerializeMembers(s smithy.ShapeSerializer)
type ResolveEndpoint ¶
type ResolveEndpoint struct {
Resolver EndpointResolver
Options EndpointResolverOptions
}
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type RestoreAnalysisInput ¶ added in v0.29.0
type RestoreAnalysisInput struct {
// The ID of the analysis that you're restoring.
//
// This member is required.
AnalysisId *string
// The ID of the Amazon Web Services account that contains the analysis.
//
// This member is required.
AwsAccountId *string
// 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 .
RestoreToFolders bool
// contains filtered or unexported fields
}
func (*RestoreAnalysisInput) Serialize ¶ added in v1.131.0
func (v *RestoreAnalysisInput) Serialize(s smithy.ShapeSerializer)
func (*RestoreAnalysisInput) SerializeMembers ¶ added in v1.131.0
func (v *RestoreAnalysisInput) SerializeMembers(s smithy.ShapeSerializer)
type RestoreAnalysisOutput ¶ added in v0.29.0
type RestoreAnalysisOutput struct {
// The ID of the analysis that you're restoring.
AnalysisId *string
// The Amazon Resource Name (ARN) of the analysis that you're restoring.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// A list of folder arns thatthe analysis failed to be restored to.
RestorationFailedFolderArns []string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*RestoreAnalysisOutput) Deserialize ¶ added in v1.131.0
func (v *RestoreAnalysisOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*RestoreAnalysisOutput) Serialize ¶ added in v1.131.0
func (v *RestoreAnalysisOutput) Serialize(s smithy.ShapeSerializer)
func (*RestoreAnalysisOutput) SerializeMembers ¶ added in v1.131.0
func (v *RestoreAnalysisOutput) SerializeMembers(s smithy.ShapeSerializer)
type SearchActionConnectorsAPIClient ¶ added in v1.95.0
type SearchActionConnectorsAPIClient interface {
SearchActionConnectors(context.Context, *SearchActionConnectorsInput, ...func(*Options)) (*SearchActionConnectorsOutput, error)
}
SearchActionConnectorsAPIClient is a client that implements the SearchActionConnectors operation.
type SearchActionConnectorsInput ¶ added in v1.95.0
type SearchActionConnectorsInput struct {
// The Amazon Web Services account ID in which to search for action connectors.
//
// This member is required.
AwsAccountId *string
// The search filters to apply. You can filter by connector name, type, or user
// permissions. Maximum of one filter is supported.
//
// This member is required.
Filters []types.ActionConnectorSearchFilter
// The maximum number of action connectors to return in a single response. Valid
// range is 1 to 100.
MaxResults int32
// A pagination token to retrieve the next set of results. Use the token returned
// from a previous call to continue searching.
NextToken *string
// contains filtered or unexported fields
}
func (*SearchActionConnectorsInput) Serialize ¶ added in v1.131.0
func (v *SearchActionConnectorsInput) Serialize(s smithy.ShapeSerializer)
func (*SearchActionConnectorsInput) SerializeMembers ¶ added in v1.131.0
func (v *SearchActionConnectorsInput) SerializeMembers(s smithy.ShapeSerializer)
type SearchActionConnectorsOutput ¶ added in v1.95.0
type SearchActionConnectorsOutput struct {
// A list of action connector summaries that match the search criteria.
ActionConnectorSummaries []types.ActionConnectorSummary
// A pagination token to retrieve the next set of results. If null, there are no
// more results to retrieve.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status code of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SearchActionConnectorsOutput) Deserialize ¶ added in v1.131.0
func (v *SearchActionConnectorsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*SearchActionConnectorsOutput) Serialize ¶ added in v1.131.0
func (v *SearchActionConnectorsOutput) Serialize(s smithy.ShapeSerializer)
func (*SearchActionConnectorsOutput) SerializeMembers ¶ added in v1.131.0
func (v *SearchActionConnectorsOutput) SerializeMembers(s smithy.ShapeSerializer)
type SearchActionConnectorsPaginator ¶ added in v1.95.0
type SearchActionConnectorsPaginator struct {
// contains filtered or unexported fields
}
SearchActionConnectorsPaginator is a paginator for SearchActionConnectors
func NewSearchActionConnectorsPaginator ¶ added in v1.95.0
func NewSearchActionConnectorsPaginator(client SearchActionConnectorsAPIClient, params *SearchActionConnectorsInput, optFns ...func(*SearchActionConnectorsPaginatorOptions)) *SearchActionConnectorsPaginator
NewSearchActionConnectorsPaginator returns a new SearchActionConnectorsPaginator
func (*SearchActionConnectorsPaginator) HasMorePages ¶ added in v1.95.0
func (p *SearchActionConnectorsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchActionConnectorsPaginator) NextPage ¶ added in v1.95.0
func (p *SearchActionConnectorsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchActionConnectorsOutput, error)
NextPage retrieves the next SearchActionConnectors page.
type SearchActionConnectorsPaginatorOptions ¶ added in v1.95.0
type SearchActionConnectorsPaginatorOptions struct {
// The maximum number of action connectors to return in a single response. Valid
// range is 1 to 100.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
SearchActionConnectorsPaginatorOptions is the paginator options for SearchActionConnectors
type SearchAgentsInput ¶ added in v1.113.0
type SearchAgentsInput struct {
// The ID of the Amazon Web Services account that contains the agents.
//
// This member is required.
AwsAccountId *string
// The filters to apply when searching agents.
//
// This member is required.
Filters []types.AgentSearchFilter
// The maximum number of results to return.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*SearchAgentsInput) Serialize ¶ added in v1.131.0
func (v *SearchAgentsInput) Serialize(s smithy.ShapeSerializer)
func (*SearchAgentsInput) SerializeMembers ¶ added in v1.131.0
func (v *SearchAgentsInput) SerializeMembers(s smithy.ShapeSerializer)
type SearchAgentsOutput ¶ added in v1.113.0
type SearchAgentsOutput struct {
// A list of agent summaries.
AgentSummaries []types.AgentSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SearchAgentsOutput) Deserialize ¶ added in v1.131.0
func (v *SearchAgentsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*SearchAgentsOutput) Serialize ¶ added in v1.131.0
func (v *SearchAgentsOutput) Serialize(s smithy.ShapeSerializer)
func (*SearchAgentsOutput) SerializeMembers ¶ added in v1.131.0
func (v *SearchAgentsOutput) SerializeMembers(s smithy.ShapeSerializer)
type SearchAnalysesAPIClient ¶ added in v0.30.0
type SearchAnalysesAPIClient interface {
SearchAnalyses(context.Context, *SearchAnalysesInput, ...func(*Options)) (*SearchAnalysesOutput, error)
}
SearchAnalysesAPIClient is a client that implements the SearchAnalyses operation.
type SearchAnalysesInput ¶ added in v0.29.0
type SearchAnalysesInput struct {
// The ID of the Amazon Web Services account that contains the analyses that
// you're searching for.
//
// This member is required.
AwsAccountId *string
// The structure for the search filters that you want to apply to your search.
//
// This member is required.
Filters []types.AnalysisSearchFilter
// The maximum number of results to return.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
// contains filtered or unexported fields
}
func (*SearchAnalysesInput) Serialize ¶ added in v1.131.0
func (v *SearchAnalysesInput) Serialize(s smithy.ShapeSerializer)
func (*SearchAnalysesInput) SerializeMembers ¶ added in v1.131.0
func (v *SearchAnalysesInput) SerializeMembers(s smithy.ShapeSerializer)
type SearchAnalysesOutput ¶ added in v0.29.0
type SearchAnalysesOutput struct {
// Metadata describing the analyses that you searched for.
AnalysisSummaryList []types.AnalysisSummary
// A pagination token that can be used in a subsequent request.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SearchAnalysesOutput) Deserialize ¶ added in v1.131.0
func (v *SearchAnalysesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*SearchAnalysesOutput) Serialize ¶ added in v1.131.0
func (v *SearchAnalysesOutput) Serialize(s smithy.ShapeSerializer)
func (*SearchAnalysesOutput) SerializeMembers ¶ added in v1.131.0
func (v *SearchAnalysesOutput) SerializeMembers(s smithy.ShapeSerializer)
type SearchAnalysesPaginator ¶ added in v0.30.0
type SearchAnalysesPaginator struct {
// contains filtered or unexported fields
}
SearchAnalysesPaginator is a paginator for SearchAnalyses
func NewSearchAnalysesPaginator ¶ added in v0.30.0
func NewSearchAnalysesPaginator(client SearchAnalysesAPIClient, params *SearchAnalysesInput, optFns ...func(*SearchAnalysesPaginatorOptions)) *SearchAnalysesPaginator
NewSearchAnalysesPaginator returns a new SearchAnalysesPaginator
func (*SearchAnalysesPaginator) HasMorePages ¶ added in v0.30.0
func (p *SearchAnalysesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchAnalysesPaginator) NextPage ¶ added in v0.30.0
func (p *SearchAnalysesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchAnalysesOutput, error)
NextPage retrieves the next SearchAnalyses page.
type SearchAnalysesPaginatorOptions ¶ added in v0.30.0
type SearchAnalysesPaginatorOptions struct {
// The maximum number of results to return.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
SearchAnalysesPaginatorOptions is the paginator options for SearchAnalyses
type SearchAppsAPIClient ¶ added in v1.127.0
type SearchAppsAPIClient interface {
SearchApps(context.Context, *SearchAppsInput, ...func(*Options)) (*SearchAppsOutput, error)
}
SearchAppsAPIClient is a client that implements the SearchApps operation.
type SearchAppsInput ¶ added in v1.127.0
type SearchAppsInput struct {
// The ID of the Amazon Web Services account that contains the apps to search.
//
// This member is required.
AwsAccountId *string
// The filters to apply to the search.
//
// This member is required.
Filters []types.SearchAppsFilter
// The maximum number of results to return in a single request. Valid range is 1
// to 100. If you don't specify a value, the default is 20.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*SearchAppsInput) Serialize ¶ added in v1.131.0
func (v *SearchAppsInput) Serialize(s smithy.ShapeSerializer)
func (*SearchAppsInput) SerializeMembers ¶ added in v1.131.0
func (v *SearchAppsInput) SerializeMembers(s smithy.ShapeSerializer)
type SearchAppsOutput ¶ added in v1.127.0
type SearchAppsOutput struct {
// A list of app summaries that match the search criteria.
//
// This member is required.
AppSummaryList []types.AppSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SearchAppsOutput) Deserialize ¶ added in v1.131.0
func (v *SearchAppsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*SearchAppsOutput) Serialize ¶ added in v1.131.0
func (v *SearchAppsOutput) Serialize(s smithy.ShapeSerializer)
func (*SearchAppsOutput) SerializeMembers ¶ added in v1.131.0
func (v *SearchAppsOutput) SerializeMembers(s smithy.ShapeSerializer)
type SearchAppsPaginator ¶ added in v1.127.0
type SearchAppsPaginator struct {
// contains filtered or unexported fields
}
SearchAppsPaginator is a paginator for SearchApps
func NewSearchAppsPaginator ¶ added in v1.127.0
func NewSearchAppsPaginator(client SearchAppsAPIClient, params *SearchAppsInput, optFns ...func(*SearchAppsPaginatorOptions)) *SearchAppsPaginator
NewSearchAppsPaginator returns a new SearchAppsPaginator
func (*SearchAppsPaginator) HasMorePages ¶ added in v1.127.0
func (p *SearchAppsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchAppsPaginator) NextPage ¶ added in v1.127.0
func (p *SearchAppsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchAppsOutput, error)
NextPage retrieves the next SearchApps page.
type SearchAppsPaginatorOptions ¶ added in v1.127.0
type SearchAppsPaginatorOptions struct {
// The maximum number of results to return in a single request. Valid range is 1
// to 100. If you don't specify a value, the default is 20.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
SearchAppsPaginatorOptions is the paginator options for SearchApps
type SearchDashboardsAPIClient ¶ added in v0.30.0
type SearchDashboardsAPIClient interface {
SearchDashboards(context.Context, *SearchDashboardsInput, ...func(*Options)) (*SearchDashboardsOutput, error)
}
SearchDashboardsAPIClient is a client that implements the SearchDashboards operation.
type SearchDashboardsInput ¶
type SearchDashboardsInput struct {
// The ID of the Amazon Web Services account that contains the user whose
// dashboards you're searching for.
//
// This member is required.
AwsAccountId *string
// 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"
// } ]
//
// This member is required.
Filters []types.DashboardSearchFilter
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*SearchDashboardsInput) Serialize ¶ added in v1.131.0
func (v *SearchDashboardsInput) Serialize(s smithy.ShapeSerializer)
func (*SearchDashboardsInput) SerializeMembers ¶ added in v1.131.0
func (v *SearchDashboardsInput) SerializeMembers(s smithy.ShapeSerializer)
type SearchDashboardsOutput ¶
type SearchDashboardsOutput struct {
// The list of dashboards owned by the user specified in Filters in your request.
DashboardSummaryList []types.DashboardSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SearchDashboardsOutput) Deserialize ¶ added in v1.131.0
func (v *SearchDashboardsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*SearchDashboardsOutput) Serialize ¶ added in v1.131.0
func (v *SearchDashboardsOutput) Serialize(s smithy.ShapeSerializer)
func (*SearchDashboardsOutput) SerializeMembers ¶ added in v1.131.0
func (v *SearchDashboardsOutput) SerializeMembers(s smithy.ShapeSerializer)
type SearchDashboardsPaginator ¶ added in v0.30.0
type SearchDashboardsPaginator struct {
// contains filtered or unexported fields
}
SearchDashboardsPaginator is a paginator for SearchDashboards
func NewSearchDashboardsPaginator ¶ added in v0.30.0
func NewSearchDashboardsPaginator(client SearchDashboardsAPIClient, params *SearchDashboardsInput, optFns ...func(*SearchDashboardsPaginatorOptions)) *SearchDashboardsPaginator
NewSearchDashboardsPaginator returns a new SearchDashboardsPaginator
func (*SearchDashboardsPaginator) HasMorePages ¶ added in v0.30.0
func (p *SearchDashboardsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchDashboardsPaginator) NextPage ¶ added in v0.30.0
func (p *SearchDashboardsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchDashboardsOutput, error)
NextPage retrieves the next SearchDashboards page.
type SearchDashboardsPaginatorOptions ¶ added in v0.30.0
type SearchDashboardsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
SearchDashboardsPaginatorOptions is the paginator options for SearchDashboards
type SearchDataSetsAPIClient ¶ added in v1.27.0
type SearchDataSetsAPIClient interface {
SearchDataSets(context.Context, *SearchDataSetsInput, ...func(*Options)) (*SearchDataSetsOutput, error)
}
SearchDataSetsAPIClient is a client that implements the SearchDataSets operation.
type SearchDataSetsInput ¶ added in v1.27.0
type SearchDataSetsInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The filters to apply to the search.
//
// This member is required.
Filters []types.DataSetSearchFilter
// The maximum number of results to be returned per request.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
// contains filtered or unexported fields
}
func (*SearchDataSetsInput) Serialize ¶ added in v1.131.0
func (v *SearchDataSetsInput) Serialize(s smithy.ShapeSerializer)
func (*SearchDataSetsInput) SerializeMembers ¶ added in v1.131.0
func (v *SearchDataSetsInput) SerializeMembers(s smithy.ShapeSerializer)
type SearchDataSetsOutput ¶ added in v1.27.0
type SearchDataSetsOutput struct {
// A DataSetSummaries object that returns a summary of a dataset.
DataSetSummaries []types.DataSetSummary
// A pagination token that can be used in a subsequent request.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SearchDataSetsOutput) Deserialize ¶ added in v1.131.0
func (v *SearchDataSetsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*SearchDataSetsOutput) Serialize ¶ added in v1.131.0
func (v *SearchDataSetsOutput) Serialize(s smithy.ShapeSerializer)
func (*SearchDataSetsOutput) SerializeMembers ¶ added in v1.131.0
func (v *SearchDataSetsOutput) SerializeMembers(s smithy.ShapeSerializer)
type SearchDataSetsPaginator ¶ added in v1.27.0
type SearchDataSetsPaginator struct {
// contains filtered or unexported fields
}
SearchDataSetsPaginator is a paginator for SearchDataSets
func NewSearchDataSetsPaginator ¶ added in v1.27.0
func NewSearchDataSetsPaginator(client SearchDataSetsAPIClient, params *SearchDataSetsInput, optFns ...func(*SearchDataSetsPaginatorOptions)) *SearchDataSetsPaginator
NewSearchDataSetsPaginator returns a new SearchDataSetsPaginator
func (*SearchDataSetsPaginator) HasMorePages ¶ added in v1.27.0
func (p *SearchDataSetsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchDataSetsPaginator) NextPage ¶ added in v1.27.0
func (p *SearchDataSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchDataSetsOutput, error)
NextPage retrieves the next SearchDataSets page.
type SearchDataSetsPaginatorOptions ¶ added in v1.27.0
type SearchDataSetsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
SearchDataSetsPaginatorOptions is the paginator options for SearchDataSets
type SearchDataSourcesAPIClient ¶ added in v1.27.0
type SearchDataSourcesAPIClient interface {
SearchDataSources(context.Context, *SearchDataSourcesInput, ...func(*Options)) (*SearchDataSourcesOutput, error)
}
SearchDataSourcesAPIClient is a client that implements the SearchDataSources operation.
type SearchDataSourcesInput ¶ added in v1.27.0
type SearchDataSourcesInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The filters to apply to the search.
//
// This member is required.
Filters []types.DataSourceSearchFilter
// The maximum number of results to be returned per request.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
// contains filtered or unexported fields
}
func (*SearchDataSourcesInput) Serialize ¶ added in v1.131.0
func (v *SearchDataSourcesInput) Serialize(s smithy.ShapeSerializer)
func (*SearchDataSourcesInput) SerializeMembers ¶ added in v1.131.0
func (v *SearchDataSourcesInput) SerializeMembers(s smithy.ShapeSerializer)
type SearchDataSourcesOutput ¶ added in v1.27.0
type SearchDataSourcesOutput struct {
// A DataSourceSummaries object that returns a summary of a data source.
DataSourceSummaries []types.DataSourceSummary
// A pagination token that can be used in a subsequent request.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SearchDataSourcesOutput) Deserialize ¶ added in v1.131.0
func (v *SearchDataSourcesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*SearchDataSourcesOutput) Serialize ¶ added in v1.131.0
func (v *SearchDataSourcesOutput) Serialize(s smithy.ShapeSerializer)
func (*SearchDataSourcesOutput) SerializeMembers ¶ added in v1.131.0
func (v *SearchDataSourcesOutput) SerializeMembers(s smithy.ShapeSerializer)
type SearchDataSourcesPaginator ¶ added in v1.27.0
type SearchDataSourcesPaginator struct {
// contains filtered or unexported fields
}
SearchDataSourcesPaginator is a paginator for SearchDataSources
func NewSearchDataSourcesPaginator ¶ added in v1.27.0
func NewSearchDataSourcesPaginator(client SearchDataSourcesAPIClient, params *SearchDataSourcesInput, optFns ...func(*SearchDataSourcesPaginatorOptions)) *SearchDataSourcesPaginator
NewSearchDataSourcesPaginator returns a new SearchDataSourcesPaginator
func (*SearchDataSourcesPaginator) HasMorePages ¶ added in v1.27.0
func (p *SearchDataSourcesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchDataSourcesPaginator) NextPage ¶ added in v1.27.0
func (p *SearchDataSourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchDataSourcesOutput, error)
NextPage retrieves the next SearchDataSources page.
type SearchDataSourcesPaginatorOptions ¶ added in v1.27.0
type SearchDataSourcesPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
SearchDataSourcesPaginatorOptions is the paginator options for SearchDataSources
type SearchFlowsAPIClient ¶ added in v1.95.0
type SearchFlowsAPIClient interface {
SearchFlows(context.Context, *SearchFlowsInput, ...func(*Options)) (*SearchFlowsOutput, error)
}
SearchFlowsAPIClient is a client that implements the SearchFlows operation.
type SearchFlowsInput ¶ added in v1.95.0
type SearchFlowsInput struct {
// The ID of the Amazon Web Services account where you are searching for flows
// from.
//
// This member is required.
AwsAccountId *string
// The filters applied to the search when searching for flows in the Amazon Web
// Services account.
//
// This member is required.
Filters []types.SearchFlowsFilter
// The maximum number of results to be returned per request.
MaxResults *int32
// The token to request the next set of results, or null if you want to retrieve
// the first set.
NextToken *string
// contains filtered or unexported fields
}
func (*SearchFlowsInput) Serialize ¶ added in v1.131.0
func (v *SearchFlowsInput) Serialize(s smithy.ShapeSerializer)
func (*SearchFlowsInput) SerializeMembers ¶ added in v1.131.0
func (v *SearchFlowsInput) SerializeMembers(s smithy.ShapeSerializer)
type SearchFlowsOutput ¶ added in v1.95.0
type SearchFlowsOutput struct {
// The list of flows found against the search.
//
// This member is required.
FlowSummaryList []types.FlowSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SearchFlowsOutput) Deserialize ¶ added in v1.131.0
func (v *SearchFlowsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*SearchFlowsOutput) Serialize ¶ added in v1.131.0
func (v *SearchFlowsOutput) Serialize(s smithy.ShapeSerializer)
func (*SearchFlowsOutput) SerializeMembers ¶ added in v1.131.0
func (v *SearchFlowsOutput) SerializeMembers(s smithy.ShapeSerializer)
type SearchFlowsPaginator ¶ added in v1.95.0
type SearchFlowsPaginator struct {
// contains filtered or unexported fields
}
SearchFlowsPaginator is a paginator for SearchFlows
func NewSearchFlowsPaginator ¶ added in v1.95.0
func NewSearchFlowsPaginator(client SearchFlowsAPIClient, params *SearchFlowsInput, optFns ...func(*SearchFlowsPaginatorOptions)) *SearchFlowsPaginator
NewSearchFlowsPaginator returns a new SearchFlowsPaginator
func (*SearchFlowsPaginator) HasMorePages ¶ added in v1.95.0
func (p *SearchFlowsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchFlowsPaginator) NextPage ¶ added in v1.95.0
func (p *SearchFlowsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchFlowsOutput, error)
NextPage retrieves the next SearchFlows page.
type SearchFlowsPaginatorOptions ¶ added in v1.95.0
type SearchFlowsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
SearchFlowsPaginatorOptions is the paginator options for SearchFlows
type SearchFoldersAPIClient ¶ added in v1.42.0
type SearchFoldersAPIClient interface {
SearchFolders(context.Context, *SearchFoldersInput, ...func(*Options)) (*SearchFoldersOutput, error)
}
SearchFoldersAPIClient is a client that implements the SearchFolders operation.
type SearchFoldersInput ¶ added in v1.6.0
type SearchFoldersInput struct {
// The ID for the Amazon Web Services account that contains the folder.
//
// This member is required.
AwsAccountId *string
// 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" } ] .
//
// This member is required.
Filters []types.FolderSearchFilter
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*SearchFoldersInput) Serialize ¶ added in v1.131.0
func (v *SearchFoldersInput) Serialize(s smithy.ShapeSerializer)
func (*SearchFoldersInput) SerializeMembers ¶ added in v1.131.0
func (v *SearchFoldersInput) SerializeMembers(s smithy.ShapeSerializer)
type SearchFoldersOutput ¶ added in v1.6.0
type SearchFoldersOutput struct {
// A structure that contains all of the folders in the Amazon Web Services
// account. This structure provides basic information about the folders.
FolderSummaryList []types.FolderSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SearchFoldersOutput) Deserialize ¶ added in v1.131.0
func (v *SearchFoldersOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*SearchFoldersOutput) Serialize ¶ added in v1.131.0
func (v *SearchFoldersOutput) Serialize(s smithy.ShapeSerializer)
func (*SearchFoldersOutput) SerializeMembers ¶ added in v1.131.0
func (v *SearchFoldersOutput) SerializeMembers(s smithy.ShapeSerializer)
type SearchFoldersPaginator ¶ added in v1.42.0
type SearchFoldersPaginator struct {
// contains filtered or unexported fields
}
SearchFoldersPaginator is a paginator for SearchFolders
func NewSearchFoldersPaginator ¶ added in v1.42.0
func NewSearchFoldersPaginator(client SearchFoldersAPIClient, params *SearchFoldersInput, optFns ...func(*SearchFoldersPaginatorOptions)) *SearchFoldersPaginator
NewSearchFoldersPaginator returns a new SearchFoldersPaginator
func (*SearchFoldersPaginator) HasMorePages ¶ added in v1.42.0
func (p *SearchFoldersPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchFoldersPaginator) NextPage ¶ added in v1.42.0
func (p *SearchFoldersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchFoldersOutput, error)
NextPage retrieves the next SearchFolders page.
type SearchFoldersPaginatorOptions ¶ added in v1.42.0
type SearchFoldersPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
SearchFoldersPaginatorOptions is the paginator options for SearchFolders
type SearchGroupsAPIClient ¶ added in v1.39.0
type SearchGroupsAPIClient interface {
SearchGroups(context.Context, *SearchGroupsInput, ...func(*Options)) (*SearchGroupsOutput, error)
}
SearchGroupsAPIClient is a client that implements the SearchGroups operation.
type SearchGroupsInput ¶ added in v1.21.0
type SearchGroupsInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The structure for the search filters that you want to apply to your search.
//
// This member is required.
Filters []types.GroupSearchFilter
// The namespace that you want to search.
//
// This member is required.
Namespace *string
// The maximum number of results to return from this request.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
// contains filtered or unexported fields
}
func (*SearchGroupsInput) Serialize ¶ added in v1.131.0
func (v *SearchGroupsInput) Serialize(s smithy.ShapeSerializer)
func (*SearchGroupsInput) SerializeMembers ¶ added in v1.131.0
func (v *SearchGroupsInput) SerializeMembers(s smithy.ShapeSerializer)
type SearchGroupsOutput ¶ added in v1.21.0
type SearchGroupsOutput struct {
// A list of groups in a specified namespace that match the filters you set in
// your SearchGroups request.
GroupList []types.Group
// A pagination token that can be used in a subsequent request.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SearchGroupsOutput) Deserialize ¶ added in v1.131.0
func (v *SearchGroupsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*SearchGroupsOutput) Serialize ¶ added in v1.131.0
func (v *SearchGroupsOutput) Serialize(s smithy.ShapeSerializer)
func (*SearchGroupsOutput) SerializeMembers ¶ added in v1.131.0
func (v *SearchGroupsOutput) SerializeMembers(s smithy.ShapeSerializer)
type SearchGroupsPaginator ¶ added in v1.39.0
type SearchGroupsPaginator struct {
// contains filtered or unexported fields
}
SearchGroupsPaginator is a paginator for SearchGroups
func NewSearchGroupsPaginator ¶ added in v1.39.0
func NewSearchGroupsPaginator(client SearchGroupsAPIClient, params *SearchGroupsInput, optFns ...func(*SearchGroupsPaginatorOptions)) *SearchGroupsPaginator
NewSearchGroupsPaginator returns a new SearchGroupsPaginator
func (*SearchGroupsPaginator) HasMorePages ¶ added in v1.39.0
func (p *SearchGroupsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchGroupsPaginator) NextPage ¶ added in v1.39.0
func (p *SearchGroupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchGroupsOutput, error)
NextPage retrieves the next SearchGroups page.
type SearchGroupsPaginatorOptions ¶ added in v1.39.0
type SearchGroupsPaginatorOptions struct {
// The maximum number of results to return from this request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
SearchGroupsPaginatorOptions is the paginator options for SearchGroups
type SearchKnowledgeBasesAPIClient ¶ added in v1.114.0
type SearchKnowledgeBasesAPIClient interface {
SearchKnowledgeBases(context.Context, *SearchKnowledgeBasesInput, ...func(*Options)) (*SearchKnowledgeBasesOutput, error)
}
SearchKnowledgeBasesAPIClient is a client that implements the SearchKnowledgeBases operation.
type SearchKnowledgeBasesInput ¶ added in v1.114.0
type SearchKnowledgeBasesInput struct {
// The ID of the Amazon Web Services account that contains the knowledge base.
//
// This member is required.
AwsAccountId *string
// The filters to apply when searching knowledge bases.
Filters []types.KnowledgeBaseSearchFilter
// The maximum number of results to return.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The sort configuration for the search results.
SortBy *types.KnowledgeBaseSortBy
// contains filtered or unexported fields
}
func (*SearchKnowledgeBasesInput) Serialize ¶ added in v1.131.0
func (v *SearchKnowledgeBasesInput) Serialize(s smithy.ShapeSerializer)
func (*SearchKnowledgeBasesInput) SerializeMembers ¶ added in v1.131.0
func (v *SearchKnowledgeBasesInput) SerializeMembers(s smithy.ShapeSerializer)
type SearchKnowledgeBasesOutput ¶ added in v1.114.0
type SearchKnowledgeBasesOutput struct {
// A list of knowledge base summaries.
//
// This member is required.
KnowledgeBaseSummaries []types.KnowledgeBaseSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status *int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SearchKnowledgeBasesOutput) Deserialize ¶ added in v1.131.0
func (v *SearchKnowledgeBasesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*SearchKnowledgeBasesOutput) Serialize ¶ added in v1.131.0
func (v *SearchKnowledgeBasesOutput) Serialize(s smithy.ShapeSerializer)
func (*SearchKnowledgeBasesOutput) SerializeMembers ¶ added in v1.131.0
func (v *SearchKnowledgeBasesOutput) SerializeMembers(s smithy.ShapeSerializer)
type SearchKnowledgeBasesPaginator ¶ added in v1.114.0
type SearchKnowledgeBasesPaginator struct {
// contains filtered or unexported fields
}
SearchKnowledgeBasesPaginator is a paginator for SearchKnowledgeBases
func NewSearchKnowledgeBasesPaginator ¶ added in v1.114.0
func NewSearchKnowledgeBasesPaginator(client SearchKnowledgeBasesAPIClient, params *SearchKnowledgeBasesInput, optFns ...func(*SearchKnowledgeBasesPaginatorOptions)) *SearchKnowledgeBasesPaginator
NewSearchKnowledgeBasesPaginator returns a new SearchKnowledgeBasesPaginator
func (*SearchKnowledgeBasesPaginator) HasMorePages ¶ added in v1.114.0
func (p *SearchKnowledgeBasesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchKnowledgeBasesPaginator) NextPage ¶ added in v1.114.0
func (p *SearchKnowledgeBasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchKnowledgeBasesOutput, error)
NextPage retrieves the next SearchKnowledgeBases page.
type SearchKnowledgeBasesPaginatorOptions ¶ added in v1.114.0
type SearchKnowledgeBasesPaginatorOptions struct {
// The maximum number of results to return.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
SearchKnowledgeBasesPaginatorOptions is the paginator options for SearchKnowledgeBases
type SearchSpacesInput ¶ added in v1.113.0
type SearchSpacesInput struct {
// The ID of the Amazon Web Services account that contains the spaces.
//
// This member is required.
AwsAccountId *string
// The filters to apply to the search.
//
// This member is required.
Filters []types.SpaceQuicksightSearchFilter
// The maximum number of results to return.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*SearchSpacesInput) Serialize ¶ added in v1.131.0
func (v *SearchSpacesInput) Serialize(s smithy.ShapeSerializer)
func (*SearchSpacesInput) SerializeMembers ¶ added in v1.131.0
func (v *SearchSpacesInput) SerializeMembers(s smithy.ShapeSerializer)
type SearchSpacesOutput ¶ added in v1.113.0
type SearchSpacesOutput struct {
// The ID of the space.
//
// This member is required.
SpaceId *string
// A list of space summaries that match the search criteria.
//
// This member is required.
SpaceSummaries []types.SpaceSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The ARN of the space.
SpaceArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SearchSpacesOutput) Deserialize ¶ added in v1.131.0
func (v *SearchSpacesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*SearchSpacesOutput) Serialize ¶ added in v1.131.0
func (v *SearchSpacesOutput) Serialize(s smithy.ShapeSerializer)
func (*SearchSpacesOutput) SerializeMembers ¶ added in v1.131.0
func (v *SearchSpacesOutput) SerializeMembers(s smithy.ShapeSerializer)
type SearchTopicsAPIClient ¶ added in v1.80.0
type SearchTopicsAPIClient interface {
SearchTopics(context.Context, *SearchTopicsInput, ...func(*Options)) (*SearchTopicsOutput, error)
}
SearchTopicsAPIClient is a client that implements the SearchTopics operation.
type SearchTopicsInput ¶ added in v1.80.0
type SearchTopicsInput struct {
// The ID of the Amazon Web Services account that contains the topic that you want
// to find.
//
// This member is required.
AwsAccountId *string
// The filters that you want to use to search for the topic.
//
// This member is required.
Filters []types.TopicSearchFilter
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*SearchTopicsInput) Serialize ¶ added in v1.131.0
func (v *SearchTopicsInput) Serialize(s smithy.ShapeSerializer)
func (*SearchTopicsInput) SerializeMembers ¶ added in v1.131.0
func (v *SearchTopicsInput) SerializeMembers(s smithy.ShapeSerializer)
type SearchTopicsOutput ¶ added in v1.80.0
type SearchTopicsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A list of topic summaries that is returned by the search topic request.
TopicSummaryList []types.TopicSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SearchTopicsOutput) Deserialize ¶ added in v1.131.0
func (v *SearchTopicsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*SearchTopicsOutput) Serialize ¶ added in v1.131.0
func (v *SearchTopicsOutput) Serialize(s smithy.ShapeSerializer)
func (*SearchTopicsOutput) SerializeMembers ¶ added in v1.131.0
func (v *SearchTopicsOutput) SerializeMembers(s smithy.ShapeSerializer)
type SearchTopicsPaginator ¶ added in v1.80.0
type SearchTopicsPaginator struct {
// contains filtered or unexported fields
}
SearchTopicsPaginator is a paginator for SearchTopics
func NewSearchTopicsPaginator ¶ added in v1.80.0
func NewSearchTopicsPaginator(client SearchTopicsAPIClient, params *SearchTopicsInput, optFns ...func(*SearchTopicsPaginatorOptions)) *SearchTopicsPaginator
NewSearchTopicsPaginator returns a new SearchTopicsPaginator
func (*SearchTopicsPaginator) HasMorePages ¶ added in v1.80.0
func (p *SearchTopicsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchTopicsPaginator) NextPage ¶ added in v1.80.0
func (p *SearchTopicsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchTopicsOutput, error)
NextPage retrieves the next SearchTopics page.
type SearchTopicsPaginatorOptions ¶ added in v1.80.0
type SearchTopicsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
SearchTopicsPaginatorOptions is the paginator options for SearchTopics
type SearchTopicsV2APIClient ¶ added in v1.123.0
type SearchTopicsV2APIClient interface {
SearchTopicsV2(context.Context, *SearchTopicsV2Input, ...func(*Options)) (*SearchTopicsV2Output, error)
}
SearchTopicsV2APIClient is a client that implements the SearchTopicsV2 operation.
type SearchTopicsV2Input ¶ added in v1.123.0
type SearchTopicsV2Input struct {
// The ID of the Amazon Web Services account that contains the topic that you want
// to search.
//
// This member is required.
AwsAccountId *string
// The filters that you want to use to search for the topic.
//
// This member is required.
Filters []types.TopicSearchFilter
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// contains filtered or unexported fields
}
func (*SearchTopicsV2Input) Serialize ¶ added in v1.131.0
func (v *SearchTopicsV2Input) Serialize(s smithy.ShapeSerializer)
func (*SearchTopicsV2Input) SerializeMembers ¶ added in v1.131.0
func (v *SearchTopicsV2Input) SerializeMembers(s smithy.ShapeSerializer)
type SearchTopicsV2Output ¶ added in v1.123.0
type SearchTopicsV2Output struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A list of topic summaries that is returned by the search topic request.
TopicSummaryList []types.TopicV2Summary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*SearchTopicsV2Output) Deserialize ¶ added in v1.131.0
func (v *SearchTopicsV2Output) Deserialize(d smithy.ShapeDeserializer) error
func (*SearchTopicsV2Output) Serialize ¶ added in v1.131.0
func (v *SearchTopicsV2Output) Serialize(s smithy.ShapeSerializer)
func (*SearchTopicsV2Output) SerializeMembers ¶ added in v1.131.0
func (v *SearchTopicsV2Output) SerializeMembers(s smithy.ShapeSerializer)
type SearchTopicsV2Paginator ¶ added in v1.123.0
type SearchTopicsV2Paginator struct {
// contains filtered or unexported fields
}
SearchTopicsV2Paginator is a paginator for SearchTopicsV2
func NewSearchTopicsV2Paginator ¶ added in v1.123.0
func NewSearchTopicsV2Paginator(client SearchTopicsV2APIClient, params *SearchTopicsV2Input, optFns ...func(*SearchTopicsV2PaginatorOptions)) *SearchTopicsV2Paginator
NewSearchTopicsV2Paginator returns a new SearchTopicsV2Paginator
func (*SearchTopicsV2Paginator) HasMorePages ¶ added in v1.123.0
func (p *SearchTopicsV2Paginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*SearchTopicsV2Paginator) NextPage ¶ added in v1.123.0
func (p *SearchTopicsV2Paginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchTopicsV2Output, error)
NextPage retrieves the next SearchTopicsV2 page.
type SearchTopicsV2PaginatorOptions ¶ added in v1.123.0
type SearchTopicsV2PaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
SearchTopicsV2PaginatorOptions is the paginator options for SearchTopicsV2
type StartAssetBundleExportJobInput ¶ added in v1.36.0
type StartAssetBundleExportJobInput struct {
// 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.
//
// This member is required.
AssetBundleExportJobId *string
// The ID of the Amazon Web Services account to export assets from.
//
// This member is required.
AwsAccountId *string
// The export data format.
//
// This member is required.
ExportFormat types.AssetBundleExportFormat
// 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.
//
// This member is required.
ResourceArns []string
// 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 .
CloudFormationOverridePropertyConfiguration *types.AssetBundleCloudFormationOverridePropertyConfiguration
// 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.
IncludeAllDependencies bool
// 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.
IncludeFolderMembers types.IncludeFolderMembers
// A Boolean that determines if the exported asset carries over information about
// the folders that the asset is a member of.
IncludeFolderMemberships bool
// 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.
IncludePermissions bool
// 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.
IncludeTags bool
// 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 .
ValidationStrategy *types.AssetBundleExportJobValidationStrategy
// contains filtered or unexported fields
}
func (*StartAssetBundleExportJobInput) Serialize ¶ added in v1.131.0
func (v *StartAssetBundleExportJobInput) Serialize(s smithy.ShapeSerializer)
func (*StartAssetBundleExportJobInput) SerializeMembers ¶ added in v1.131.0
func (v *StartAssetBundleExportJobInput) SerializeMembers(s smithy.ShapeSerializer)
type StartAssetBundleExportJobOutput ¶ added in v1.36.0
type StartAssetBundleExportJobOutput struct {
// The Amazon Resource Name (ARN) for the export job.
Arn *string
// 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.
AssetBundleExportJobId *string
// The Amazon Web Services response ID for this operation.
RequestId *string
// The HTTP status of the response.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*StartAssetBundleExportJobOutput) Deserialize ¶ added in v1.131.0
func (v *StartAssetBundleExportJobOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*StartAssetBundleExportJobOutput) Serialize ¶ added in v1.131.0
func (v *StartAssetBundleExportJobOutput) Serialize(s smithy.ShapeSerializer)
func (*StartAssetBundleExportJobOutput) SerializeMembers ¶ added in v1.131.0
func (v *StartAssetBundleExportJobOutput) SerializeMembers(s smithy.ShapeSerializer)
type StartAssetBundleImportJobInput ¶ added in v1.36.0
type StartAssetBundleImportJobInput struct {
// 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.
//
// This member is required.
AssetBundleImportJobId *string
// 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.
//
// This member is required.
AssetBundleImportSource *types.AssetBundleImportSource
// The ID of the Amazon Web Services account to import assets into.
//
// This member is required.
AwsAccountId *string
// 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.
FailureAction types.AssetBundleImportFailureAction
// Optional overrides that are applied to the resource configuration before import.
OverrideParameters *types.AssetBundleImportJobOverrideParameters
// Optional permission overrides that are applied to the resource configuration
// before import.
OverridePermissions *types.AssetBundleImportJobOverridePermissions
// Optional tag overrides that are applied to the resource configuration before
// import.
OverrideTags *types.AssetBundleImportJobOverrideTags
// An optional validation strategy override for all analyses and dashboards that
// is applied to the resource configuration before import.
OverrideValidationStrategy *types.AssetBundleImportJobOverrideValidationStrategy
// contains filtered or unexported fields
}
func (*StartAssetBundleImportJobInput) Serialize ¶ added in v1.131.0
func (v *StartAssetBundleImportJobInput) Serialize(s smithy.ShapeSerializer)
func (*StartAssetBundleImportJobInput) SerializeMembers ¶ added in v1.131.0
func (v *StartAssetBundleImportJobInput) SerializeMembers(s smithy.ShapeSerializer)
type StartAssetBundleImportJobOutput ¶ added in v1.36.0
type StartAssetBundleImportJobOutput struct {
// The Amazon Resource Name (ARN) for the import job.
Arn *string
// 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.
AssetBundleImportJobId *string
// The Amazon Web Services response ID for this operation.
RequestId *string
// The HTTP status of the response.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*StartAssetBundleImportJobOutput) Deserialize ¶ added in v1.131.0
func (v *StartAssetBundleImportJobOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*StartAssetBundleImportJobOutput) Serialize ¶ added in v1.131.0
func (v *StartAssetBundleImportJobOutput) Serialize(s smithy.ShapeSerializer)
func (*StartAssetBundleImportJobOutput) SerializeMembers ¶ added in v1.131.0
func (v *StartAssetBundleImportJobOutput) SerializeMembers(s smithy.ShapeSerializer)
type StartAutomationJobInput ¶ added in v1.106.0
type StartAutomationJobInput struct {
// The ID of the automation group that contains the automation to run.
//
// This member is required.
AutomationGroupId *string
// The ID of the automation to run.
//
// This member is required.
AutomationId *string
// The ID of the Amazon Web Services account that contains the automation.
//
// This member is required.
AwsAccountId *string
// The input payload for the automation job, provided as a JSON string.
InputPayload *string
// contains filtered or unexported fields
}
func (*StartAutomationJobInput) Serialize ¶ added in v1.131.0
func (v *StartAutomationJobInput) Serialize(s smithy.ShapeSerializer)
func (*StartAutomationJobInput) SerializeMembers ¶ added in v1.131.0
func (v *StartAutomationJobInput) SerializeMembers(s smithy.ShapeSerializer)
type StartAutomationJobOutput ¶ added in v1.106.0
type StartAutomationJobOutput struct {
// The Amazon Resource Name (ARN) of the automation job.
//
// This member is required.
Arn *string
// The ID of the automation job that was started.
//
// This member is required.
JobId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*StartAutomationJobOutput) Deserialize ¶ added in v1.131.0
func (v *StartAutomationJobOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*StartAutomationJobOutput) Serialize ¶ added in v1.131.0
func (v *StartAutomationJobOutput) Serialize(s smithy.ShapeSerializer)
func (*StartAutomationJobOutput) SerializeMembers ¶ added in v1.131.0
func (v *StartAutomationJobOutput) SerializeMembers(s smithy.ShapeSerializer)
type StartDashboardSnapshotJobInput ¶ added in v1.39.0
type StartDashboardSnapshotJobInput struct {
// The ID of the Amazon Web Services account that the dashboard snapshot job is
// executed in.
//
// This member is required.
AwsAccountId *string
// The ID of the dashboard that you want to start a snapshot job for.
//
// This member is required.
DashboardId *string
// A structure that describes the configuration of the dashboard snapshot.
//
// This member is required.
SnapshotConfiguration *types.SnapshotConfiguration
// An ID for the dashboard snapshot job. This ID is unique to the dashboard while
// the job is running. This ID can be used to poll the status of a job with a
// DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for
// another job 24 hours after the current job is completed.
//
// This member is required.
SnapshotJobId *string
// A structure that contains information about the users that the dashboard
// snapshot is generated for. The users can be either anonymous users or registered
// users. Anonymous users cannot be used together with registered users.
//
// When using identity-enhanced session credentials, set the UserConfiguration
// request attribute to null. Otherwise, the request will be invalid.
UserConfiguration *types.SnapshotUserConfiguration
// contains filtered or unexported fields
}
func (*StartDashboardSnapshotJobInput) Serialize ¶ added in v1.131.0
func (v *StartDashboardSnapshotJobInput) Serialize(s smithy.ShapeSerializer)
func (*StartDashboardSnapshotJobInput) SerializeMembers ¶ added in v1.131.0
func (v *StartDashboardSnapshotJobInput) SerializeMembers(s smithy.ShapeSerializer)
type StartDashboardSnapshotJobOutput ¶ added in v1.39.0
type StartDashboardSnapshotJobOutput struct {
// The Amazon Resource Name (ARN) for the dashboard snapshot job.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The ID of the job. The job ID is set when you start a new job with a
// StartDashboardSnapshotJob API call.
SnapshotJobId *string
// The HTTP status of the request
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*StartDashboardSnapshotJobOutput) Deserialize ¶ added in v1.131.0
func (v *StartDashboardSnapshotJobOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*StartDashboardSnapshotJobOutput) Serialize ¶ added in v1.131.0
func (v *StartDashboardSnapshotJobOutput) Serialize(s smithy.ShapeSerializer)
func (*StartDashboardSnapshotJobOutput) SerializeMembers ¶ added in v1.131.0
func (v *StartDashboardSnapshotJobOutput) SerializeMembers(s smithy.ShapeSerializer)
type StartDashboardSnapshotJobScheduleInput ¶ added in v1.77.0
type StartDashboardSnapshotJobScheduleInput struct {
// The ID of the Amazon Web Services account that the dashboard snapshot job is
// executed in.
//
// This member is required.
AwsAccountId *string
// The ID of the dashboard that you want to start a snapshot job schedule for.
//
// This member is required.
DashboardId *string
// The ID of the schedule that you want to start a snapshot job schedule for. The
// schedule ID can be found in the Amazon Quick Sight console in the Schedules pane
// of the dashboard that the schedule is configured for.
//
// This member is required.
ScheduleId *string
// contains filtered or unexported fields
}
func (*StartDashboardSnapshotJobScheduleInput) Serialize ¶ added in v1.131.0
func (v *StartDashboardSnapshotJobScheduleInput) Serialize(s smithy.ShapeSerializer)
func (*StartDashboardSnapshotJobScheduleInput) SerializeMembers ¶ added in v1.131.0
func (v *StartDashboardSnapshotJobScheduleInput) SerializeMembers(s smithy.ShapeSerializer)
type StartDashboardSnapshotJobScheduleOutput ¶ added in v1.77.0
type StartDashboardSnapshotJobScheduleOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*StartDashboardSnapshotJobScheduleOutput) Deserialize ¶ added in v1.131.0
func (v *StartDashboardSnapshotJobScheduleOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*StartDashboardSnapshotJobScheduleOutput) Serialize ¶ added in v1.131.0
func (v *StartDashboardSnapshotJobScheduleOutput) Serialize(s smithy.ShapeSerializer)
func (*StartDashboardSnapshotJobScheduleOutput) SerializeMembers ¶ added in v1.131.0
func (v *StartDashboardSnapshotJobScheduleOutput) SerializeMembers(s smithy.ShapeSerializer)
type TagResourceInput ¶
type TagResourceInput struct {
// The Amazon Resource Name (ARN) of the resource that you want to tag.
//
// This member is required.
ResourceArn *string
// Contains a map of the key-value pairs for the resource tag or tags assigned to
// the resource.
//
// This member is required.
Tags []types.Tag
// contains filtered or unexported fields
}
func (*TagResourceInput) Serialize ¶ added in v1.131.0
func (v *TagResourceInput) Serialize(s smithy.ShapeSerializer)
func (*TagResourceInput) SerializeMembers ¶ added in v1.131.0
func (v *TagResourceInput) SerializeMembers(s smithy.ShapeSerializer)
type TagResourceOutput ¶
type TagResourceOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*TagResourceOutput) Deserialize ¶ added in v1.131.0
func (v *TagResourceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*TagResourceOutput) Serialize ¶ added in v1.131.0
func (v *TagResourceOutput) Serialize(s smithy.ShapeSerializer)
func (*TagResourceOutput) SerializeMembers ¶ added in v1.131.0
func (v *TagResourceOutput) SerializeMembers(s smithy.ShapeSerializer)
type UntagResourceInput ¶
type UntagResourceInput struct {
// The Amazon Resource Name (ARN) of the resource that you want to untag.
//
// This member is required.
ResourceArn *string
// The keys of the key-value pairs for the resource tag or tags assigned to the
// resource.
//
// This member is required.
TagKeys []string
// contains filtered or unexported fields
}
func (*UntagResourceInput) Serialize ¶ added in v1.131.0
func (v *UntagResourceInput) Serialize(s smithy.ShapeSerializer)
func (*UntagResourceInput) SerializeMembers ¶ added in v1.131.0
func (v *UntagResourceInput) SerializeMembers(s smithy.ShapeSerializer)
type UntagResourceOutput ¶
type UntagResourceOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UntagResourceOutput) Deserialize ¶ added in v1.131.0
func (v *UntagResourceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UntagResourceOutput) Serialize ¶ added in v1.131.0
func (v *UntagResourceOutput) Serialize(s smithy.ShapeSerializer)
func (*UntagResourceOutput) SerializeMembers ¶ added in v1.131.0
func (v *UntagResourceOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAccountCustomPermissionInput ¶ added in v1.94.0
type UpdateAccountCustomPermissionInput struct {
// The ID of the Amazon Web Services account for which you want to apply a custom
// permissions profile.
//
// This member is required.
AwsAccountId *string
// The name of the custom permissions profile that you want to apply to an account.
//
// This member is required.
CustomPermissionsName *string
// contains filtered or unexported fields
}
func (*UpdateAccountCustomPermissionInput) Serialize ¶ added in v1.131.0
func (v *UpdateAccountCustomPermissionInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAccountCustomPermissionInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateAccountCustomPermissionInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAccountCustomPermissionOutput ¶ added in v1.94.0
type UpdateAccountCustomPermissionOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateAccountCustomPermissionOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateAccountCustomPermissionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateAccountCustomPermissionOutput) Serialize ¶ added in v1.131.0
func (v *UpdateAccountCustomPermissionOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAccountCustomPermissionOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateAccountCustomPermissionOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAccountCustomizationInput ¶
type UpdateAccountCustomizationInput struct {
// The Quick Sight customizations you're updating.
//
// This member is required.
AccountCustomization *types.AccountCustomization
// The ID for the Amazon Web Services account that you want to update Quick Sight
// customizations for.
//
// This member is required.
AwsAccountId *string
// The namespace that you want to update Quick Sight customizations for.
Namespace *string
// contains filtered or unexported fields
}
func (*UpdateAccountCustomizationInput) Serialize ¶ added in v1.131.0
func (v *UpdateAccountCustomizationInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAccountCustomizationInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateAccountCustomizationInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAccountCustomizationOutput ¶
type UpdateAccountCustomizationOutput struct {
// The Quick Sight customizations you're updating.
AccountCustomization *types.AccountCustomization
// The Amazon Resource Name (ARN) for the updated customization for this Amazon
// Web Services account.
Arn *string
// The ID for the Amazon Web Services account that you want to update Quick Sight
// customizations for.
AwsAccountId *string
// The namespace associated with the customization that you're updating.
Namespace *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateAccountCustomizationOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateAccountCustomizationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateAccountCustomizationOutput) Serialize ¶ added in v1.131.0
func (v *UpdateAccountCustomizationOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAccountCustomizationOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateAccountCustomizationOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAccountSettingsInput ¶
type UpdateAccountSettingsInput struct {
// The ID for the Amazon Web Services account that contains the Quick Sight
// settings that you want to list.
//
// This member is required.
AwsAccountId *string
// The default namespace for this Amazon Web Services account. Currently, the
// default is default . IAM users that register for the first time with Amazon
// Quick Sight provide an email address that becomes associated with the default
// namespace.
//
// This member is required.
DefaultNamespace *string
// The email address that you want Quick Sight to send notifications to regarding
// your Amazon Web Services account or Quick Sight subscription.
NotificationEmail *string
// A boolean value that determines whether or not an Quick Sight account can be
// deleted. A True value doesn't allow the account to be deleted and results in an
// error message if a user tries to make a DeleteAccountSubscription request. A
// False value will allow the account to be deleted.
TerminationProtectionEnabled bool
// contains filtered or unexported fields
}
func (*UpdateAccountSettingsInput) Serialize ¶ added in v1.131.0
func (v *UpdateAccountSettingsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAccountSettingsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateAccountSettingsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAccountSettingsOutput ¶
type UpdateAccountSettingsOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateAccountSettingsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateAccountSettingsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateAccountSettingsOutput) Serialize ¶ added in v1.131.0
func (v *UpdateAccountSettingsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAccountSettingsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateAccountSettingsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateActionConnectorInput ¶ added in v1.95.0
type UpdateActionConnectorInput struct {
// The unique identifier of the action connector to update.
//
// This member is required.
ActionConnectorId *string
// The updated authentication configuration for connecting to the external service.
//
// This member is required.
AuthenticationConfig *types.AuthConfig
// The Amazon Web Services account ID that contains the action connector to update.
//
// This member is required.
AwsAccountId *string
// The new name for the action connector.
//
// This member is required.
Name *string
// The updated description of the action connector.
Description *string
// The updated ARN of the VPC connection to use for secure connectivity.
VpcConnectionArn *string
// contains filtered or unexported fields
}
func (*UpdateActionConnectorInput) Serialize ¶ added in v1.131.0
func (v *UpdateActionConnectorInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateActionConnectorInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateActionConnectorInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateActionConnectorOutput ¶ added in v1.95.0
type UpdateActionConnectorOutput struct {
// The unique identifier of the updated action connector.
ActionConnectorId *string
// The Amazon Resource Name (ARN) of the updated action connector.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status code of the request.
Status int32
// The status of the update operation.
UpdateStatus types.ResourceStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateActionConnectorOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateActionConnectorOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateActionConnectorOutput) Serialize ¶ added in v1.131.0
func (v *UpdateActionConnectorOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateActionConnectorOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateActionConnectorOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateActionConnectorPermissionsInput ¶ added in v1.95.0
type UpdateActionConnectorPermissionsInput struct {
// The unique identifier of the action connector whose permissions you want to
// update.
//
// This member is required.
ActionConnectorId *string
// The Amazon Web Services account ID that contains the action connector.
//
// This member is required.
AwsAccountId *string
// The permissions to grant to users and groups for this action connector.
GrantPermissions []types.ResourcePermission
// The permissions to revoke from users and groups for this action connector.
RevokePermissions []types.ResourcePermission
// contains filtered or unexported fields
}
func (*UpdateActionConnectorPermissionsInput) Serialize ¶ added in v1.131.0
func (v *UpdateActionConnectorPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateActionConnectorPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateActionConnectorPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateActionConnectorPermissionsOutput ¶ added in v1.95.0
type UpdateActionConnectorPermissionsOutput struct {
// The unique identifier of the action connector.
ActionConnectorId *string
// The Amazon Resource Name (ARN) of the action connector.
Arn *string
// The updated permissions configuration for the action connector.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status code of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateActionConnectorPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateActionConnectorPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateActionConnectorPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *UpdateActionConnectorPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateActionConnectorPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateActionConnectorPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAgentInput ¶ added in v1.113.0
type UpdateAgentInput struct {
// The unique identifier for the agent to update.
//
// This member is required.
AgentId *string
// The ID of the Amazon Web Services account that contains the agent.
//
// This member is required.
AwsAccountId *string
// The name of the agent.
//
// This member is required.
Name *string
// The Amazon Resource Names (ARNs) of the action connectors to attach to the
// agent.
ActionConnectorsToAdd []string
// The Amazon Resource Names (ARNs) of the action connectors to detach from the
// agent.
ActionConnectorsToRemove []string
// The custom prompt configuration for the agent.
CustomPromptInput types.CustomPromptInput
// A description of the agent.
Description *string
// The icon identifier for the agent.
IconId *string
// The Amazon Resource Names (ARNs) of the spaces to attach to the agent.
SpacesToAdd []string
// The Amazon Resource Names (ARNs) of the spaces to detach from the agent.
SpacesToRemove []string
// A list of starter prompts that are displayed to users when they begin
// interacting with the agent.
StarterPrompts []string
// The welcome message that is displayed when a user starts a conversation with
// the agent.
WelcomeMessage *string
// contains filtered or unexported fields
}
func (*UpdateAgentInput) Serialize ¶ added in v1.131.0
func (v *UpdateAgentInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAgentInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateAgentInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAgentOutput ¶ added in v1.113.0
type UpdateAgentOutput struct {
// The unique identifier for the agent.
//
// This member is required.
AgentId *string
// The status of the agent.
//
// This member is required.
AgentStatus types.AgentStatus
// The Amazon Resource Name (ARN) of the agent.
//
// This member is required.
Arn *string
// A list of per-ARN failures from the action connectors that were requested to be
// added.
FailedToAddActionConnectors []types.FailedToUpdateAssociation
// A list of per-ARN failures from the spaces that were requested to be added.
FailedToAddSpaces []types.FailedToUpdateAssociation
// A list of per-ARN failures from the action connectors that were requested to be
// removed.
FailedToRemoveActionConnectors []types.FailedToUpdateAssociation
// A list of per-ARN failures from the spaces that were requested to be removed.
FailedToRemoveSpaces []types.FailedToUpdateAssociation
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateAgentOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateAgentOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateAgentOutput) Serialize ¶ added in v1.131.0
func (v *UpdateAgentOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAgentOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateAgentOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAgentPermissionsInput ¶ added in v1.113.0
type UpdateAgentPermissionsInput struct {
// The unique identifier for the agent.
//
// This member is required.
AgentId *string
// The ID of the Amazon Web Services account that contains the agent.
//
// This member is required.
AwsAccountId *string
// The resource permissions that you want to grant on the agent.
GrantPermissions []types.ResourcePermission
// The resource permissions that you want to revoke from the agent.
RevokePermissions []types.ResourcePermission
// contains filtered or unexported fields
}
func (*UpdateAgentPermissionsInput) Serialize ¶ added in v1.131.0
func (v *UpdateAgentPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAgentPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateAgentPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAgentPermissionsOutput ¶ added in v1.113.0
type UpdateAgentPermissionsOutput struct {
// The unique identifier for the agent.
//
// This member is required.
AgentId *string
// The Amazon Resource Name (ARN) of the agent.
//
// This member is required.
Arn *string
// The resource permissions for the agent.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateAgentPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateAgentPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateAgentPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *UpdateAgentPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAgentPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateAgentPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAnalysisInput ¶ added in v0.29.0
type UpdateAnalysisInput struct {
// The ID for the analysis that you're updating. This ID displays in the URL of
// the analysis.
//
// This member is required.
AnalysisId *string
// The ID of the Amazon Web Services account that contains the analysis that
// you're updating.
//
// This member is required.
AwsAccountId *string
// A descriptive name for the analysis that you're updating. This name displays
// for the analysis in the Amazon Quick Sight console.
//
// This member is required.
Name *string
// The definition of an analysis.
//
// A definition is the data model of all features in a Dashboard, Template, or
// Analysis.
Definition *types.AnalysisDefinition
// The parameter names and override values that you want to use. An analysis can
// have any parameter type, and some parameters might accept multiple values.
Parameters *types.Parameters
// A source entity to use for the analysis that you're updating. This metadata
// structure contains details that describe a source template and one or more
// datasets or topics.
SourceEntity *types.AnalysisSourceEntity
// The Amazon Resource Name (ARN) for the theme to apply to the analysis that
// you're creating. To see the theme in the Amazon Quick Sight console, make sure
// that you have access to it.
ThemeArn *string
// The option to relax the validation needed to update an analysis with definition
// objects. This skips the validation step for specific errors.
ValidationStrategy *types.ValidationStrategy
// contains filtered or unexported fields
}
func (*UpdateAnalysisInput) Serialize ¶ added in v1.131.0
func (v *UpdateAnalysisInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAnalysisInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateAnalysisInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAnalysisOutput ¶ added in v0.29.0
type UpdateAnalysisOutput struct {
// The ID of the analysis.
AnalysisId *string
// The ARN of the analysis that you're updating.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The update status of the last update that was made to the analysis.
UpdateStatus types.ResourceStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateAnalysisOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateAnalysisOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateAnalysisOutput) Serialize ¶ added in v1.131.0
func (v *UpdateAnalysisOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAnalysisOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateAnalysisOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAnalysisPermissionsInput ¶ added in v0.29.0
type UpdateAnalysisPermissionsInput struct {
// The ID of the analysis whose permissions you're updating. The ID is part of the
// analysis URL.
//
// This member is required.
AnalysisId *string
// The ID of the Amazon Web Services account that contains the analysis whose
// permissions you're updating. You must be using the Amazon Web Services account
// that the analysis is in.
//
// This member is required.
AwsAccountId *string
// A structure that describes the permissions to add and the principal to add them
// to.
GrantPermissions []types.ResourcePermission
// A structure that describes the permissions to remove and the principal to
// remove them from.
RevokePermissions []types.ResourcePermission
// contains filtered or unexported fields
}
func (*UpdateAnalysisPermissionsInput) Serialize ¶ added in v1.131.0
func (v *UpdateAnalysisPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAnalysisPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateAnalysisPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAnalysisPermissionsOutput ¶ added in v0.29.0
type UpdateAnalysisPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the analysis that you updated.
AnalysisArn *string
// The ID of the analysis that you updated permissions for.
AnalysisId *string
// A structure that describes the principals and the resource-level permissions on
// an analysis.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateAnalysisPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateAnalysisPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateAnalysisPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *UpdateAnalysisPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAnalysisPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateAnalysisPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAppPermissionsInput ¶ added in v1.127.0
type UpdateAppPermissionsInput struct {
// The ID of the app.
//
// This member is required.
AppId *string
// The ID of the Amazon Web Services account that contains the app.
//
// This member is required.
AwsAccountId *string
// The permissions that you want to grant on the app.
GrantPermissions []types.ResourcePermission
// The permissions that you want to revoke from the app.
RevokePermissions []types.ResourcePermission
// The visibility to set for the app. Currently, only PRIVATE is accepted, which
// removes public (anonymous) access from the app. If you don't specify a value,
// the app's visibility is unchanged. Setting an app to PUBLIC through this
// operation is not supported.
Visibility types.AppVisibility
// contains filtered or unexported fields
}
func (*UpdateAppPermissionsInput) Serialize ¶ added in v1.131.0
func (v *UpdateAppPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAppPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateAppPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateAppPermissionsOutput ¶ added in v1.127.0
type UpdateAppPermissionsOutput struct {
// The ID of the app.
AppId *string
// The Amazon Resource Name (ARN) of the app.
Arn *string
// The updated resource permissions for the app.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The visibility of the app after the update ( PRIVATE or PUBLIC ).
Visibility types.AppVisibility
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateAppPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateAppPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateAppPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *UpdateAppPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateAppPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateAppPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateApplicationWithTokenExchangeGrantInput ¶ added in v1.81.0
type UpdateApplicationWithTokenExchangeGrantInput struct {
// The ID of the Amazon Web Services account to be updated with a token exchange
// grant.
//
// This member is required.
AwsAccountId *string
// The namespace of the Quick application.
//
// This member is required.
Namespace *string
// contains filtered or unexported fields
}
func (*UpdateApplicationWithTokenExchangeGrantInput) Serialize ¶ added in v1.131.0
func (v *UpdateApplicationWithTokenExchangeGrantInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateApplicationWithTokenExchangeGrantInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateApplicationWithTokenExchangeGrantInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateApplicationWithTokenExchangeGrantOutput ¶ added in v1.81.0
type UpdateApplicationWithTokenExchangeGrantOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateApplicationWithTokenExchangeGrantOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateApplicationWithTokenExchangeGrantOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateApplicationWithTokenExchangeGrantOutput) Serialize ¶ added in v1.131.0
func (v *UpdateApplicationWithTokenExchangeGrantOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateApplicationWithTokenExchangeGrantOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateApplicationWithTokenExchangeGrantOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateApprovalPolicyInput ¶ added in v1.124.0
type UpdateApprovalPolicyInput struct {
// The unique identifier of the approval policy to update.
//
// This member is required.
PolicyId *string
// The list of governed actions that trigger the approval workflow.
Actions []types.GovernedAction
// The scoping configuration that determines who the approval policy applies to.
ApplicableTo *types.ApplicableTo
// The list of group ARNs whose members can approve requests.
ApprovalGroups []string
// The list of asset types that the approval policy applies to.
AssetTypes []types.AssetType
// A description of the approval policy.
Description *string
// The name of the approval policy.
Name *string
// contains filtered or unexported fields
}
func (*UpdateApprovalPolicyInput) Serialize ¶ added in v1.131.0
func (v *UpdateApprovalPolicyInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateApprovalPolicyInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateApprovalPolicyInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateApprovalPolicyOutput ¶ added in v1.124.0
type UpdateApprovalPolicyOutput struct {
// The updated approval policy.
//
// This member is required.
Policy *types.ApprovalPolicy
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateApprovalPolicyOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateApprovalPolicyOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateApprovalPolicyOutput) Serialize ¶ added in v1.131.0
func (v *UpdateApprovalPolicyOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateApprovalPolicyOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateApprovalPolicyOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateBrandAssignmentInput ¶ added in v1.79.0
type UpdateBrandAssignmentInput struct {
// The ID of the Amazon Web Services account that owns the brand assignment.
//
// This member is required.
AwsAccountId *string
// The Amazon Resource Name (ARN) of the brand.
//
// This member is required.
BrandArn *string
// contains filtered or unexported fields
}
func (*UpdateBrandAssignmentInput) Serialize ¶ added in v1.131.0
func (v *UpdateBrandAssignmentInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateBrandAssignmentInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateBrandAssignmentInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateBrandAssignmentOutput ¶ added in v1.79.0
type UpdateBrandAssignmentOutput struct {
// The Amazon Resource Name (ARN) of the brand.
BrandArn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateBrandAssignmentOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateBrandAssignmentOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateBrandAssignmentOutput) Serialize ¶ added in v1.131.0
func (v *UpdateBrandAssignmentOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateBrandAssignmentOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateBrandAssignmentOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateBrandInput ¶ added in v1.79.0
type UpdateBrandInput struct {
// The ID of the Amazon Web Services account that owns the brand.
//
// This member is required.
AwsAccountId *string
// The ID of the Quick brand.
//
// This member is required.
BrandId *string
// The definition of the brand.
BrandDefinition *types.BrandDefinition
// contains filtered or unexported fields
}
func (*UpdateBrandInput) Serialize ¶ added in v1.131.0
func (v *UpdateBrandInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateBrandInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateBrandInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateBrandOutput ¶ added in v1.79.0
type UpdateBrandOutput struct {
// The definition of the brand.
BrandDefinition *types.BrandDefinition
// The details of the brand.
BrandDetail *types.BrandDetail
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateBrandOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateBrandOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateBrandOutput) Serialize ¶ added in v1.131.0
func (v *UpdateBrandOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateBrandOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateBrandOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateBrandPublishedVersionInput ¶ added in v1.79.0
type UpdateBrandPublishedVersionInput struct {
// The ID of the Amazon Web Services account that owns the brand.
//
// This member is required.
AwsAccountId *string
// The ID of the Quick brand.
//
// This member is required.
BrandId *string
// The ID of the published version.
//
// This member is required.
VersionId *string
// contains filtered or unexported fields
}
func (*UpdateBrandPublishedVersionInput) Serialize ¶ added in v1.131.0
func (v *UpdateBrandPublishedVersionInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateBrandPublishedVersionInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateBrandPublishedVersionInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateBrandPublishedVersionOutput ¶ added in v1.79.0
type UpdateBrandPublishedVersionOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The ID of the published version.
VersionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateBrandPublishedVersionOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateBrandPublishedVersionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateBrandPublishedVersionOutput) Serialize ¶ added in v1.131.0
func (v *UpdateBrandPublishedVersionOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateBrandPublishedVersionOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateBrandPublishedVersionOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateCustomPermissionsInput ¶ added in v1.79.0
type UpdateCustomPermissionsInput struct {
// The ID of the Amazon Web Services account that contains the custom permissions
// profile that you want to update.
//
// This member is required.
AwsAccountId *string
// The name of the custom permissions profile that you want to update.
//
// This member is required.
CustomPermissionsName *string
// A set of actions to include in the custom permissions profile.
Capabilities *types.Capabilities
// The governance configuration for the custom permissions profile. The
// UpdateCustomPermissions operation replaces all existing Capabilities and
// Governance values. If you omit this parameter, Amazon Quick removes governance
// from the profile and the existing custom permission behavior applies.
Governance *types.Governance
// contains filtered or unexported fields
}
func (*UpdateCustomPermissionsInput) Serialize ¶ added in v1.131.0
func (v *UpdateCustomPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateCustomPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateCustomPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateCustomPermissionsOutput ¶ added in v1.79.0
type UpdateCustomPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the custom permissions profile.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateCustomPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateCustomPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateCustomPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *UpdateCustomPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateCustomPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateCustomPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDashboardInput ¶
type UpdateDashboardInput struct {
// The ID of the Amazon Web Services account that contains the dashboard that
// you're updating.
//
// This member is required.
AwsAccountId *string
// The ID for the dashboard.
//
// This member is required.
DashboardId *string
// The display name of the dashboard.
//
// This member is required.
Name *string
// Options for publishing the dashboard when you create it:
//
// - AvailabilityStatus for AdHocFilteringOption - This status can be either
// ENABLED or DISABLED . When this is set to DISABLED , Amazon Quick Sight
// disables the left filter pane on the published dashboard, which can be used for
// ad hoc (one-time) filtering. This option is ENABLED by default.
//
// - AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED
// or DISABLED . The visual option to export data to .CSV format isn't enabled
// when this is set to DISABLED . This option is ENABLED by default.
//
// - VisibilityState for SheetControlsOption - This visibility state can be
// either COLLAPSED or EXPANDED . This option is COLLAPSED by default.
//
// - AvailabilityStatus for QuickSuiteActionsOption - This status can be either
// ENABLED or DISABLED . Features related to Actions in Amazon Quick Suite on
// dashboards are disabled when this is set to DISABLED . This option is DISABLED
// by default.
//
// - AvailabilityStatus for ExecutiveSummaryOption - This status can be either
// ENABLED or DISABLED . The option to build an executive summary is disabled
// when this is set to DISABLED . This option is ENABLED by default.
//
// - AvailabilityStatus for DataStoriesSharingOption - This status can be either
// ENABLED or DISABLED . The option to share a data story is disabled when this
// is set to DISABLED . This option is ENABLED by default.
DashboardPublishOptions *types.DashboardPublishOptions
// The definition of a dashboard.
//
// A definition is the data model of all features in a Dashboard, Template, or
// Analysis.
Definition *types.DashboardVersionDefinition
// A structure that contains the parameters of the dashboard. These are parameter
// overrides for a dashboard. A dashboard can have any type of parameters, and some
// parameters might accept multiple values.
Parameters *types.Parameters
// The entity that you are using as a source when you update the dashboard. In
// SourceEntity , you specify the type of object you're using as source. You can
// only update a dashboard from a template, so you use a SourceTemplate entity. If
// you need to update a dashboard from an analysis, first convert the analysis to a
// template by using the [CreateTemplate]API operation. For SourceTemplate , specify the Amazon
// Resource Name (ARN) of the source template. The SourceTemplate ARN can contain
// any Amazon Web Services account and any Amazon Quick Sight-supported Amazon Web
// Services Region.
//
// Use the DataSetReferences entity within SourceTemplate to list the replacement
// datasets for the placeholders listed in the original. The schema in each dataset
// must match its placeholder. Use the TopicReferences entity to list the
// replacement topics for the topic placeholders listed in the original. The schema
// in each topic must match its placeholder.
//
// [CreateTemplate]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html
SourceEntity *types.DashboardSourceEntity
// The Amazon Resource Name (ARN) of the theme that is being used for this
// dashboard. If you add a value for this field, it overrides the value that was
// originally associated with the entity. The theme ARN must exist in the same
// Amazon Web Services account where you create the dashboard.
ThemeArn *string
// The option to relax the validation needed to update a dashboard with definition
// objects. This skips the validation step for specific errors.
ValidationStrategy *types.ValidationStrategy
// A description for the first version of the dashboard being created.
VersionDescription *string
// contains filtered or unexported fields
}
func (*UpdateDashboardInput) Serialize ¶ added in v1.131.0
func (v *UpdateDashboardInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDashboardInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDashboardInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDashboardLinksInput ¶ added in v1.54.0
type UpdateDashboardLinksInput struct {
// The ID of the Amazon Web Services account that contains the dashboard whose
// links you want to update.
//
// This member is required.
AwsAccountId *string
// The ID for the dashboard.
//
// This member is required.
DashboardId *string
// list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
//
// This member is required.
LinkEntities []string
// contains filtered or unexported fields
}
func (*UpdateDashboardLinksInput) Serialize ¶ added in v1.131.0
func (v *UpdateDashboardLinksInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDashboardLinksInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDashboardLinksInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDashboardLinksOutput ¶ added in v1.54.0
type UpdateDashboardLinksOutput struct {
// The Amazon Resource Name (ARN) of the dashboard.
DashboardArn *string
// A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
LinkEntities []string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateDashboardLinksOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateDashboardLinksOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateDashboardLinksOutput) Serialize ¶ added in v1.131.0
func (v *UpdateDashboardLinksOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDashboardLinksOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDashboardLinksOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDashboardOutput ¶
type UpdateDashboardOutput struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// The creation status of the request.
CreationStatus types.ResourceStatus
// The ID for the dashboard.
DashboardId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ARN of the dashboard, including the version number.
VersionArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateDashboardOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateDashboardOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateDashboardOutput) Serialize ¶ added in v1.131.0
func (v *UpdateDashboardOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDashboardOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDashboardOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDashboardPermissionsInput ¶
type UpdateDashboardPermissionsInput struct {
// The ID of the Amazon Web Services account that contains the dashboard whose
// permissions you're updating.
//
// This member is required.
AwsAccountId *string
// The ID for the dashboard.
//
// This member is required.
DashboardId *string
// Grants link permissions to all users in a defined namespace.
GrantLinkPermissions []types.ResourcePermission
// The permissions that you want to grant on this resource.
GrantPermissions []types.ResourcePermission
// Revokes link permissions from all users in a defined namespace.
RevokeLinkPermissions []types.ResourcePermission
// The permissions that you want to revoke from this resource.
RevokePermissions []types.ResourcePermission
// contains filtered or unexported fields
}
func (*UpdateDashboardPermissionsInput) Serialize ¶ added in v1.131.0
func (v *UpdateDashboardPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDashboardPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDashboardPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDashboardPermissionsOutput ¶
type UpdateDashboardPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the dashboard.
DashboardArn *string
// The ID for the dashboard.
DashboardId *string
// Updates the permissions of a shared link to an Quick Sight dashboard.
LinkSharingConfiguration *types.LinkSharingConfiguration
// Information about the permissions on the dashboard.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateDashboardPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateDashboardPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateDashboardPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *UpdateDashboardPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDashboardPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDashboardPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDashboardPublishedVersionInput ¶
type UpdateDashboardPublishedVersionInput struct {
// The ID of the Amazon Web Services account that contains the dashboard that
// you're updating.
//
// This member is required.
AwsAccountId *string
// The ID for the dashboard.
//
// This member is required.
DashboardId *string
// The version number of the dashboard.
//
// This member is required.
VersionNumber *int64
// contains filtered or unexported fields
}
func (*UpdateDashboardPublishedVersionInput) Serialize ¶ added in v1.131.0
func (v *UpdateDashboardPublishedVersionInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDashboardPublishedVersionInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDashboardPublishedVersionInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDashboardPublishedVersionOutput ¶
type UpdateDashboardPublishedVersionOutput struct {
// The Amazon Resource Name (ARN) of the dashboard.
DashboardArn *string
// The ID for the dashboard.
DashboardId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateDashboardPublishedVersionOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateDashboardPublishedVersionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateDashboardPublishedVersionOutput) Serialize ¶ added in v1.131.0
func (v *UpdateDashboardPublishedVersionOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDashboardPublishedVersionOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDashboardPublishedVersionOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDashboardsQAConfigurationInput ¶ added in v1.80.0
type UpdateDashboardsQAConfigurationInput struct {
// The ID of the Amazon Web Services account that contains the dashboard QA
// configuration that you want to update.
//
// This member is required.
AwsAccountId *string
// The status of dashboards QA configuration that you want to update.
//
// This member is required.
DashboardsQAStatus types.DashboardsQAStatus
// contains filtered or unexported fields
}
func (*UpdateDashboardsQAConfigurationInput) Serialize ¶ added in v1.131.0
func (v *UpdateDashboardsQAConfigurationInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDashboardsQAConfigurationInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDashboardsQAConfigurationInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDashboardsQAConfigurationOutput ¶ added in v1.80.0
type UpdateDashboardsQAConfigurationOutput struct {
// A value that indicates whether the dashboard QA configuration is enabled or not.
DashboardsQAStatus types.DashboardsQAStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateDashboardsQAConfigurationOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateDashboardsQAConfigurationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateDashboardsQAConfigurationOutput) Serialize ¶ added in v1.131.0
func (v *UpdateDashboardsQAConfigurationOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDashboardsQAConfigurationOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDashboardsQAConfigurationOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDataSetInput ¶
type UpdateDataSetInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID for the dataset that you want to update. This ID is unique per Amazon
// Web Services Region for each Amazon Web Services account.
//
// This member is required.
DataSetId *string
// Indicates whether you want to import the data into SPICE.
//
// This member is required.
ImportMode types.DataSetImportMode
// The display name for the dataset.
//
// This member is required.
Name *string
// Declares the physical tables that are available in the underlying data sources.
//
// This member is required.
PhysicalTableMap map[string]types.PhysicalTable
// Groupings of columns that work together in certain Amazon Quick Sight features.
// Currently, only geospatial hierarchy is supported.
ColumnGroups []types.ColumnGroup
// A set of one or more definitions of a [ColumnLevelPermissionRule].
//
// [ColumnLevelPermissionRule]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html
ColumnLevelPermissionRules []types.ColumnLevelPermissionRule
// The data preparation configuration for the dataset. This configuration defines
// the source tables, transformation steps, and destination tables used to prepare
// the data. Required when using the new data preparation experience.
DataPrepConfiguration *types.DataPrepConfiguration
// The usage configuration to apply to child datasets that reference this dataset
// as a source.
DataSetUsageConfiguration *types.DataSetUsageConfiguration
// The parameter declarations of the dataset.
DatasetParameters []types.DatasetParameter
// The folder that contains fields and nested subfolders for your dataset.
FieldFolders map[string]types.FieldFolder
// Configures the combination and transformation of the data from the physical
// tables. This parameter is used with the legacy data preparation experience.
//
// Deprecated: Only used in the legacy data preparation experience.
LogicalTableMap map[string]types.LogicalTable
// The configuration for the performance optimization of the dataset that contains
// a UniqueKey configuration.
PerformanceConfiguration *types.PerformanceConfiguration
// The row-level security configuration for the data you want to create. This
// parameter is used with the legacy data preparation experience.
//
// Deprecated: Only used in the legacy data preparation experience.
RowLevelPermissionDataSet *types.RowLevelPermissionDataSet
// The configuration of tags on a dataset to set row-level security. Row-level
// security tags are currently supported for anonymous embedding only. This
// parameter is used with the legacy data preparation experience.
//
// Deprecated: Only used in the legacy data preparation experience.
RowLevelPermissionTagConfiguration *types.RowLevelPermissionTagConfiguration
// The semantic model configuration for the dataset. This configuration defines
// how the prepared data is structured for an analysis, including table mappings
// and row-level security configurations. Required when using the new data
// preparation experience.
SemanticModelConfiguration *types.SemanticModelConfiguration
// contains filtered or unexported fields
}
func (*UpdateDataSetInput) Serialize ¶ added in v1.131.0
func (v *UpdateDataSetInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDataSetInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDataSetInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDataSetOutput ¶
type UpdateDataSetOutput struct {
// The Amazon Resource Name (ARN) of the dataset.
Arn *string
// The ID for the dataset that you want to update. This ID is unique per Amazon
// Web Services Region for each Amazon Web Services account.
DataSetId *string
// The ARN for the ingestion, which is triggered as a result of dataset creation
// if the import mode is SPICE.
IngestionArn *string
// The ID of the ingestion, which is triggered as a result of dataset creation if
// the import mode is SPICE.
IngestionId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateDataSetOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateDataSetOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateDataSetOutput) Serialize ¶ added in v1.131.0
func (v *UpdateDataSetOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDataSetOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDataSetOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDataSetPermissionsInput ¶
type UpdateDataSetPermissionsInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID for the dataset whose permissions you want to update. This ID is unique
// per Amazon Web Services Region for each Amazon Web Services account.
//
// This member is required.
DataSetId *string
// The resource permissions that you want to grant to the dataset.
GrantPermissions []types.ResourcePermission
// The resource permissions that you want to revoke from the dataset.
RevokePermissions []types.ResourcePermission
// contains filtered or unexported fields
}
func (*UpdateDataSetPermissionsInput) Serialize ¶ added in v1.131.0
func (v *UpdateDataSetPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDataSetPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDataSetPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDataSetPermissionsOutput ¶
type UpdateDataSetPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the dataset.
DataSetArn *string
// The ID for the dataset whose permissions you want to update. This ID is unique
// per Amazon Web Services Region for each Amazon Web Services account.
DataSetId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateDataSetPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateDataSetPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateDataSetPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *UpdateDataSetPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDataSetPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDataSetPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDataSourceInput ¶
type UpdateDataSourceInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
//
// This member is required.
DataSourceId *string
// A display name for the data source.
//
// This member is required.
Name *string
// The credentials that Amazon Quick Sight that uses to connect to your underlying
// source. Currently, only credentials based on user name and password are
// supported.
Credentials *types.DataSourceCredentials
// The parameters that Amazon Quick Sight uses to connect to your underlying
// source.
DataSourceParameters types.DataSourceParameters
// Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight
// connects to your underlying source.
SslProperties *types.SslProperties
// Use this parameter only when you want Amazon Quick Sight to use a VPC
// connection when connecting to your underlying source.
VpcConnectionProperties *types.VpcConnectionProperties
// contains filtered or unexported fields
}
func (*UpdateDataSourceInput) Serialize ¶ added in v1.131.0
func (v *UpdateDataSourceInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDataSourceInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDataSourceInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDataSourceOutput ¶
type UpdateDataSourceOutput struct {
// The Amazon Resource Name (ARN) of the data source.
Arn *string
// The ID of the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
DataSourceId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The update status of the data source's last update.
UpdateStatus types.ResourceStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateDataSourceOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateDataSourceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateDataSourceOutput) Serialize ¶ added in v1.131.0
func (v *UpdateDataSourceOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDataSourceOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDataSourceOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDataSourcePermissionsInput ¶
type UpdateDataSourcePermissionsInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
//
// This member is required.
DataSourceId *string
// A list of resource permissions that you want to grant on the data source.
GrantPermissions []types.ResourcePermission
// A list of resource permissions that you want to revoke on the data source.
RevokePermissions []types.ResourcePermission
// contains filtered or unexported fields
}
func (*UpdateDataSourcePermissionsInput) Serialize ¶ added in v1.131.0
func (v *UpdateDataSourcePermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDataSourcePermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDataSourcePermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDataSourcePermissionsOutput ¶
type UpdateDataSourcePermissionsOutput struct {
// The Amazon Resource Name (ARN) of the data source.
DataSourceArn *string
// The ID of the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
DataSourceId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateDataSourcePermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateDataSourcePermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateDataSourcePermissionsOutput) Serialize ¶ added in v1.131.0
func (v *UpdateDataSourcePermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDataSourcePermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDataSourcePermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDefaultQBusinessApplicationInput ¶ added in v1.81.0
type UpdateDefaultQBusinessApplicationInput struct {
// The ID of the Amazon Q Business application that you want to update.
//
// This member is required.
ApplicationId *string
// The ID of the Quick Sight account that is connected to the Amazon Q Business
// application that you want to update.
//
// This member is required.
AwsAccountId *string
// 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.
Namespace *string
// contains filtered or unexported fields
}
func (*UpdateDefaultQBusinessApplicationInput) Serialize ¶ added in v1.131.0
func (v *UpdateDefaultQBusinessApplicationInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDefaultQBusinessApplicationInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDefaultQBusinessApplicationInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDefaultQBusinessApplicationOutput ¶ added in v1.81.0
type UpdateDefaultQBusinessApplicationOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateDefaultQBusinessApplicationOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateDefaultQBusinessApplicationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateDefaultQBusinessApplicationOutput) Serialize ¶ added in v1.131.0
func (v *UpdateDefaultQBusinessApplicationOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDefaultQBusinessApplicationOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDefaultQBusinessApplicationOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDlpSettingInput ¶ added in v1.124.0
type UpdateDlpSettingInput struct {
// The ID of the Amazon Web Services account that contains the DLP setting that
// you want to update.
//
// This member is required.
AwsAccountId *string
// The ID of the DLP setting that you want to update.
//
// This member is required.
DlpSettingId *string
// Specifies whether DLP enforcement is active for this setting. Set to true to
// enable enforcement, or false to disable it.
Enabled *bool
// An updated display name for the DLP setting.
Name *string
// An updated provider-specific configuration for the DLP integration. This is a
// union type structure. For this structure to be valid, only one of the attributes
// can be defined.
ProviderConfig types.ProviderConfig
// An updated behavior to apply when the DLP provider is unreachable. Valid values
// are ALLOW , WARN , and BLOCK .
ProviderOutageAction types.DlpAction
// An updated DLP provider type. Currently, the only supported value is
// MICROSOFT_PURVIEW .
ProviderType types.DlpProviderType
// contains filtered or unexported fields
}
func (*UpdateDlpSettingInput) Serialize ¶ added in v1.131.0
func (v *UpdateDlpSettingInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDlpSettingInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDlpSettingInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateDlpSettingOutput ¶ added in v1.124.0
type UpdateDlpSettingOutput struct {
// The Amazon Resource Name (ARN) of the updated DLP setting.
//
// This member is required.
Arn *string
// The ID of the updated DLP setting.
//
// This member is required.
DlpSettingId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateDlpSettingOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateDlpSettingOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateDlpSettingOutput) Serialize ¶ added in v1.131.0
func (v *UpdateDlpSettingOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateDlpSettingOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateDlpSettingOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateFlowInput ¶ added in v1.113.0
type UpdateFlowInput struct {
// The ID of the Amazon Web Services account that contains the flow that you are
// updating.
//
// This member is required.
AwsAccountId *string
// The unique identifier of the flow to update.
//
// This member is required.
FlowId *string
// A unique, case-sensitive identifier that you provide to ensure the idempotency
// of the request.
ClientToken *string
// Updated description for the flow. Omit to preserve the existing description.
Description *string
// 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. When provided, all existing steps are replaced. Omit to preserve the
// existing definition.
//
// Always derive or depend on the flow definition from the DescribeFlow operation
// to ensure you are working with the latest format.
FlowDefinition document.Interface
// Updated display name for the flow. Omit to preserve the existing name.
Name *string
// contains filtered or unexported fields
}
func (*UpdateFlowInput) Serialize ¶ added in v1.131.0
func (v *UpdateFlowInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateFlowInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateFlowInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateFlowOutput ¶ added in v1.113.0
type UpdateFlowOutput struct {
// The Amazon Resource Name (ARN) of the flow.
//
// This member is required.
Arn *string
// The unique identifier of the flow.
//
// This member is required.
FlowId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateFlowOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateFlowOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateFlowOutput) Serialize ¶ added in v1.131.0
func (v *UpdateFlowOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateFlowOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateFlowOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateFlowPermissionsInput ¶ added in v1.95.0
type UpdateFlowPermissionsInput struct {
// The ID of the Amazon Web Services account that contains the flow you are
// updating permissions against.
//
// This member is required.
AwsAccountId *string
// The unique identifier of the flow to update permissions for.
//
// This member is required.
FlowId *string
// The permissions that you want to grant on this flow.
GrantPermissions []types.Permission
// The permissions that you want to revoke from this flow.
RevokePermissions []types.Permission
// contains filtered or unexported fields
}
func (*UpdateFlowPermissionsInput) Serialize ¶ added in v1.131.0
func (v *UpdateFlowPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateFlowPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateFlowPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateFlowPermissionsOutput ¶ added in v1.95.0
type UpdateFlowPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the flow you are updating permissions against.
//
// This member is required.
Arn *string
// The unique identifier of the flow with updated permissions.
//
// This member is required.
FlowId *string
// The permissions on the flow after they are updated.
//
// This member is required.
Permissions []types.Permission
// The Amazon Web Services request ID for this operation.
//
// This member is required.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateFlowPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateFlowPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateFlowPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *UpdateFlowPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateFlowPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateFlowPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateFolderInput ¶ added in v1.6.0
type UpdateFolderInput struct {
// The ID for the Amazon Web Services account that contains the folder to update.
//
// This member is required.
AwsAccountId *string
// The ID of the folder.
//
// This member is required.
FolderId *string
// The name of the folder.
//
// This member is required.
Name *string
// contains filtered or unexported fields
}
func (*UpdateFolderInput) Serialize ¶ added in v1.131.0
func (v *UpdateFolderInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateFolderInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateFolderInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateFolderOutput ¶ added in v1.6.0
type UpdateFolderOutput struct {
// The Amazon Resource Name (ARN) of the folder.
Arn *string
// The ID of the folder.
FolderId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateFolderOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateFolderOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateFolderOutput) Serialize ¶ added in v1.131.0
func (v *UpdateFolderOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateFolderOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateFolderOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateFolderPermissionsInput ¶ added in v1.6.0
type UpdateFolderPermissionsInput struct {
// The ID for the Amazon Web Services account that contains the folder to update.
//
// This member is required.
AwsAccountId *string
// The ID of the folder.
//
// This member is required.
FolderId *string
// The permissions that you want to grant on a resource. Namespace ARNs are not
// supported Principal values for folder permissions.
GrantPermissions []types.ResourcePermission
// The permissions that you want to revoke from a resource. Namespace ARNs are not
// supported Principal values for folder permissions.
RevokePermissions []types.ResourcePermission
// contains filtered or unexported fields
}
func (*UpdateFolderPermissionsInput) Serialize ¶ added in v1.131.0
func (v *UpdateFolderPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateFolderPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateFolderPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateFolderPermissionsOutput ¶ added in v1.6.0
type UpdateFolderPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the folder.
Arn *string
// The ID of the folder.
FolderId *string
// Information about the permissions for the folder.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateFolderPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateFolderPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateFolderPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *UpdateFolderPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateFolderPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateFolderPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateGroupInput ¶
type UpdateGroupInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The name of the group that you want to update.
//
// This member is required.
GroupName *string
// The namespace of the group that you want to update.
//
// This member is required.
Namespace *string
// The description for the group that you want to update.
Description *string
// contains filtered or unexported fields
}
func (*UpdateGroupInput) Serialize ¶ added in v1.131.0
func (v *UpdateGroupInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateGroupInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateGroupInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateGroupOutput ¶
type UpdateGroupOutput struct {
// The name of the group.
Group *types.Group
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateGroupOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateGroupOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateGroupOutput) Serialize ¶ added in v1.131.0
func (v *UpdateGroupOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateGroupOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateGroupOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateIAMPolicyAssignmentInput ¶
type UpdateIAMPolicyAssignmentInput struct {
// The name of the assignment, also called a rule. The name must be unique within
// the Amazon Web Services account.
//
// This member is required.
AssignmentName *string
// The ID of the Amazon Web Services account that contains the IAM policy
// assignment.
//
// This member is required.
AwsAccountId *string
// The namespace of the assignment.
//
// This member is required.
Namespace *string
// The status of the assignment. Possible values are as follows:
//
// - ENABLED - Anything specified in this assignment is used when creating the
// data source.
//
// - DISABLED - This assignment isn't used when creating the data source.
//
// - DRAFT - This assignment is an unfinished draft and isn't used when creating
// the data source.
AssignmentStatus types.AssignmentStatus
// The Amazon Quick Sight users, groups, or both that you want to assign the
// policy to.
Identities map[string][]string
// The ARN for the IAM policy to apply to the Amazon Quick Sight users and groups
// specified in this assignment.
PolicyArn *string
// contains filtered or unexported fields
}
func (*UpdateIAMPolicyAssignmentInput) Serialize ¶ added in v1.131.0
func (v *UpdateIAMPolicyAssignmentInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateIAMPolicyAssignmentInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateIAMPolicyAssignmentInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateIAMPolicyAssignmentOutput ¶
type UpdateIAMPolicyAssignmentOutput struct {
// The ID of the assignment.
AssignmentId *string
// The name of the assignment or rule.
AssignmentName *string
// The status of the assignment. Possible values are as follows:
//
// - ENABLED - Anything specified in this assignment is used when creating the
// data source.
//
// - DISABLED - This assignment isn't used when creating the data source.
//
// - DRAFT - This assignment is an unfinished draft and isn't used when creating
// the data source.
AssignmentStatus types.AssignmentStatus
// The Amazon Quick Sight users, groups, or both that the IAM policy is assigned
// to.
Identities map[string][]string
// The ARN for the IAM policy applied to the Amazon Quick Sight users and groups
// specified in this assignment.
PolicyArn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateIAMPolicyAssignmentOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateIAMPolicyAssignmentOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateIAMPolicyAssignmentOutput) Serialize ¶ added in v1.131.0
func (v *UpdateIAMPolicyAssignmentOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateIAMPolicyAssignmentOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateIAMPolicyAssignmentOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateIdentityPropagationConfigInput ¶ added in v1.52.0
type UpdateIdentityPropagationConfigInput struct {
// The ID of the Amazon Web Services account that contains the identity
// propagation configuration that you want to update.
//
// This member is required.
AwsAccountId *string
// The name of the Amazon Web Services service that contains the authorized
// targets that you want to add or update.
//
// This member is required.
Service types.ServiceType
// Specifies a list of application ARNs that represent the authorized targets for
// a service.
AuthorizedTargets []string
// contains filtered or unexported fields
}
func (*UpdateIdentityPropagationConfigInput) Serialize ¶ added in v1.131.0
func (v *UpdateIdentityPropagationConfigInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateIdentityPropagationConfigInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateIdentityPropagationConfigInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateIdentityPropagationConfigOutput ¶ added in v1.52.0
type UpdateIdentityPropagationConfigOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateIdentityPropagationConfigOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateIdentityPropagationConfigOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateIdentityPropagationConfigOutput) Serialize ¶ added in v1.131.0
func (v *UpdateIdentityPropagationConfigOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateIdentityPropagationConfigOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateIdentityPropagationConfigOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateIpRestrictionInput ¶ added in v1.13.0
type UpdateIpRestrictionInput struct {
// The ID of the Amazon Web Services account that contains the IP rules.
//
// This member is required.
AwsAccountId *string
// A value that specifies whether IP rules are turned on.
Enabled *bool
// A map that describes the updated IP rules with CIDR ranges and descriptions.
IpRestrictionRuleMap map[string]string
// A map of allowed VPC endpoint IDs and their corresponding rule descriptions.
VpcEndpointIdRestrictionRuleMap map[string]string
// A map of VPC IDs and their corresponding rules. When you configure this
// parameter, traffic from all VPC endpoints that are present in the specified VPC
// is allowed.
VpcIdRestrictionRuleMap map[string]string
// contains filtered or unexported fields
}
func (*UpdateIpRestrictionInput) Serialize ¶ added in v1.131.0
func (v *UpdateIpRestrictionInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateIpRestrictionInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateIpRestrictionInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateIpRestrictionOutput ¶ added in v1.13.0
type UpdateIpRestrictionOutput struct {
// The ID of the Amazon Web Services account that contains the IP rules.
AwsAccountId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateIpRestrictionOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateIpRestrictionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateIpRestrictionOutput) Serialize ¶ added in v1.131.0
func (v *UpdateIpRestrictionOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateIpRestrictionOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateIpRestrictionOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateKeyRegistrationInput ¶ added in v1.64.0
type UpdateKeyRegistrationInput struct {
// The ID of the Amazon Web Services account that contains the customer managed
// key registration that you want to update.
//
// This member is required.
AwsAccountId *string
// A list of RegisteredCustomerManagedKey objects to be updated to the Quick Sight
// account.
//
// This member is required.
KeyRegistration []types.RegisteredCustomerManagedKey
// contains filtered or unexported fields
}
func (*UpdateKeyRegistrationInput) Serialize ¶ added in v1.131.0
func (v *UpdateKeyRegistrationInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateKeyRegistrationInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateKeyRegistrationInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateKeyRegistrationOutput ¶ added in v1.64.0
type UpdateKeyRegistrationOutput struct {
// A list of all customer managed key registrations that failed to update.
FailedKeyRegistration []types.FailedKeyRegistrationEntry
// The Amazon Web Services request ID for this operation.
RequestId *string
// A list of all customer managed key registrations that were successfully updated.
SuccessfulKeyRegistration []types.SuccessfulKeyRegistrationEntry
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateKeyRegistrationOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateKeyRegistrationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateKeyRegistrationOutput) Serialize ¶ added in v1.131.0
func (v *UpdateKeyRegistrationOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateKeyRegistrationOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateKeyRegistrationOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateKnowledgeBaseInput ¶ added in v1.118.0
type UpdateKnowledgeBaseInput struct {
// The ID of the Amazon Web Services account that contains the knowledge base.
//
// This member is required.
AwsAccountId *string
// The unique identifier for the knowledge base.
//
// This member is required.
KnowledgeBaseId *string
// The access control configuration for the knowledge base. If you don't specify
// this parameter, the existing setting is retained.
AccessControlConfiguration *types.AccessControlConfiguration
// A description for the knowledge base. If you don't specify a description, the
// existing description is retained.
Description *string
// Specifies whether email notifications are enabled for ingestion failures.
IsEmailNotificationOptedForIngestionFailures *bool
// The configuration settings for a knowledge base.
KnowledgeBaseConfiguration *types.KnowledgeBaseConfiguration
// The configuration for media extraction from knowledge base documents.
MediaExtractionConfiguration *types.MediaExtractionConfiguration
// The name of the knowledge base. If you don't specify a name, the existing name
// is retained.
Name *string
// contains filtered or unexported fields
}
func (*UpdateKnowledgeBaseInput) Serialize ¶ added in v1.131.0
func (v *UpdateKnowledgeBaseInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateKnowledgeBaseInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateKnowledgeBaseInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateKnowledgeBaseOutput ¶ added in v1.118.0
type UpdateKnowledgeBaseOutput struct {
// The Amazon Resource Name (ARN) of the knowledge base.
//
// This member is required.
KnowledgeBaseArn *string
// The unique identifier for the knowledge base.
//
// This member is required.
KnowledgeBaseId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status *int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateKnowledgeBaseOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateKnowledgeBaseOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateKnowledgeBaseOutput) Serialize ¶ added in v1.131.0
func (v *UpdateKnowledgeBaseOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateKnowledgeBaseOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateKnowledgeBaseOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateKnowledgeBasePermissionsInput ¶ added in v1.114.0
type UpdateKnowledgeBasePermissionsInput struct {
// The ID of the Amazon Web Services account that contains the knowledge base.
//
// This member is required.
AwsAccountId *string
// The unique identifier for the knowledge base.
//
// This member is required.
KnowledgeBaseId *string
// The resource permissions that you want to grant on the knowledge base.
GrantPermissions []types.ResourcePermission
// The resource permissions that you want to revoke from the knowledge base.
RevokePermissions []types.ResourcePermission
// contains filtered or unexported fields
}
func (*UpdateKnowledgeBasePermissionsInput) Serialize ¶ added in v1.131.0
func (v *UpdateKnowledgeBasePermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateKnowledgeBasePermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateKnowledgeBasePermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateKnowledgeBasePermissionsOutput ¶ added in v1.114.0
type UpdateKnowledgeBasePermissionsOutput struct {
// The Amazon Resource Name (ARN) of the knowledge base.
//
// This member is required.
KnowledgeBaseArn *string
// The unique identifier for the knowledge base.
//
// This member is required.
KnowledgeBaseId *string
// The resource permissions for the knowledge base.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status *int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateKnowledgeBasePermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateKnowledgeBasePermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateKnowledgeBasePermissionsOutput) Serialize ¶ added in v1.131.0
func (v *UpdateKnowledgeBasePermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateKnowledgeBasePermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateKnowledgeBasePermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateLimitsProfileInput ¶ added in v1.124.0
type UpdateLimitsProfileInput struct {
// The ID of the Amazon Web Services account that contains the limits profile.
//
// This member is required.
AccountId *string
// The unique identifier for the limits profile to update.
//
// This member is required.
ProfileId *string
// A new description for the limits profile.
Description *string
// A new display name for the limits profile.
ProfileName *string
// A map of resource types to their updated limit values.
ResourceLimits map[string]types.ProfileLimitValue
// contains filtered or unexported fields
}
func (*UpdateLimitsProfileInput) Serialize ¶ added in v1.131.0
func (v *UpdateLimitsProfileInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateLimitsProfileInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateLimitsProfileInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateLimitsProfileOutput ¶ added in v1.124.0
type UpdateLimitsProfileOutput struct {
// The Amazon Resource Name (ARN) of the updated limits profile.
//
// This member is required.
Arn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateLimitsProfileOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateLimitsProfileOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateLimitsProfileOutput) Serialize ¶ added in v1.131.0
func (v *UpdateLimitsProfileOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateLimitsProfileOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateLimitsProfileOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateOAuthClientApplicationInput ¶ added in v1.112.0
type UpdateOAuthClientApplicationInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The display name for the OAuthClientApplication.
//
// This member is required.
Name *string
// The ID of the OAuthClientApplication that you want to update.
//
// This member is required.
OAuthClientApplicationId *string
// The client ID of the OAuth application that is registered with the identity
// provider.
ClientId *string
// The client secret of the OAuth application that is registered with the identity
// provider.
ClientSecret *string
// The type of data source that the OAuthClientApplication is used with. Valid
// values are SNOWFLAKE .
DataSourceType types.DataSourceType
// VPC connection properties.
IdentityProviderVpcConnectionProperties *types.VpcConnectionProperties
// The authorization endpoint URL of the identity provider that is used to obtain
// authorization codes.
OAuthAuthorizationEndpointUrl *string
// The OAuth scopes that are requested when the OAuthClientApplication obtains an
// access token from the identity provider.
OAuthScopes *string
// The token endpoint URL of the identity provider that is used to obtain access
// tokens.
OAuthTokenEndpointUrl *string
// contains filtered or unexported fields
}
func (*UpdateOAuthClientApplicationInput) Serialize ¶ added in v1.131.0
func (v *UpdateOAuthClientApplicationInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateOAuthClientApplicationInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateOAuthClientApplicationInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateOAuthClientApplicationOutput ¶ added in v1.112.0
type UpdateOAuthClientApplicationOutput struct {
// The Amazon Resource Name (ARN) of the OAuthClientApplication.
Arn *string
// The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services
// Region for each Amazon Web Services account.
OAuthClientApplicationId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The status of updating the OAuthClientApplication.
UpdateStatus types.ResourceStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateOAuthClientApplicationOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateOAuthClientApplicationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateOAuthClientApplicationOutput) Serialize ¶ added in v1.131.0
func (v *UpdateOAuthClientApplicationOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateOAuthClientApplicationOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateOAuthClientApplicationOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdatePublicSharingSettingsInput ¶ added in v1.22.0
type UpdatePublicSharingSettingsInput struct {
// The Amazon Web Services account ID associated with your Amazon Quick Sight
// subscription.
//
// This member is required.
AwsAccountId *string
// A Boolean value that indicates whether public sharing is turned on for an Quick
// account.
PublicSharingEnabled bool
// contains filtered or unexported fields
}
func (*UpdatePublicSharingSettingsInput) Serialize ¶ added in v1.131.0
func (v *UpdatePublicSharingSettingsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdatePublicSharingSettingsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdatePublicSharingSettingsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdatePublicSharingSettingsOutput ¶ added in v1.22.0
type UpdatePublicSharingSettingsOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdatePublicSharingSettingsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdatePublicSharingSettingsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdatePublicSharingSettingsOutput) Serialize ¶ added in v1.131.0
func (v *UpdatePublicSharingSettingsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdatePublicSharingSettingsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdatePublicSharingSettingsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateQPersonalizationConfigurationInput ¶ added in v1.74.0
type UpdateQPersonalizationConfigurationInput struct {
// The ID of the Amazon Web Services account account that contains the
// personalization configuration that the user wants to update.
//
// This member is required.
AwsAccountId *string
// An option to allow Amazon Quick Sight to customize data stories with user
// specific metadata, specifically location and job information, in your IAM
// Identity Center instance.
//
// This member is required.
PersonalizationMode types.PersonalizationMode
// contains filtered or unexported fields
}
func (*UpdateQPersonalizationConfigurationInput) Serialize ¶ added in v1.131.0
func (v *UpdateQPersonalizationConfigurationInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateQPersonalizationConfigurationInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateQPersonalizationConfigurationInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateQPersonalizationConfigurationOutput ¶ added in v1.74.0
type UpdateQPersonalizationConfigurationOutput struct {
// The personalization mode that is used for the personalization configuration.
PersonalizationMode types.PersonalizationMode
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateQPersonalizationConfigurationOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateQPersonalizationConfigurationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateQPersonalizationConfigurationOutput) Serialize ¶ added in v1.131.0
func (v *UpdateQPersonalizationConfigurationOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateQPersonalizationConfigurationOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateQPersonalizationConfigurationOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateQuickSightQSearchConfigurationInput ¶ added in v1.81.0
type UpdateQuickSightQSearchConfigurationInput struct {
// The ID of the Amazon Web Services account that contains the Quick Sight Q
// Search configuration that you want to update.
//
// This member is required.
AwsAccountId *string
// The status of the Quick Sight Q Search configuration that the user wants to
// update.
//
// This member is required.
QSearchStatus types.QSearchStatus
// contains filtered or unexported fields
}
func (*UpdateQuickSightQSearchConfigurationInput) Serialize ¶ added in v1.131.0
func (v *UpdateQuickSightQSearchConfigurationInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateQuickSightQSearchConfigurationInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateQuickSightQSearchConfigurationInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateQuickSightQSearchConfigurationOutput ¶ added in v1.81.0
type UpdateQuickSightQSearchConfigurationOutput struct {
// The status of the Quick Sight Q Search configuration.
QSearchStatus types.QSearchStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateQuickSightQSearchConfigurationOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateQuickSightQSearchConfigurationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateQuickSightQSearchConfigurationOutput) Serialize ¶ added in v1.131.0
func (v *UpdateQuickSightQSearchConfigurationOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateQuickSightQSearchConfigurationOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateQuickSightQSearchConfigurationOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateRefreshScheduleInput ¶ added in v1.34.0
type UpdateRefreshScheduleInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset.
//
// This member is required.
DataSetId *string
// The refresh schedule.
//
// This member is required.
Schedule *types.RefreshSchedule
// contains filtered or unexported fields
}
func (*UpdateRefreshScheduleInput) Serialize ¶ added in v1.131.0
func (v *UpdateRefreshScheduleInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateRefreshScheduleInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateRefreshScheduleInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateRefreshScheduleOutput ¶ added in v1.34.0
type UpdateRefreshScheduleOutput struct {
// The Amazon Resource Name (ARN) for the refresh schedule.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The ID of the refresh schedule.
ScheduleId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateRefreshScheduleOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateRefreshScheduleOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateRefreshScheduleOutput) Serialize ¶ added in v1.131.0
func (v *UpdateRefreshScheduleOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateRefreshScheduleOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateRefreshScheduleOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateResourcePermissionsInput ¶ added in v1.139.0
type UpdateResourcePermissionsInput struct {
// The ID of the Amazon Web Services account whose service role configuration you
// want to update.
//
// This member is required.
AwsAccountId *string
// The ARN of the customer-managed role that you want Amazon Quick Sight to use.
// To use this operation, you must have the iam:PassRole permission for the role.
//
// Configure the role as follows:
//
// - The role must belong to the Amazon Web Services account specified by
// AwsAccountId .
//
// - Configure the role trust policy to allow the Amazon Quick Sight service
// principal to call sts:AssumeRole .
//
// - Attach a permissions policy that allows access to the resources that you
// want Amazon Quick Sight to use.
//
// - To use features that rely on session tags, configure the role trust policy
// to allow the Amazon Quick Sight service principal to call sts:TagSession .
//
// If the role doesn't exist or its trust policy doesn't allow sts:AssumeRole , the
// request returns an AccessDeniedException .
//
// When you call this operation, Amazon Quick Sight attempts to assume the role
// with session tags and records whether the attempt succeeds. If you later add or
// remove sts:TagSession from the trust policy, call this operation again with the
// same role ARN to refresh the stored capability.
//
// This member is required.
CustomerManagedRoleArn *string
// The type of service role that you want Amazon Quick Sight to use. The only
// supported value for this operation is CUSTOMER_MANAGED . Requests that specify
// QUICKSIGHT_MANAGED are rejected.
//
// This member is required.
RoleType types.ServiceRoleType
// contains filtered or unexported fields
}
func (*UpdateResourcePermissionsInput) Serialize ¶ added in v1.139.0
func (v *UpdateResourcePermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateResourcePermissionsInput) SerializeMembers ¶ added in v1.139.0
func (v *UpdateResourcePermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateResourcePermissionsOutput ¶ added in v1.139.0
type UpdateResourcePermissionsOutput struct {
// The ARN of the customer-managed role that Amazon Quick Sight uses for your
// account after the update.
CustomerManagedRoleArn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The type of service role that Amazon Quick Sight uses for your account after
// the update. This value is CUSTOMER_MANAGED .
RoleType types.ServiceRoleType
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateResourcePermissionsOutput) Deserialize ¶ added in v1.139.0
func (v *UpdateResourcePermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateResourcePermissionsOutput) Serialize ¶ added in v1.139.0
func (v *UpdateResourcePermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateResourcePermissionsOutput) SerializeMembers ¶ added in v1.139.0
func (v *UpdateResourcePermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateRoleCustomPermissionInput ¶ added in v1.51.0
type UpdateRoleCustomPermissionInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The name of the custom permission that you want to update the role with.
//
// This member is required.
CustomPermissionsName *string
// The namespace that contains the role that you want to update.
//
// This member is required.
Namespace *string
// The name of role tht you want to update.
//
// This member is required.
Role types.Role
// contains filtered or unexported fields
}
func (*UpdateRoleCustomPermissionInput) Serialize ¶ added in v1.131.0
func (v *UpdateRoleCustomPermissionInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateRoleCustomPermissionInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateRoleCustomPermissionInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateRoleCustomPermissionOutput ¶ added in v1.51.0
type UpdateRoleCustomPermissionOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateRoleCustomPermissionOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateRoleCustomPermissionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateRoleCustomPermissionOutput) Serialize ¶ added in v1.131.0
func (v *UpdateRoleCustomPermissionOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateRoleCustomPermissionOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateRoleCustomPermissionOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateSPICECapacityConfigurationInput ¶ added in v1.63.0
type UpdateSPICECapacityConfigurationInput struct {
// The ID of the Amazon Web Services account that contains the SPICE configuration
// that you want to update.
//
// This member is required.
AwsAccountId *string
// Determines how SPICE capacity can be purchased. The following options are
// available.
//
// - MANUAL : SPICE capacity can only be purchased manually.
//
// - AUTO_PURCHASE : Extra SPICE capacity is automatically purchased on your
// behalf as needed. SPICE capacity can also be purchased manually with this
// option.
//
// This member is required.
PurchaseMode types.PurchaseMode
// contains filtered or unexported fields
}
func (*UpdateSPICECapacityConfigurationInput) Serialize ¶ added in v1.131.0
func (v *UpdateSPICECapacityConfigurationInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateSPICECapacityConfigurationInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateSPICECapacityConfigurationInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateSPICECapacityConfigurationOutput ¶ added in v1.63.0
type UpdateSPICECapacityConfigurationOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateSPICECapacityConfigurationOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateSPICECapacityConfigurationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateSPICECapacityConfigurationOutput) Serialize ¶ added in v1.131.0
func (v *UpdateSPICECapacityConfigurationOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateSPICECapacityConfigurationOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateSPICECapacityConfigurationOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateSelfUpgradeConfigurationInput ¶ added in v1.100.0
type UpdateSelfUpgradeConfigurationInput struct {
// The ID of the Amazon Web Services account that contains the Quick self-upgrade
// configuration that you want to update.
//
// This member is required.
AwsAccountId *string
// The Quick namespace that you want to update the Quick self-upgrade
// configuration for.
//
// This member is required.
Namespace *string
// The self-upgrade status that you want to set for the Quick account.
//
// This member is required.
SelfUpgradeStatus types.SelfUpgradeStatus
// contains filtered or unexported fields
}
func (*UpdateSelfUpgradeConfigurationInput) Serialize ¶ added in v1.131.0
func (v *UpdateSelfUpgradeConfigurationInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateSelfUpgradeConfigurationInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateSelfUpgradeConfigurationInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateSelfUpgradeConfigurationOutput ¶ added in v1.100.0
type UpdateSelfUpgradeConfigurationOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateSelfUpgradeConfigurationOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateSelfUpgradeConfigurationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateSelfUpgradeConfigurationOutput) Serialize ¶ added in v1.131.0
func (v *UpdateSelfUpgradeConfigurationOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateSelfUpgradeConfigurationOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateSelfUpgradeConfigurationOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateSelfUpgradeInput ¶ added in v1.100.0
type UpdateSelfUpgradeInput struct {
// The action to perform on the self-upgrade request. Valid values are APPROVE ,
// DENY , or VERIFY .
//
// This member is required.
Action types.SelfUpgradeAdminAction
// The ID of the Amazon Web Services account that contains the self-upgrade
// request.
//
// This member is required.
AwsAccountId *string
// The Quick namespace for the self-upgrade request.
//
// This member is required.
Namespace *string
// The ID of the self-upgrade request to update.
//
// This member is required.
UpgradeRequestId *string
// contains filtered or unexported fields
}
func (*UpdateSelfUpgradeInput) Serialize ¶ added in v1.131.0
func (v *UpdateSelfUpgradeInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateSelfUpgradeInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateSelfUpgradeInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateSelfUpgradeOutput ¶ added in v1.100.0
type UpdateSelfUpgradeOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// Details of the updated self-upgrade request.
SelfUpgradeRequestDetail *types.SelfUpgradeRequestDetail
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateSelfUpgradeOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateSelfUpgradeOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateSelfUpgradeOutput) Serialize ¶ added in v1.131.0
func (v *UpdateSelfUpgradeOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateSelfUpgradeOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateSelfUpgradeOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateSpaceInput ¶ added in v1.113.0
type UpdateSpaceInput struct {
// The ID of the Amazon Web Services account that contains the space.
//
// This member is required.
AwsAccountId *string
// The ID of the space that you want to update.
//
// This member is required.
SpaceId *string
// A new description for the space.
Description *string
// A new display name for the space.
Name *string
// contains filtered or unexported fields
}
func (*UpdateSpaceInput) Serialize ¶ added in v1.131.0
func (v *UpdateSpaceInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateSpaceInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateSpaceInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateSpaceOutput ¶ added in v1.113.0
type UpdateSpaceOutput struct {
// The ID of the space.
//
// This member is required.
SpaceId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The ARN of the space.
SpaceArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateSpaceOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateSpaceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateSpaceOutput) Serialize ¶ added in v1.131.0
func (v *UpdateSpaceOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateSpaceOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateSpaceOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateSpacePermissionsInput ¶ added in v1.113.0
type UpdateSpacePermissionsInput struct {
// The ID of the Amazon Web Services account that contains the space.
//
// This member is required.
AwsAccountId *string
// The ID of the space that you want to update permissions for.
//
// This member is required.
SpaceId *string
// The permissions that you want to grant on the space.
GrantPermissions []types.ResourcePermission
// The permissions that you want to revoke from the space.
RevokePermissions []types.ResourcePermission
// contains filtered or unexported fields
}
func (*UpdateSpacePermissionsInput) Serialize ¶ added in v1.131.0
func (v *UpdateSpacePermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateSpacePermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateSpacePermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateSpacePermissionsOutput ¶ added in v1.113.0
type UpdateSpacePermissionsOutput struct {
// The ID of the space.
//
// This member is required.
SpaceId *string
// The updated permissions for the space.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The ARN of the space.
SpaceArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateSpacePermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateSpacePermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateSpacePermissionsOutput) Serialize ¶ added in v1.131.0
func (v *UpdateSpacePermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateSpacePermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateSpacePermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateSpaceResourcesInput ¶ added in v1.113.0
type UpdateSpaceResourcesInput struct {
// The ID of the Amazon Web Services account that contains the space.
//
// This member is required.
AwsAccountId *string
// The ID of the space that you want to update resources for.
//
// This member is required.
SpaceId *string
// A list of resources to add to the space.
AddResources []types.SpaceResourceOperation
// A list of resources to remove from the space.
RemoveResources []types.SpaceResourceOperation
// contains filtered or unexported fields
}
func (*UpdateSpaceResourcesInput) Serialize ¶ added in v1.131.0
func (v *UpdateSpaceResourcesInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateSpaceResourcesInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateSpaceResourcesInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateSpaceResourcesOutput ¶ added in v1.113.0
type UpdateSpaceResourcesOutput struct {
// The ID of the space.
//
// This member is required.
SpaceId *string
// A list of resource operations that failed.
FailedResourceOperations []types.FailedSpaceResourceOperation
// The Amazon Web Services request ID for this operation.
RequestId *string
// The ARN of the space.
SpaceArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateSpaceResourcesOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateSpaceResourcesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateSpaceResourcesOutput) Serialize ¶ added in v1.131.0
func (v *UpdateSpaceResourcesOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateSpaceResourcesOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateSpaceResourcesOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateTemplateAliasInput ¶
type UpdateTemplateAliasInput struct {
// The alias of the template that you want to update. If you name a specific
// alias, you update 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.
//
// This member is required.
AliasName *string
// The ID of the Amazon Web Services account that contains the template alias that
// you're updating.
//
// This member is required.
AwsAccountId *string
// The ID for the template.
//
// This member is required.
TemplateId *string
// The version number of the template.
//
// This member is required.
TemplateVersionNumber *int64
// contains filtered or unexported fields
}
func (*UpdateTemplateAliasInput) Serialize ¶ added in v1.131.0
func (v *UpdateTemplateAliasInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateTemplateAliasInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateTemplateAliasInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateTemplateAliasOutput ¶
type UpdateTemplateAliasOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The template alias.
TemplateAlias *types.TemplateAlias
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateTemplateAliasOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateTemplateAliasOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateTemplateAliasOutput) Serialize ¶ added in v1.131.0
func (v *UpdateTemplateAliasOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateTemplateAliasOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateTemplateAliasOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateTemplateInput ¶
type UpdateTemplateInput struct {
// The ID of the Amazon Web Services account that contains the template that
// you're updating.
//
// This member is required.
AwsAccountId *string
// The ID for the template.
//
// This member is required.
TemplateId *string
// The definition of a template.
//
// A definition is the data model of all features in a Dashboard, Template, or
// Analysis.
Definition *types.TemplateVersionDefinition
// The name for the template.
Name *string
// The entity that you are using as a source when you update the template. In
// SourceEntity , you specify the type of object you're using as source:
// SourceTemplate for a template or SourceAnalysis for an analysis. Both of these
// require an Amazon Resource Name (ARN). For SourceTemplate , specify the ARN of
// the source template. For SourceAnalysis , specify the ARN of the source
// analysis. The SourceTemplate ARN can contain any Amazon Web Services account
// and any Quick Sight-supported Amazon Web Services Region;.
//
// Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to
// list the replacement datasets for the placeholders listed in the original. The
// schema in each dataset must match its placeholder. Use the TopicReferences
// entity to list the replacement topics for the topic placeholders listed in the
// original. The schema in each topic must match its placeholder.
SourceEntity *types.TemplateSourceEntity
// The option to relax the validation needed to update a template with definition
// objects. This skips the validation step for specific errors.
ValidationStrategy *types.ValidationStrategy
// A description of the current template version that is being updated. Every time
// you call UpdateTemplate , you create a new version of the template. Each version
// of the template maintains a description of the version in the VersionDescription
// field.
VersionDescription *string
// contains filtered or unexported fields
}
func (*UpdateTemplateInput) Serialize ¶ added in v1.131.0
func (v *UpdateTemplateInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateTemplateInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateTemplateInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateTemplateOutput ¶
type UpdateTemplateOutput struct {
// The Amazon Resource Name (ARN) for the template.
Arn *string
// The creation status of the template.
CreationStatus types.ResourceStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ID for the template.
TemplateId *string
// The ARN for the template, including the version information of the first
// version.
VersionArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateTemplateOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateTemplateOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateTemplateOutput) Serialize ¶ added in v1.131.0
func (v *UpdateTemplateOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateTemplateOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateTemplateOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateTemplatePermissionsInput ¶
type UpdateTemplatePermissionsInput struct {
// The ID of the Amazon Web Services account that contains the template.
//
// This member is required.
AwsAccountId *string
// The ID for the template.
//
// This member is required.
TemplateId *string
// A list of resource permissions to be granted on the template.
GrantPermissions []types.ResourcePermission
// A list of resource permissions to be revoked from the template.
RevokePermissions []types.ResourcePermission
// contains filtered or unexported fields
}
func (*UpdateTemplatePermissionsInput) Serialize ¶ added in v1.131.0
func (v *UpdateTemplatePermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateTemplatePermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateTemplatePermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateTemplatePermissionsOutput ¶
type UpdateTemplatePermissionsOutput struct {
// A list of resource permissions to be set on the template.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the template.
TemplateArn *string
// The ID for the template.
TemplateId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateTemplatePermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateTemplatePermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateTemplatePermissionsOutput) Serialize ¶ added in v1.131.0
func (v *UpdateTemplatePermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateTemplatePermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateTemplatePermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateThemeAliasInput ¶
type UpdateThemeAliasInput struct {
// The name of the theme alias that you want to update.
//
// This member is required.
AliasName *string
// The ID of the Amazon Web Services account that contains the theme alias that
// you're updating.
//
// This member is required.
AwsAccountId *string
// The ID for the theme.
//
// This member is required.
ThemeId *string
// The version number of the theme that the alias should reference.
//
// This member is required.
ThemeVersionNumber *int64
// contains filtered or unexported fields
}
func (*UpdateThemeAliasInput) Serialize ¶ added in v1.131.0
func (v *UpdateThemeAliasInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateThemeAliasInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateThemeAliasInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateThemeAliasOutput ¶
type UpdateThemeAliasOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Information about the theme alias.
ThemeAlias *types.ThemeAlias
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateThemeAliasOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateThemeAliasOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateThemeAliasOutput) Serialize ¶ added in v1.131.0
func (v *UpdateThemeAliasOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateThemeAliasOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateThemeAliasOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateThemeInput ¶
type UpdateThemeInput struct {
// The ID of the Amazon Web Services account that contains the theme that you're
// updating.
//
// This member is required.
AwsAccountId *string
// The theme ID, defined by Amazon Quick Sight, that a custom theme inherits from.
// All themes initially inherit from a default Quick Sight theme.
//
// This member is required.
BaseThemeId *string
// The ID for the theme.
//
// This member is required.
ThemeId *string
// The theme configuration, which contains the theme display properties.
Configuration *types.ThemeConfiguration
// The name for the theme.
Name *string
// A description of the theme version that you're updating Every time that you
// call UpdateTheme , you create a new version of the theme. Each version of the
// theme maintains a description of the version in VersionDescription .
VersionDescription *string
// contains filtered or unexported fields
}
func (*UpdateThemeInput) Serialize ¶ added in v1.131.0
func (v *UpdateThemeInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateThemeInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateThemeInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateThemeOutput ¶
type UpdateThemeOutput struct {
// The Amazon Resource Name (ARN) for the theme.
Arn *string
// The creation status of the theme.
CreationStatus types.ResourceStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ID for the theme.
ThemeId *string
// The Amazon Resource Name (ARN) for the new version of the theme.
VersionArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateThemeOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateThemeOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateThemeOutput) Serialize ¶ added in v1.131.0
func (v *UpdateThemeOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateThemeOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateThemeOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateThemePermissionsInput ¶
type UpdateThemePermissionsInput struct {
// The ID of the Amazon Web Services account that contains the theme.
//
// This member is required.
AwsAccountId *string
// The ID for the theme.
//
// This member is required.
ThemeId *string
// A list of resource permissions to be granted for the theme.
GrantPermissions []types.ResourcePermission
// A list of resource permissions to be revoked from the theme.
RevokePermissions []types.ResourcePermission
// contains filtered or unexported fields
}
func (*UpdateThemePermissionsInput) Serialize ¶ added in v1.131.0
func (v *UpdateThemePermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateThemePermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateThemePermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateThemePermissionsOutput ¶
type UpdateThemePermissionsOutput struct {
// The resulting list of resource permissions for the theme.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the theme.
ThemeArn *string
// The ID for the theme.
ThemeId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateThemePermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateThemePermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateThemePermissionsOutput) Serialize ¶ added in v1.131.0
func (v *UpdateThemePermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateThemePermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateThemePermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateTopicInput ¶ added in v1.35.0
type UpdateTopicInput struct {
// The ID of the Amazon Web Services account that contains the topic that you want
// to update.
//
// This member is required.
AwsAccountId *string
// The definition of the topic that you want to update.
//
// This member is required.
Topic *types.TopicDetails
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
// Custom instructions for the topic.
CustomInstructions *types.CustomInstructions
// contains filtered or unexported fields
}
func (*UpdateTopicInput) Serialize ¶ added in v1.131.0
func (v *UpdateTopicInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateTopicInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateTopicInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateTopicOutput ¶ added in v1.35.0
type UpdateTopicOutput struct {
// The Amazon Resource Name (ARN) of the topic.
Arn *string
// The Amazon Resource Name (ARN) of the topic refresh.
RefreshArn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateTopicOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateTopicOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateTopicOutput) Serialize ¶ added in v1.131.0
func (v *UpdateTopicOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateTopicOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateTopicOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateTopicPermissionsInput ¶ added in v1.35.0
type UpdateTopicPermissionsInput struct {
// The ID of the Amazon Web Services account that contains the topic that you want
// to update the permissions for.
//
// This member is required.
AwsAccountId *string
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
// The resource permissions that you want to grant to the topic.
GrantPermissions []types.ResourcePermission
// The resource permissions that you want to revoke from the topic.
RevokePermissions []types.ResourcePermission
// contains filtered or unexported fields
}
func (*UpdateTopicPermissionsInput) Serialize ¶ added in v1.131.0
func (v *UpdateTopicPermissionsInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateTopicPermissionsInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateTopicPermissionsInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateTopicPermissionsOutput ¶ added in v1.35.0
type UpdateTopicPermissionsOutput struct {
// A list of resource permissions on the topic.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the topic.
TopicArn *string
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateTopicPermissionsOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateTopicPermissionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateTopicPermissionsOutput) Serialize ¶ added in v1.131.0
func (v *UpdateTopicPermissionsOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateTopicPermissionsOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateTopicPermissionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateTopicPermissionsV2Input ¶ added in v1.123.0
type UpdateTopicPermissionsV2Input struct {
// The ID of the Amazon Web Services account that contains the topic that you want
// to update the permissions for.
//
// This member is required.
AwsAccountId *string
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
// The resource permissions that you want to grant to the topic.
GrantPermissions []types.ResourcePermission
// The resource permissions that you want to revoke from the topic.
RevokePermissions []types.ResourcePermission
// contains filtered or unexported fields
}
func (*UpdateTopicPermissionsV2Input) Serialize ¶ added in v1.131.0
func (v *UpdateTopicPermissionsV2Input) Serialize(s smithy.ShapeSerializer)
func (*UpdateTopicPermissionsV2Input) SerializeMembers ¶ added in v1.131.0
func (v *UpdateTopicPermissionsV2Input) SerializeMembers(s smithy.ShapeSerializer)
type UpdateTopicPermissionsV2Output ¶ added in v1.123.0
type UpdateTopicPermissionsV2Output struct {
// A list of resource permissions on the topic.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the topic.
TopicArn *string
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateTopicPermissionsV2Output) Deserialize ¶ added in v1.131.0
func (v *UpdateTopicPermissionsV2Output) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateTopicPermissionsV2Output) Serialize ¶ added in v1.131.0
func (v *UpdateTopicPermissionsV2Output) Serialize(s smithy.ShapeSerializer)
func (*UpdateTopicPermissionsV2Output) SerializeMembers ¶ added in v1.131.0
func (v *UpdateTopicPermissionsV2Output) SerializeMembers(s smithy.ShapeSerializer)
type UpdateTopicRefreshScheduleInput ¶ added in v1.35.0
type UpdateTopicRefreshScheduleInput struct {
// The ID of the Amazon Web Services account that contains the topic whose refresh
// schedule you want to update.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset.
//
// This member is required.
DatasetId *string
// The definition of a refresh schedule.
//
// This member is required.
RefreshSchedule *types.TopicRefreshSchedule
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
// contains filtered or unexported fields
}
func (*UpdateTopicRefreshScheduleInput) Serialize ¶ added in v1.131.0
func (v *UpdateTopicRefreshScheduleInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateTopicRefreshScheduleInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateTopicRefreshScheduleInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateTopicRefreshScheduleOutput ¶ added in v1.35.0
type UpdateTopicRefreshScheduleOutput struct {
// The Amazon Resource Name (ARN) of the dataset.
DatasetArn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the topic.
TopicArn *string
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateTopicRefreshScheduleOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateTopicRefreshScheduleOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateTopicRefreshScheduleOutput) Serialize ¶ added in v1.131.0
func (v *UpdateTopicRefreshScheduleOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateTopicRefreshScheduleOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateTopicRefreshScheduleOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateTopicV2Input ¶ added in v1.123.0
type UpdateTopicV2Input struct {
// The ID of the Amazon Web Services account that contains the topic that you want
// to update.
//
// This member is required.
AwsAccountId *string
// The definition of the topic that you want to update.
//
// This member is required.
Topic *types.TopicV2Details
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
// Instructions that provide additional guidance and context for response
// generation.
CustomInstructions *types.CustomInstructions
// The publish option for the topic that you want to update.
PublishOption types.TopicV2PublishOption
// contains filtered or unexported fields
}
func (*UpdateTopicV2Input) Serialize ¶ added in v1.131.0
func (v *UpdateTopicV2Input) Serialize(s smithy.ShapeSerializer)
func (*UpdateTopicV2Input) SerializeMembers ¶ added in v1.131.0
func (v *UpdateTopicV2Input) SerializeMembers(s smithy.ShapeSerializer)
type UpdateTopicV2Output ¶ added in v1.123.0
type UpdateTopicV2Output struct {
// The Amazon Resource Name (ARN) of the topic.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateTopicV2Output) Deserialize ¶ added in v1.131.0
func (v *UpdateTopicV2Output) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateTopicV2Output) Serialize ¶ added in v1.131.0
func (v *UpdateTopicV2Output) Serialize(s smithy.ShapeSerializer)
func (*UpdateTopicV2Output) SerializeMembers ¶ added in v1.131.0
func (v *UpdateTopicV2Output) SerializeMembers(s smithy.ShapeSerializer)
type UpdateUserCustomPermissionInput ¶ added in v1.79.0
type UpdateUserCustomPermissionInput struct {
// The ID of the Amazon Web Services account that contains the custom permission
// configuration that you want to update.
//
// This member is required.
AwsAccountId *string
// The name of the custom permissions that you want to update.
//
// This member is required.
CustomPermissionsName *string
// The namespace that the user belongs to.
//
// This member is required.
Namespace *string
// The username of the user that you want to update custom permissions for.
//
// This member is required.
UserName *string
// contains filtered or unexported fields
}
func (*UpdateUserCustomPermissionInput) Serialize ¶ added in v1.131.0
func (v *UpdateUserCustomPermissionInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateUserCustomPermissionInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateUserCustomPermissionInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateUserCustomPermissionOutput ¶ added in v1.79.0
type UpdateUserCustomPermissionOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateUserCustomPermissionOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateUserCustomPermissionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateUserCustomPermissionOutput) Serialize ¶ added in v1.131.0
func (v *UpdateUserCustomPermissionOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateUserCustomPermissionOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateUserCustomPermissionOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateUserInput ¶
type UpdateUserInput struct {
// 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.
//
// This member is required.
AwsAccountId *string
// The email address of the user that you want to update.
//
// This member is required.
Email *string
// The namespace. Currently, you should set this to default .
//
// This member is required.
Namespace *string
// The Amazon Quick Sight role of the user. The role can be one of the following
// default security cohorts:
//
// - 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.
//
// The name of the Quick Sight role is invisible to the user except for the
// console screens dealing with permissions.
//
// This member is required.
Role types.UserRole
// The Amazon Quick Sight user name that you want to update.
//
// This member is required.
UserName *string
// 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 .
CustomFederationProviderUrl *string
// (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
//
// 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).
//
// This feature is available only to Quick Sight Enterprise edition subscriptions.
CustomPermissionsName *string
// The type of supported external login provider that provides identity to let a
// user federate into 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.
//
// - NONE : This clears all the previously saved external login information for a
// user. Use the [DescribeUser]API operation to check the external login information.
//
// [DescribeUser]: https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html
ExternalLoginFederationProviderType *string
// The identity ID for a user in the external login provider.
ExternalLoginId *string
// A flag that you use to indicate that you want to remove all custom permissions
// from this user. Using this parameter resets the user to the state it was in
// before a custom permissions profile was applied. This parameter defaults to NULL
// and it doesn't accept any other value.
UnapplyCustomPermissions bool
// contains filtered or unexported fields
}
func (*UpdateUserInput) Serialize ¶ added in v1.131.0
func (v *UpdateUserInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateUserInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateUserInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateUserOutput ¶
type UpdateUserOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Quick Sight user.
User *types.User
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateUserOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateUserOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateUserOutput) Serialize ¶ added in v1.131.0
func (v *UpdateUserOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateUserOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateUserOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateVPCConnectionInput ¶ added in v1.35.0
type UpdateVPCConnectionInput struct {
// The Amazon Web Services account ID of the account that contains the VPC
// connection that you want to update.
//
// This member is required.
AwsAccountId *string
// The display name for the VPC connection.
//
// This member is required.
Name *string
// An IAM role associated with the VPC connection.
//
// This member is required.
RoleArn *string
// A list of security group IDs for the VPC connection.
//
// This member is required.
SecurityGroupIds []string
// A list of subnet IDs for the VPC connection.
//
// This member is required.
SubnetIds []string
// The ID of the VPC connection that you're updating. This ID is a unique
// identifier for each Amazon Web Services Region in an Amazon Web Services
// account.
//
// This member is required.
VPCConnectionId *string
// A list of IP addresses of DNS resolver endpoints for the VPC connection.
DnsResolvers []string
// contains filtered or unexported fields
}
func (*UpdateVPCConnectionInput) Serialize ¶ added in v1.131.0
func (v *UpdateVPCConnectionInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateVPCConnectionInput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateVPCConnectionInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateVPCConnectionOutput ¶ added in v1.35.0
type UpdateVPCConnectionOutput struct {
// The Amazon Resource Name (ARN) of the VPC connection.
Arn *string
// The availability status of the VPC connection.
AvailabilityStatus types.VPCConnectionAvailabilityStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The update status of the VPC connection's last update.
UpdateStatus types.VPCConnectionResourceStatus
// The ID of the VPC connection that you are updating. This ID is a unique
// identifier for each Amazon Web Services Region in anAmazon Web Services account.
VPCConnectionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateVPCConnectionOutput) Deserialize ¶ added in v1.131.0
func (v *UpdateVPCConnectionOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateVPCConnectionOutput) Serialize ¶ added in v1.131.0
func (v *UpdateVPCConnectionOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateVPCConnectionOutput) SerializeMembers ¶ added in v1.131.0
func (v *UpdateVPCConnectionOutput) SerializeMembers(s smithy.ShapeSerializer)
Source Files
¶
- api_client.go
- api_op_BatchCreateTopicReviewedAnswer.go
- api_op_BatchDeleteKnowledgeBase.go
- api_op_BatchDeleteTopicReviewedAnswer.go
- api_op_BatchDescribeUserLimits.go
- api_op_CancelIngestion.go
- api_op_CreateAccountCustomization.go
- api_op_CreateAccountSubscription.go
- api_op_CreateActionConnector.go
- api_op_CreateAgent.go
- api_op_CreateAnalysis.go
- api_op_CreateApprovalPolicy.go
- api_op_CreateBrand.go
- api_op_CreateCustomPermissions.go
- api_op_CreateDashboard.go
- api_op_CreateDataSet.go
- api_op_CreateDataSource.go
- api_op_CreateDlpSetting.go
- api_op_CreateFlow.go
- api_op_CreateFolder.go
- api_op_CreateFolderMembership.go
- api_op_CreateGroup.go
- api_op_CreateGroupMembership.go
- api_op_CreateIAMPolicyAssignment.go
- api_op_CreateIngestion.go
- api_op_CreateKnowledgeBase.go
- api_op_CreateLimitsProfile.go
- api_op_CreateNamespace.go
- api_op_CreateOAuthClientApplication.go
- api_op_CreateRefreshSchedule.go
- api_op_CreateRoleMembership.go
- api_op_CreateSpace.go
- api_op_CreateTemplate.go
- api_op_CreateTemplateAlias.go
- api_op_CreateTheme.go
- api_op_CreateThemeAlias.go
- api_op_CreateTopic.go
- api_op_CreateTopicRefreshSchedule.go
- api_op_CreateTopicV2.go
- api_op_CreateVPCConnection.go
- api_op_DeleteAccountCustomPermission.go
- api_op_DeleteAccountCustomization.go
- api_op_DeleteAccountSubscription.go
- api_op_DeleteActionConnector.go
- api_op_DeleteAgent.go
- api_op_DeleteAnalysis.go
- api_op_DeleteApp.go
- api_op_DeleteApprovalPolicy.go
- api_op_DeleteBrand.go
- api_op_DeleteBrandAssignment.go
- api_op_DeleteCustomPermissions.go
- api_op_DeleteDashboard.go
- api_op_DeleteDataSet.go
- api_op_DeleteDataSetRefreshProperties.go
- api_op_DeleteDataSource.go
- api_op_DeleteDefaultQBusinessApplication.go
- api_op_DeleteDlpSetting.go
- api_op_DeleteFlow.go
- api_op_DeleteFolder.go
- api_op_DeleteFolderMembership.go
- api_op_DeleteGroup.go
- api_op_DeleteGroupMembership.go
- api_op_DeleteIAMPolicyAssignment.go
- api_op_DeleteIdentityPropagationConfig.go
- api_op_DeleteKnowledgeBase.go
- api_op_DeleteLimitsProfile.go
- api_op_DeleteNamespace.go
- api_op_DeleteOAuthClientApplication.go
- api_op_DeleteRefreshSchedule.go
- api_op_DeleteRoleCustomPermission.go
- api_op_DeleteRoleMembership.go
- api_op_DeleteSpace.go
- api_op_DeleteTemplate.go
- api_op_DeleteTemplateAlias.go
- api_op_DeleteTheme.go
- api_op_DeleteThemeAlias.go
- api_op_DeleteTopic.go
- api_op_DeleteTopicRefreshSchedule.go
- api_op_DeleteTopicV2.go
- api_op_DeleteUser.go
- api_op_DeleteUserByPrincipalId.go
- api_op_DeleteUserCustomPermission.go
- api_op_DeleteVPCConnection.go
- api_op_DescribeAccountCustomPermission.go
- api_op_DescribeAccountCustomization.go
- api_op_DescribeAccountSettings.go
- api_op_DescribeAccountSubscription.go
- api_op_DescribeActionConnector.go
- api_op_DescribeActionConnectorPermissions.go
- api_op_DescribeAgent.go
- api_op_DescribeAgentPermissions.go
- api_op_DescribeAnalysis.go
- api_op_DescribeAnalysisDefinition.go
- api_op_DescribeAnalysisPermissions.go
- api_op_DescribeApp.go
- api_op_DescribeAppPermissions.go
- api_op_DescribeApprovalPolicy.go
- api_op_DescribeAssetBundleExportJob.go
- api_op_DescribeAssetBundleImportJob.go
- api_op_DescribeAutomationJob.go
- api_op_DescribeBrand.go
- api_op_DescribeBrandAssignment.go
- api_op_DescribeBrandPublishedVersion.go
- api_op_DescribeCustomPermissions.go
- api_op_DescribeDashboard.go
- api_op_DescribeDashboardDefinition.go
- api_op_DescribeDashboardPermissions.go
- api_op_DescribeDashboardSnapshotJob.go
- api_op_DescribeDashboardSnapshotJobResult.go
- api_op_DescribeDashboardsQAConfiguration.go
- api_op_DescribeDataSet.go
- api_op_DescribeDataSetPermissions.go
- api_op_DescribeDataSetRefreshProperties.go
- api_op_DescribeDataSource.go
- api_op_DescribeDataSourcePermissions.go
- api_op_DescribeDefaultQBusinessApplication.go
- api_op_DescribeDlpSetting.go
- api_op_DescribeFlow.go
- api_op_DescribeFolder.go
- api_op_DescribeFolderPermissions.go
- api_op_DescribeFolderResolvedPermissions.go
- api_op_DescribeGroup.go
- api_op_DescribeGroupMembership.go
- api_op_DescribeIAMPolicyAssignment.go
- api_op_DescribeIngestion.go
- api_op_DescribeIpRestriction.go
- api_op_DescribeKeyRegistration.go
- api_op_DescribeKnowledgeBase.go
- api_op_DescribeKnowledgeBasePermissions.go
- api_op_DescribeLimitsProfile.go
- api_op_DescribeNamespace.go
- api_op_DescribeOAuthClientApplication.go
- api_op_DescribeQPersonalizationConfiguration.go
- api_op_DescribeQuickSightQSearchConfiguration.go
- api_op_DescribeRefreshSchedule.go
- api_op_DescribeResourcePermissions.go
- api_op_DescribeRoleCustomPermission.go
- api_op_DescribeSelfUpgradeConfiguration.go
- api_op_DescribeSpace.go
- api_op_DescribeSpacePermissions.go
- api_op_DescribeTemplate.go
- api_op_DescribeTemplateAlias.go
- api_op_DescribeTemplateDefinition.go
- api_op_DescribeTemplatePermissions.go
- api_op_DescribeTheme.go
- api_op_DescribeThemeAlias.go
- api_op_DescribeThemePermissions.go
- api_op_DescribeTopic.go
- api_op_DescribeTopicPermissions.go
- api_op_DescribeTopicPermissionsV2.go
- api_op_DescribeTopicRefresh.go
- api_op_DescribeTopicRefreshSchedule.go
- api_op_DescribeTopicV2.go
- api_op_DescribeUser.go
- api_op_DescribeVPCConnection.go
- api_op_GenerateEmbedUrlForAnonymousUser.go
- api_op_GenerateEmbedUrlForRegisteredUser.go
- api_op_GenerateEmbedUrlForRegisteredUserWithIdentity.go
- api_op_GetDashboardEmbedUrl.go
- api_op_GetFlowMetadata.go
- api_op_GetFlowPermissions.go
- api_op_GetIdentityContext.go
- api_op_GetSessionEmbedUrl.go
- api_op_ListActionConnectors.go
- api_op_ListAgents.go
- api_op_ListAnalyses.go
- api_op_ListApprovalPolicies.go
- api_op_ListApps.go
- api_op_ListAssetBundleExportJobs.go
- api_op_ListAssetBundleImportJobs.go
- api_op_ListBrands.go
- api_op_ListCustomPermissions.go
- api_op_ListDashboardVersions.go
- api_op_ListDashboards.go
- api_op_ListDataSets.go
- api_op_ListDataSources.go
- api_op_ListDlpSettings.go
- api_op_ListFlows.go
- api_op_ListFolderMembers.go
- api_op_ListFolders.go
- api_op_ListFoldersForResource.go
- api_op_ListGroupMemberships.go
- api_op_ListGroups.go
- api_op_ListIAMPolicyAssignments.go
- api_op_ListIAMPolicyAssignmentsForUser.go
- api_op_ListIdentityPropagationConfigs.go
- api_op_ListIngestions.go
- api_op_ListKnowledgeBases.go
- api_op_ListLimitsProfiles.go
- api_op_ListNamespaces.go
- api_op_ListOAuthClientApplications.go
- api_op_ListRefreshSchedules.go
- api_op_ListRoleMemberships.go
- api_op_ListSelfUpgrades.go
- api_op_ListSpaceResources.go
- api_op_ListSpaces.go
- api_op_ListTagsForResource.go
- api_op_ListTemplateAliases.go
- api_op_ListTemplateVersions.go
- api_op_ListTemplates.go
- api_op_ListThemeAliases.go
- api_op_ListThemeVersions.go
- api_op_ListThemes.go
- api_op_ListTopicRefreshSchedules.go
- api_op_ListTopicReviewedAnswers.go
- api_op_ListTopics.go
- api_op_ListTopicsV2.go
- api_op_ListUserGroups.go
- api_op_ListUsers.go
- api_op_ListUsersIndexCapacity.go
- api_op_ListVPCConnections.go
- api_op_PredictQAResults.go
- api_op_PutDataSetRefreshProperties.go
- api_op_RegisterUser.go
- api_op_RestoreAnalysis.go
- api_op_SearchActionConnectors.go
- api_op_SearchAgents.go
- api_op_SearchAnalyses.go
- api_op_SearchApps.go
- api_op_SearchDashboards.go
- api_op_SearchDataSets.go
- api_op_SearchDataSources.go
- api_op_SearchFlows.go
- api_op_SearchFolders.go
- api_op_SearchGroups.go
- api_op_SearchKnowledgeBases.go
- api_op_SearchSpaces.go
- api_op_SearchTopics.go
- api_op_SearchTopicsV2.go
- api_op_StartAssetBundleExportJob.go
- api_op_StartAssetBundleImportJob.go
- api_op_StartAutomationJob.go
- api_op_StartDashboardSnapshotJob.go
- api_op_StartDashboardSnapshotJobSchedule.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateAccountCustomPermission.go
- api_op_UpdateAccountCustomization.go
- api_op_UpdateAccountSettings.go
- api_op_UpdateActionConnector.go
- api_op_UpdateActionConnectorPermissions.go
- api_op_UpdateAgent.go
- api_op_UpdateAgentPermissions.go
- api_op_UpdateAnalysis.go
- api_op_UpdateAnalysisPermissions.go
- api_op_UpdateAppPermissions.go
- api_op_UpdateApplicationWithTokenExchangeGrant.go
- api_op_UpdateApprovalPolicy.go
- api_op_UpdateBrand.go
- api_op_UpdateBrandAssignment.go
- api_op_UpdateBrandPublishedVersion.go
- api_op_UpdateCustomPermissions.go
- api_op_UpdateDashboard.go
- api_op_UpdateDashboardLinks.go
- api_op_UpdateDashboardPermissions.go
- api_op_UpdateDashboardPublishedVersion.go
- api_op_UpdateDashboardsQAConfiguration.go
- api_op_UpdateDataSet.go
- api_op_UpdateDataSetPermissions.go
- api_op_UpdateDataSource.go
- api_op_UpdateDataSourcePermissions.go
- api_op_UpdateDefaultQBusinessApplication.go
- api_op_UpdateDlpSetting.go
- api_op_UpdateFlow.go
- api_op_UpdateFlowPermissions.go
- api_op_UpdateFolder.go
- api_op_UpdateFolderPermissions.go
- api_op_UpdateGroup.go
- api_op_UpdateIAMPolicyAssignment.go
- api_op_UpdateIdentityPropagationConfig.go
- api_op_UpdateIpRestriction.go
- api_op_UpdateKeyRegistration.go
- api_op_UpdateKnowledgeBase.go
- api_op_UpdateKnowledgeBasePermissions.go
- api_op_UpdateLimitsProfile.go
- api_op_UpdateOAuthClientApplication.go
- api_op_UpdatePublicSharingSettings.go
- api_op_UpdateQPersonalizationConfiguration.go
- api_op_UpdateQuickSightQSearchConfiguration.go
- api_op_UpdateRefreshSchedule.go
- api_op_UpdateResourcePermissions.go
- api_op_UpdateRoleCustomPermission.go
- api_op_UpdateSPICECapacityConfiguration.go
- api_op_UpdateSelfUpgrade.go
- api_op_UpdateSelfUpgradeConfiguration.go
- api_op_UpdateSpace.go
- api_op_UpdateSpacePermissions.go
- api_op_UpdateSpaceResources.go
- api_op_UpdateTemplate.go
- api_op_UpdateTemplateAlias.go
- api_op_UpdateTemplatePermissions.go
- api_op_UpdateTheme.go
- api_op_UpdateThemeAlias.go
- api_op_UpdateThemePermissions.go
- api_op_UpdateTopic.go
- api_op_UpdateTopicPermissions.go
- api_op_UpdateTopicPermissionsV2.go
- api_op_UpdateTopicRefreshSchedule.go
- api_op_UpdateTopicV2.go
- api_op_UpdateUser.go
- api_op_UpdateUserCustomPermission.go
- api_op_UpdateVPCConnection.go
- auth.go
- common_serde.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- type_registry.go
- validators.go