package quicksight
import "github.com/aws/aws-sdk-go-v2/service/quicksight"
Index ¶
- Constants
- func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
- type CancelIngestionInput
- type CancelIngestionOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) CancelIngestion(ctx context.Context, params *CancelIngestionInput, optFns ...func(*Options)) (*CancelIngestionOutput, error)
- func (c *Client) CreateAccountCustomization(ctx context.Context, params *CreateAccountCustomizationInput, optFns ...func(*Options)) (*CreateAccountCustomizationOutput, 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) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error)
- func (c *Client) CreateGroupMembership(ctx context.Context, params *CreateGroupMembershipInput, optFns ...func(*Options)) (*CreateGroupMembershipOutput, error)
- func (c *Client) CreateIAMPolicyAssignment(ctx context.Context, params *CreateIAMPolicyAssignmentInput, optFns ...func(*Options)) (*CreateIAMPolicyAssignmentOutput, error)
- func (c *Client) CreateIngestion(ctx context.Context, params *CreateIngestionInput, optFns ...func(*Options)) (*CreateIngestionOutput, error)
- func (c *Client) CreateNamespace(ctx context.Context, params *CreateNamespaceInput, optFns ...func(*Options)) (*CreateNamespaceOutput, error)
- func (c *Client) CreateTemplate(ctx context.Context, params *CreateTemplateInput, optFns ...func(*Options)) (*CreateTemplateOutput, error)
- func (c *Client) CreateTemplateAlias(ctx context.Context, params *CreateTemplateAliasInput, optFns ...func(*Options)) (*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) DeleteAccountCustomization(ctx context.Context, params *DeleteAccountCustomizationInput, optFns ...func(*Options)) (*DeleteAccountCustomizationOutput, 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) DeleteDataSource(ctx context.Context, params *DeleteDataSourceInput, optFns ...func(*Options)) (*DeleteDataSourceOutput, error)
- func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error)
- func (c *Client) DeleteGroupMembership(ctx context.Context, params *DeleteGroupMembershipInput, optFns ...func(*Options)) (*DeleteGroupMembershipOutput, error)
- func (c *Client) DeleteIAMPolicyAssignment(ctx context.Context, params *DeleteIAMPolicyAssignmentInput, optFns ...func(*Options)) (*DeleteIAMPolicyAssignmentOutput, error)
- func (c *Client) DeleteNamespace(ctx context.Context, params *DeleteNamespaceInput, optFns ...func(*Options)) (*DeleteNamespaceOutput, error)
- func (c *Client) DeleteTemplate(ctx context.Context, params *DeleteTemplateInput, optFns ...func(*Options)) (*DeleteTemplateOutput, error)
- func (c *Client) DeleteTemplateAlias(ctx context.Context, params *DeleteTemplateAliasInput, optFns ...func(*Options)) (*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) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)
- func (c *Client) DeleteUserByPrincipalId(ctx context.Context, params *DeleteUserByPrincipalIdInput, optFns ...func(*Options)) (*DeleteUserByPrincipalIdOutput, error)
- func (c *Client) DescribeAccountCustomization(ctx context.Context, params *DescribeAccountCustomizationInput, optFns ...func(*Options)) (*DescribeAccountCustomizationOutput, error)
- func (c *Client) DescribeAccountSettings(ctx context.Context, params *DescribeAccountSettingsInput, optFns ...func(*Options)) (*DescribeAccountSettingsOutput, error)
- func (c *Client) DescribeDashboard(ctx context.Context, params *DescribeDashboardInput, optFns ...func(*Options)) (*DescribeDashboardOutput, error)
- func (c *Client) DescribeDashboardPermissions(ctx context.Context, params *DescribeDashboardPermissionsInput, optFns ...func(*Options)) (*DescribeDashboardPermissionsOutput, error)
- func (c *Client) DescribeDataSet(ctx context.Context, params *DescribeDataSetInput, optFns ...func(*Options)) (*DescribeDataSetOutput, error)
- func (c *Client) DescribeDataSetPermissions(ctx context.Context, params *DescribeDataSetPermissionsInput, optFns ...func(*Options)) (*DescribeDataSetPermissionsOutput, error)
- func (c *Client) DescribeDataSource(ctx context.Context, params *DescribeDataSourceInput, optFns ...func(*Options)) (*DescribeDataSourceOutput, error)
- func (c *Client) DescribeDataSourcePermissions(ctx context.Context, params *DescribeDataSourcePermissionsInput, optFns ...func(*Options)) (*DescribeDataSourcePermissionsOutput, error)
- func (c *Client) DescribeGroup(ctx context.Context, params *DescribeGroupInput, optFns ...func(*Options)) (*DescribeGroupOutput, error)
- func (c *Client) DescribeIAMPolicyAssignment(ctx context.Context, params *DescribeIAMPolicyAssignmentInput, optFns ...func(*Options)) (*DescribeIAMPolicyAssignmentOutput, error)
- func (c *Client) DescribeIngestion(ctx context.Context, params *DescribeIngestionInput, optFns ...func(*Options)) (*DescribeIngestionOutput, error)
- func (c *Client) DescribeNamespace(ctx context.Context, params *DescribeNamespaceInput, optFns ...func(*Options)) (*DescribeNamespaceOutput, error)
- func (c *Client) DescribeTemplate(ctx context.Context, params *DescribeTemplateInput, optFns ...func(*Options)) (*DescribeTemplateOutput, error)
- func (c *Client) DescribeTemplateAlias(ctx context.Context, params *DescribeTemplateAliasInput, optFns ...func(*Options)) (*DescribeTemplateAliasOutput, error)
- func (c *Client) DescribeTemplatePermissions(ctx context.Context, params *DescribeTemplatePermissionsInput, optFns ...func(*Options)) (*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, optFns ...func(*Options)) (*DescribeThemePermissionsOutput, error)
- func (c *Client) DescribeUser(ctx context.Context, params *DescribeUserInput, optFns ...func(*Options)) (*DescribeUserOutput, error)
- func (c *Client) GetDashboardEmbedUrl(ctx context.Context, params *GetDashboardEmbedUrlInput, optFns ...func(*Options)) (*GetDashboardEmbedUrlOutput, error)
- func (c *Client) GetSessionEmbedUrl(ctx context.Context, params *GetSessionEmbedUrlInput, optFns ...func(*Options)) (*GetSessionEmbedUrlOutput, error)
- func (c *Client) ListDashboardVersions(ctx context.Context, params *ListDashboardVersionsInput, optFns ...func(*Options)) (*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) ListGroupMemberships(ctx context.Context, params *ListGroupMembershipsInput, optFns ...func(*Options)) (*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, optFns ...func(*Options)) (*ListIAMPolicyAssignmentsOutput, error)
- func (c *Client) ListIAMPolicyAssignmentsForUser(ctx context.Context, params *ListIAMPolicyAssignmentsForUserInput, optFns ...func(*Options)) (*ListIAMPolicyAssignmentsForUserOutput, error)
- func (c *Client) ListIngestions(ctx context.Context, params *ListIngestionsInput, optFns ...func(*Options)) (*ListIngestionsOutput, error)
- func (c *Client) ListNamespaces(ctx context.Context, params *ListNamespacesInput, optFns ...func(*Options)) (*ListNamespacesOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
- func (c *Client) ListTemplateAliases(ctx context.Context, params *ListTemplateAliasesInput, optFns ...func(*Options)) (*ListTemplateAliasesOutput, error)
- func (c *Client) ListTemplateVersions(ctx context.Context, params *ListTemplateVersionsInput, optFns ...func(*Options)) (*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) 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) RegisterUser(ctx context.Context, params *RegisterUserInput, optFns ...func(*Options)) (*RegisterUserOutput, error)
- func (c *Client) SearchDashboards(ctx context.Context, params *SearchDashboardsInput, optFns ...func(*Options)) (*SearchDashboardsOutput, 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) UpdateAccountCustomization(ctx context.Context, params *UpdateAccountCustomizationInput, optFns ...func(*Options)) (*UpdateAccountCustomizationOutput, error)
- func (c *Client) UpdateAccountSettings(ctx context.Context, params *UpdateAccountSettingsInput, optFns ...func(*Options)) (*UpdateAccountSettingsOutput, error)
- func (c *Client) UpdateDashboard(ctx context.Context, params *UpdateDashboardInput, optFns ...func(*Options)) (*UpdateDashboardOutput, error)
- func (c *Client) UpdateDashboardPermissions(ctx context.Context, params *UpdateDashboardPermissionsInput, optFns ...func(*Options)) (*UpdateDashboardPermissionsOutput, error)
- func (c *Client) UpdateDashboardPublishedVersion(ctx context.Context, params *UpdateDashboardPublishedVersionInput, optFns ...func(*Options)) (*UpdateDashboardPublishedVersionOutput, error)
- func (c *Client) UpdateDataSet(ctx context.Context, params *UpdateDataSetInput, optFns ...func(*Options)) (*UpdateDataSetOutput, error)
- func (c *Client) UpdateDataSetPermissions(ctx context.Context, params *UpdateDataSetPermissionsInput, optFns ...func(*Options)) (*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, optFns ...func(*Options)) (*UpdateDataSourcePermissionsOutput, error)
- func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error)
- func (c *Client) UpdateIAMPolicyAssignment(ctx context.Context, params *UpdateIAMPolicyAssignmentInput, optFns ...func(*Options)) (*UpdateIAMPolicyAssignmentOutput, error)
- func (c *Client) UpdateTemplate(ctx context.Context, params *UpdateTemplateInput, optFns ...func(*Options)) (*UpdateTemplateOutput, error)
- func (c *Client) UpdateTemplateAlias(ctx context.Context, params *UpdateTemplateAliasInput, optFns ...func(*Options)) (*UpdateTemplateAliasOutput, error)
- func (c *Client) UpdateTemplatePermissions(ctx context.Context, params *UpdateTemplatePermissionsInput, optFns ...func(*Options)) (*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, optFns ...func(*Options)) (*UpdateThemePermissionsOutput, error)
- func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error)
- type CreateAccountCustomizationInput
- type CreateAccountCustomizationOutput
- type CreateDashboardInput
- type CreateDashboardOutput
- type CreateDataSetInput
- type CreateDataSetOutput
- type CreateDataSourceInput
- type CreateDataSourceOutput
- type CreateGroupInput
- type CreateGroupMembershipInput
- type CreateGroupMembershipOutput
- type CreateGroupOutput
- type CreateIAMPolicyAssignmentInput
- type CreateIAMPolicyAssignmentOutput
- type CreateIngestionInput
- type CreateIngestionOutput
- type CreateNamespaceInput
- type CreateNamespaceOutput
- type CreateTemplateAliasInput
- type CreateTemplateAliasOutput
- type CreateTemplateInput
- type CreateTemplateOutput
- type CreateThemeAliasInput
- type CreateThemeAliasOutput
- type CreateThemeInput
- type CreateThemeOutput
- type DeleteAccountCustomizationInput
- type DeleteAccountCustomizationOutput
- type DeleteDashboardInput
- type DeleteDashboardOutput
- type DeleteDataSetInput
- type DeleteDataSetOutput
- type DeleteDataSourceInput
- type DeleteDataSourceOutput
- type DeleteGroupInput
- type DeleteGroupMembershipInput
- type DeleteGroupMembershipOutput
- type DeleteGroupOutput
- type DeleteIAMPolicyAssignmentInput
- type DeleteIAMPolicyAssignmentOutput
- type DeleteNamespaceInput
- type DeleteNamespaceOutput
- type DeleteTemplateAliasInput
- type DeleteTemplateAliasOutput
- type DeleteTemplateInput
- type DeleteTemplateOutput
- type DeleteThemeAliasInput
- type DeleteThemeAliasOutput
- type DeleteThemeInput
- type DeleteThemeOutput
- type DeleteUserByPrincipalIdInput
- type DeleteUserByPrincipalIdOutput
- type DeleteUserInput
- type DeleteUserOutput
- type DescribeAccountCustomizationInput
- type DescribeAccountCustomizationOutput
- type DescribeAccountSettingsInput
- type DescribeAccountSettingsOutput
- type DescribeDashboardInput
- type DescribeDashboardOutput
- type DescribeDashboardPermissionsInput
- type DescribeDashboardPermissionsOutput
- type DescribeDataSetInput
- type DescribeDataSetOutput
- type DescribeDataSetPermissionsInput
- type DescribeDataSetPermissionsOutput
- type DescribeDataSourceInput
- type DescribeDataSourceOutput
- type DescribeDataSourcePermissionsInput
- type DescribeDataSourcePermissionsOutput
- type DescribeGroupInput
- type DescribeGroupOutput
- type DescribeIAMPolicyAssignmentInput
- type DescribeIAMPolicyAssignmentOutput
- type DescribeIngestionInput
- type DescribeIngestionOutput
- type DescribeNamespaceInput
- type DescribeNamespaceOutput
- type DescribeTemplateAliasInput
- type DescribeTemplateAliasOutput
- type DescribeTemplateInput
- type DescribeTemplateOutput
- type DescribeTemplatePermissionsInput
- type DescribeTemplatePermissionsOutput
- type DescribeThemeAliasInput
- type DescribeThemeAliasOutput
- type DescribeThemeInput
- type DescribeThemeOutput
- type DescribeThemePermissionsInput
- type DescribeThemePermissionsOutput
- type DescribeUserInput
- type DescribeUserOutput
- type EndpointResolver
- type EndpointResolverFunc
- type GetDashboardEmbedUrlInput
- type GetDashboardEmbedUrlOutput
- type GetSessionEmbedUrlInput
- type GetSessionEmbedUrlOutput
- type HTTPClient
- type HTTPSignerV4
- type ListDashboardVersionsInput
- type ListDashboardVersionsOutput
- type ListDashboardsInput
- type ListDashboardsOutput
- type ListDataSetsInput
- type ListDataSetsOutput
- type ListDataSourcesInput
- type ListDataSourcesOutput
- type ListGroupMembershipsInput
- type ListGroupMembershipsOutput
- type ListGroupsInput
- type ListGroupsOutput
- type ListIAMPolicyAssignmentsForUserInput
- type ListIAMPolicyAssignmentsForUserOutput
- type ListIAMPolicyAssignmentsInput
- type ListIAMPolicyAssignmentsOutput
- type ListIngestionsInput
- type ListIngestionsOutput
- type ListNamespacesInput
- type ListNamespacesOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTemplateAliasesInput
- type ListTemplateAliasesOutput
- type ListTemplateVersionsInput
- type ListTemplateVersionsOutput
- type ListTemplatesInput
- type ListTemplatesOutput
- type ListThemeAliasesInput
- type ListThemeAliasesOutput
- type ListThemeVersionsInput
- type ListThemeVersionsOutput
- type ListThemesInput
- type ListThemesOutput
- type ListUserGroupsInput
- type ListUserGroupsOutput
- type ListUsersInput
- type ListUsersOutput
- type Options
- func (o Options) Copy() Options
- func (o Options) GetCredentials() aws.CredentialsProvider
- func (o Options) GetEndpointOptions() ResolverOptions
- func (o Options) GetEndpointResolver() EndpointResolver
- func (o Options) GetHTTPSignerV4() HTTPSignerV4
- func (o Options) GetRegion() string
- func (o Options) GetRetryer() retry.Retryer
- type RegisterUserInput
- type RegisterUserOutput
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type ResolveEndpointMiddlewareOptions
- type ResolverOptions
- type SearchDashboardsInput
- type SearchDashboardsOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateAccountCustomizationInput
- type UpdateAccountCustomizationOutput
- type UpdateAccountSettingsInput
- type UpdateAccountSettingsOutput
- type UpdateDashboardInput
- type UpdateDashboardOutput
- type UpdateDashboardPermissionsInput
- type UpdateDashboardPermissionsOutput
- type UpdateDashboardPublishedVersionInput
- type UpdateDashboardPublishedVersionOutput
- type UpdateDataSetInput
- type UpdateDataSetOutput
- type UpdateDataSetPermissionsInput
- type UpdateDataSetPermissionsOutput
- type UpdateDataSourceInput
- type UpdateDataSourceOutput
- type UpdateDataSourcePermissionsInput
- type UpdateDataSourcePermissionsOutput
- type UpdateGroupInput
- type UpdateGroupOutput
- type UpdateIAMPolicyAssignmentInput
- type UpdateIAMPolicyAssignmentOutput
- 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 UpdateUserInput
- type UpdateUserOutput
Constants ¶
const ServiceAPIVersion = "2018-04-01"
const ServiceID = "QuickSight"
Functions ¶
func AddResolveEndpointMiddleware ¶
func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func RemoveResolveEndpointMiddleware ¶
func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
Types ¶
type CancelIngestionInput ¶
type CancelIngestionInput struct { // The ID of the dataset used in the ingestion. DataSetId *string // The AWS account ID. AwsAccountId *string // An ID for the ingestion. IngestionId *string }
type CancelIngestionOutput ¶
type CancelIngestionOutput struct { // The AWS request ID for this operation. RequestId *string // An ID for the ingestion. IngestionId *string // The Amazon Resource Name (ARN) for the data ingestion. Arn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Amazon QuickSight API Reference Amazon QuickSight is a fully managed, serverless business intelligence service for the AWS 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 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) 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 a customization for the Amazon QuickSight subscription associated with your AWS account.
func (*Client) CreateDashboard ¶
func (c *Client) CreateDashboard(ctx context.Context, params *CreateDashboardInput, optFns ...func(*Options)) (*CreateDashboardOutput, error)
Creates a dashboard from a template. To first create a template, see the CreateTemplate () API operation. A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. The CreateDashboard, DescribeDashboard, and ListDashboardsByUser API operations act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS 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) CreateGroup ¶
func (c *Client) CreateGroup(ctx context.Context, params *CreateGroupInput, optFns ...func(*Options)) (*CreateGroupOutput, error)
Creates an Amazon QuickSight group. The permissions resource is arn:aws:quicksight:us-east-1::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 QuickSight user to an Amazon QuickSight 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 will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
func (*Client) CreateIngestion ¶
func (c *Client) CreateIngestion(ctx context.Context, params *CreateIngestionInput, optFns ...func(*Options)) (*CreateIngestionOutput, error)
Creates and starts a new SPICE ingestion on a dataset <p>Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see <a href="https://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/">How do I create an IAM policy to control access to Amazon EC2 resources using tags?</a> in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.</p>
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 QuickSight. A namespace allows you to isolate the QuickSight 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 AWS account is subscribed to QuickSight. The namespace must be unique within the AWS account. By default, there is a limit of 100 namespaces per AWS account. To increase your limit, create a ticket with AWS Support.
func (*Client) CreateTemplate ¶
func (c *Client) CreateTemplate(ctx context.Context, params *CreateTemplateInput, optFns ...func(*Options)) (*CreateTemplateOutput, error)
Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard. A template is an entity in QuickSight 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 QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html) in the Amazon QuickSight 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) DeleteAccountCustomization ¶
func (c *Client) DeleteAccountCustomization(ctx context.Context, params *DeleteAccountCustomizationInput, optFns ...func(*Options)) (*DeleteAccountCustomizationOutput, error)
Deletes customizations for the QuickSight subscription on your AWS account.
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) DeleteDataSource ¶
func (c *Client) DeleteDataSource(ctx context.Context, params *DeleteDataSourceInput, optFns ...func(*Options)) (*DeleteDataSourceOutput, error)
Deletes the data source permanently. This action breaks all the datasets that reference the deleted data source.
func (*Client) DeleteGroup ¶
func (c *Client) DeleteGroup(ctx context.Context, params *DeleteGroupInput, optFns ...func(*Options)) (*DeleteGroupOutput, error)
Removes a user group from Amazon QuickSight.
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) 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 APIs for the relevant asset.
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) DeleteUser ¶
func (c *Client) DeleteUser(ctx context.Context, params *DeleteUserInput, optFns ...func(*Options)) (*DeleteUserOutput, error)
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (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) DescribeAccountCustomization ¶
func (c *Client) DescribeAccountCustomization(ctx context.Context, params *DescribeAccountCustomizationInput, optFns ...func(*Options)) (*DescribeAccountCustomizationOutput, error)
Describes the customizations associated with your AWS 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 QuickSight subscription was first created in this AWS Account.
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) 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) 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) 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) DescribeGroup ¶
func (c *Client) DescribeGroup(ctx context.Context, params *DescribeGroupInput, optFns ...func(*Options)) (*DescribeGroupOutput, error)
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
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) DescribeNamespace ¶
func (c *Client) DescribeNamespace(ctx context.Context, params *DescribeNamespaceInput, optFns ...func(*Options)) (*DescribeNamespaceOutput, error)
Describes the current namespace.
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) 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) 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) GetDashboardEmbedUrl ¶
func (c *Client) GetDashboardEmbedUrl(ctx context.Context, params *GetDashboardEmbedUrlInput, optFns ...func(*Options)) (*GetDashboardEmbedUrlOutput, error)
Generates a URL and authorization code that you can embed in your web server code. 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 combination of URL and authorization code:
- They must be used together.
* They can be used one time only.
- They are valid for 5 minutes after you
run this command.
- The resulting user session is valid for 10 hours.
For more information, see Embedding Amazon QuickSight Dashboards (https://docs.aws.amazon.com/quicksight/latest/user/embedding-dashboards.html) in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards (https://docs.aws.amazon.com/quicksight/latest/APIReference/qs-dev-embedded-dashboards.html) in the Amazon QuickSight API Reference.
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 embed in your web server code.
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 QuickSight subscription.
func (*Client) ListDashboards ¶
func (c *Client) ListDashboards(ctx context.Context, params *ListDashboardsInput, optFns ...func(*Options)) (*ListDashboardsOutput, error)
Lists dashboards in an AWS 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 AWS account in an AWS 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 AWS Region that belong to this AWS account.
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 QuickSight.
func (*Client) ListIAMPolicyAssignments ¶
func (c *Client) ListIAMPolicyAssignments(ctx context.Context, params *ListIAMPolicyAssignmentsInput, optFns ...func(*Options)) (*ListIAMPolicyAssignmentsOutput, error)
Lists IAM policy assignments in the current Amazon QuickSight account.
func (*Client) ListIAMPolicyAssignmentsForUser ¶
func (c *Client) ListIAMPolicyAssignmentsForUser(ctx context.Context, params *ListIAMPolicyAssignmentsForUserInput, optFns ...func(*Options)) (*ListIAMPolicyAssignmentsForUserOutput, error)
Lists all 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) ListIngestions ¶
func (c *Client) ListIngestions(ctx context.Context, params *ListIngestionsInput, optFns ...func(*Options)) (*ListIngestionsOutput, error)
Lists the history of SPICE ingestions for a dataset.
func (*Client) ListNamespaces ¶
func (c *Client) ListNamespaces(ctx context.Context, params *ListNamespacesInput, optFns ...func(*Options)) (*ListNamespacesOutput, error)
Lists the namespaces for the specified AWS 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 QuickSight 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 QuickSight 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 AWS 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 AWS account.
func (*Client) ListUserGroups ¶
func (c *Client) ListUserGroups(ctx context.Context, params *ListUserGroupsInput, optFns ...func(*Options)) (*ListUserGroupsOutput, error)
Lists the Amazon QuickSight groups that an Amazon QuickSight 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 QuickSight users belonging to this account.
func (*Client) RegisterUser ¶
func (c *Client) RegisterUser(ctx context.Context, params *RegisterUserInput, optFns ...func(*Options)) (*RegisterUserOutput, error)
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
func (*Client) SearchDashboards ¶
func (c *Client) SearchDashboards(ctx context.Context, params *SearchDashboardsInput, optFns ...func(*Options)) (*SearchDashboardsOutput, error)
Searchs for dashboards that belong to a user.
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 QuickSight 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. QuickSight supports tagging on data set, data source, dashboard, and template. Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:
* You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
- QuickSight doesn't currently support the Tag Editor
for AWS 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) UpdateAccountCustomization ¶
func (c *Client) UpdateAccountCustomization(ctx context.Context, params *UpdateAccountCustomizationInput, optFns ...func(*Options)) (*UpdateAccountCustomizationOutput, error)
Updates customizations associated with the QuickSight subscription on your AWS account.
func (*Client) UpdateAccountSettings ¶
func (c *Client) UpdateAccountSettings(ctx context.Context, params *UpdateAccountSettingsInput, optFns ...func(*Options)) (*UpdateAccountSettingsOutput, error)
Updates the settings for the Amazon QuickSight subscription in your AWS Account.
func (*Client) UpdateDashboard ¶
func (c *Client) UpdateDashboard(ctx context.Context, params *UpdateDashboardInput, optFns ...func(*Options)) (*UpdateDashboardOutput, error)
Updates a dashboard in an AWS account.
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) UpdateDataSet ¶
func (c *Client) UpdateDataSet(ctx context.Context, params *UpdateDataSetInput, optFns ...func(*Options)) (*UpdateDataSetOutput, error)
Updates a dataset.
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) 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.
func (*Client) UpdateTemplate ¶
func (c *Client) UpdateTemplate(ctx context.Context, params *UpdateTemplateInput, optFns ...func(*Options)) (*UpdateTemplateOutput, error)
Updates a template from an existing Amazon QuickSight 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) UpdateUser ¶
func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error)
Updates an Amazon QuickSight user.
type CreateAccountCustomizationInput ¶
type CreateAccountCustomizationInput struct { // The namespace associated with the customization that you're creating. Namespace *string // The customizations you're adding to the QuickSight subscription for the AWS // account. For example, you could add a default theme by setting // AccountCustomization to the midnight theme // (DefaultTheme="arn:aws:quicksight::aws:theme/MIDNIGHT") or to a custom theme // (DefaultTheme="arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639"). AccountCustomization *types.AccountCustomization // The ID for the AWS account that you want to customize QuickSight for. AwsAccountId *string }
type CreateAccountCustomizationOutput ¶
type CreateAccountCustomizationOutput struct { // The AWS request ID for this operation. RequestId *string // The customizations you're adding to the QuickSight subscription for the AWS // account. AccountCustomization *types.AccountCustomization // The namespace associated with the customization you're creating. Namespace *string // The ID for the AWS account that you want to customize QuickSight for. AwsAccountId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateDashboardInput ¶
type CreateDashboardInput struct { // A structure that contains the permissions of the dashboard. You can use this // structure for granting permissions with principal and action information. Permissions []*types.ResourcePermission // The ID for the dashboard, also added to the IAM policy. DashboardId *string // The display name of the dashboard. Name *string // A description for the first version of the dashboard being created. VersionDescription *string // The ID of the AWS account where you want to create the dashboard. AwsAccountId *string // 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 AWS account // where you create the dashboard. ThemeArn *string // 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 // 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 // SourceTemplateARN can contain any AWS Account and any QuickSight-supported AWS // 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. SourceEntity *types.DashboardSourceEntity // 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, QuickSight 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. DashboardPublishOptions *types.DashboardPublishOptions }
type CreateDashboardOutput ¶
type CreateDashboardOutput struct { // The AWS request ID for this operation. RequestId *string // The ID for the dashboard. DashboardId *string // The status of the dashboard creation request. CreationStatus types.ResourceStatus // The ARN of the dashboard, including the version number of the first version that // is created. VersionArn *string // The ARN of the dashboard. Arn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateDataSetInput ¶
type CreateDataSetInput struct { // The row-level security configuration for the data that you want to create. RowLevelPermissionDataSet *types.RowLevelPermissionDataSet // An ID for the dataset that you want to create. This ID is unique per AWS Region // for each AWS account. DataSetId *string // A list of resource permissions on the dataset. Permissions []*types.ResourcePermission // Configures the combination and transformation of the data from the physical // tables. LogicalTableMap map[string]*types.LogicalTable // Indicates whether you want to import the data into SPICE. ImportMode types.DataSetImportMode // Groupings of columns that work together in certain QuickSight features. // Currently, only geospatial hierarchy is supported. ColumnGroups []*types.ColumnGroup // Contains a map of the key-value pairs for the resource tag or tags assigned to // the dataset. Tags []*types.Tag // Declares the physical tables that are available in the underlying data sources. PhysicalTableMap map[string]*types.PhysicalTable // The display name for the dataset. Name *string // The AWS account ID. AwsAccountId *string }
type CreateDataSetOutput ¶
type CreateDataSetOutput struct { // The ID of the ingestion, which is triggered as a result of dataset creation if // the import mode is SPICE. IngestionId *string // The Amazon Resource Name (ARN) of the dataset. Arn *string // The AWS request ID for this operation. RequestId *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 for the dataset that you want to create. This ID is unique per AWS Region // for each AWS account. DataSetId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateDataSourceInput ¶
type CreateDataSourceInput struct { // Secure Socket Layer (SSL) properties that apply when QuickSight connects to your // underlying source. SslProperties *types.SslProperties // A display name for the data source. Name *string // A list of resource permissions on the data source. Permissions []*types.ResourcePermission // The parameters that QuickSight uses to connect to your underlying source. DataSourceParameters *types.DataSourceParameters // The AWS account ID. AwsAccountId *string // The credentials QuickSight that uses to connect to your underlying source. // Currently, only credentials based on user name and password are supported. Credentials *types.DataSourceCredentials // An ID for the data source. This ID is unique per AWS Region for each AWS // account. DataSourceId *string // Contains a map of the key-value pairs for the resource tag or tags assigned to // the data source. Tags []*types.Tag // The type of the data source. Currently, the supported types for this operation // are: ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL, POSTGRESQL, PRESTO, // REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA. Use ListDataSources to // return a list of all data sources. Type types.DataSourceType // Use this parameter only when you want QuickSight to use a VPC connection when // connecting to your underlying source. VpcConnectionProperties *types.VpcConnectionProperties }
type CreateDataSourceOutput ¶
type CreateDataSourceOutput struct { // The AWS request ID for this operation. RequestId *string // The ID of the data source. This ID is unique per AWS Region for each AWS // account. DataSourceId *string // The Amazon Resource Name (ARN) of the data source. Arn *string // The status of creating the data source. CreationStatus types.ResourceStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateGroupInput ¶
type CreateGroupInput struct { // A description for the group that you want to create. Description *string // The ID for the AWS account that the group is in. Currently, you use the ID for // the AWS account that contains your Amazon QuickSight account. AwsAccountId *string // A name for the group that you want to create. GroupName *string // The namespace. Currently, you should set this to default. Namespace *string }
The request object for this operation.
type CreateGroupMembershipInput ¶
type CreateGroupMembershipInput struct { // The name of the group that you want to add the user to. GroupName *string // The name of the user that you want to add to the group membership. MemberName *string // The namespace. Currently, you should set this to default. Namespace *string // The ID for the AWS account that the group is in. Currently, you use the ID for // the AWS account that contains your Amazon QuickSight account. AwsAccountId *string }
type CreateGroupMembershipOutput ¶
type CreateGroupMembershipOutput struct { // The AWS request ID for this operation. RequestId *string // The group member. GroupMember *types.GroupMember // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateGroupOutput ¶
type CreateGroupOutput struct { // The AWS request ID for this operation. RequestId *string // The name of the group. Group *types.Group // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
The response object for this operation.
type CreateIAMPolicyAssignmentInput ¶
type CreateIAMPolicyAssignmentInput struct { // The ID of the AWS account where you want to assign an IAM policy to QuickSight // users or groups. AwsAccountId *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 QuickSight users, groups, or both that you want to assign the policy to. Identities map[string][]*string // The namespace that contains the assignment. Namespace *string // The ARN for the IAM policy to apply to the QuickSight users and groups specified // in this assignment. PolicyArn *string // The name of the assignment. It must be unique within an AWS account. AssignmentName *string }
type CreateIAMPolicyAssignmentOutput ¶
type CreateIAMPolicyAssignmentOutput struct { // The ARN for the IAM policy that is applied to the QuickSight users and groups // specified in this assignment. PolicyArn *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 name of the assignment. This name must be unique within the AWS account. AssignmentName *string // The ID for the assignment. AssignmentId *string // The QuickSight users, groups, or both that the IAM policy is assigned to. Identities map[string][]*string // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateIngestionInput ¶
type CreateIngestionInput struct { // The ID of the dataset used in the ingestion. DataSetId *string // An ID for the ingestion. IngestionId *string // The AWS account ID. AwsAccountId *string }
type CreateIngestionOutput ¶
type CreateIngestionOutput struct { // An ID for the ingestion. IngestionId *string // The AWS request ID for this operation. RequestId *string // The ingestion status. IngestionStatus types.IngestionStatus // The Amazon Resource Name (ARN) for the data ingestion. Arn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateNamespaceInput ¶
type CreateNamespaceInput struct { // The ID for the AWS account that you want to create the QuickSight namespace in. AwsAccountId *string // The tags that you want to associate with the namespace that you're creating. Tags []*types.Tag // The name that you want to use to describe the new namespace. Namespace *string // Specifies the type of your user identity directory. Currently, this supports // users with an identity type of QUICKSIGHT. IdentityStore types.IdentityStore }
type CreateNamespaceOutput ¶
type CreateNamespaceOutput struct { // 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 actions. CreationStatus types.NamespaceStatus // The name of the new namespace that you created. Name *string // Specifies the type of your user identity directory. Currently, this supports // users with an identity type of QUICKSIGHT. IdentityStore types.IdentityStore // The AWS request ID for this operation. RequestId *string // The AWS 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 ARN of the QuickSight namespace you created. Arn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateTemplateAliasInput ¶
type CreateTemplateAliasInput struct { // The version number of the template. TemplateVersionNumber *int64 // 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 QuickSight. AliasName *string // The ID of the AWS account that contains the template that you creating an alias // for. AwsAccountId *string // An ID for the template. TemplateId *string }
type CreateTemplateAliasOutput ¶
type CreateTemplateAliasOutput struct { // Information about the template alias. TemplateAlias *types.TemplateAlias // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateTemplateInput ¶
type CreateTemplateInput struct { // Contains a map of the key-value pairs for the resource tag or tags assigned to // the resource. Tags []*types.Tag // A display name for the template. Name *string // 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 AWS Account and any QuickSight-supported // AWS 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. SourceEntity *types.TemplateSourceEntity // The ID for the AWS account that the group is in. Currently, you use the ID for // the AWS account that contains your Amazon QuickSight account. AwsAccountId *string // An ID for the template that you want to create. This template is unique per AWS // Region in each AWS account. TemplateId *string // A list of resource permissions to be set on the template. Permissions []*types.ResourcePermission // 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 }
type CreateTemplateOutput ¶
type CreateTemplateOutput struct { // The template creation status. CreationStatus types.ResourceStatus // The ID of the template. TemplateId *string // The AWS request ID for this operation. RequestId *string // The ARN for the template, including the version information of the first // version. VersionArn *string // The ARN for the template. Arn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateThemeAliasInput ¶
type CreateThemeAliasInput struct { // The ID of the AWS account that contains the theme for the new theme alias. AwsAccountId *string // An ID for the theme alias. ThemeId *string // The version number of the theme. ThemeVersionNumber *int64 // 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 QuickSight. AliasName *string }
type CreateThemeAliasOutput ¶
type CreateThemeAliasOutput struct { // The AWS request ID for this operation. RequestId *string // Information about the theme alias. ThemeAlias *types.ThemeAlias // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateThemeInput ¶
type CreateThemeInput struct { // An ID for the theme that you want to create. The theme ID is unique per AWS // Region in each AWS account. ThemeId *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 QuickSight. For a list of the // starting themes, use ListThemes or choose Themes from within a QuickSight // analysis. BaseThemeId *string // A map of the key-value pairs for the resource tag or tags that you want to add // to the resource. Tags []*types.Tag // The ID of the AWS account where you want to store the new theme. AwsAccountId *string // A valid grouping of resource permissions to apply to the new theme. Permissions []*types.ResourcePermission // The theme configuration, which contains the theme display properties. Configuration *types.ThemeConfiguration // A display name for the theme. Name *string // 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 }
type CreateThemeOutput ¶
type CreateThemeOutput struct { // The ID of the theme. ThemeId *string // The AWS request ID for this operation. RequestId *string // The Amazon Resource Name (ARN) for the theme. Arn *string // The theme creation status. CreationStatus types.ResourceStatus // The Amazon Resource Name (ARN) for the new theme. VersionArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteAccountCustomizationInput ¶
type DeleteAccountCustomizationInput struct { // The ID for the AWS account that you want to delete QuickSight customizations // from. AwsAccountId *string // The namespace associated with the customization that you're deleting. Namespace *string }
type DeleteAccountCustomizationOutput ¶
type DeleteAccountCustomizationOutput struct { // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteDashboardInput ¶
type DeleteDashboardInput struct { // The ID for the dashboard. DashboardId *string // The ID of the AWS account that contains the dashboard that you're deleting. AwsAccountId *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 }
type DeleteDashboardOutput ¶
type DeleteDashboardOutput struct { // The Secure Socket Layer (SSL) properties that apply for the resource. Arn *string // The AWS request ID for this operation. RequestId *string // The ID of the dashboard. DashboardId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteDataSetInput ¶
type DeleteDataSetInput struct { // The AWS account ID. AwsAccountId *string // The ID for the dataset that you want to create. This ID is unique per AWS Region // for each AWS account. DataSetId *string }
type DeleteDataSetOutput ¶
type DeleteDataSetOutput struct { // The Amazon Resource Name (ARN) of the dataset. Arn *string // The AWS request ID for this operation. RequestId *string // The ID for the dataset that you want to create. This ID is unique per AWS Region // for each AWS account. DataSetId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteDataSourceInput ¶
type DeleteDataSourceInput struct { // The AWS account ID. AwsAccountId *string // The ID of the data source. This ID is unique per AWS Region for each AWS // account. DataSourceId *string }
type DeleteDataSourceOutput ¶
type DeleteDataSourceOutput struct { // The AWS request ID for this operation. RequestId *string // 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 AWS Region for each AWS // account. DataSourceId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteGroupInput ¶
type DeleteGroupInput struct { // The namespace. Currently, you should set this to default. Namespace *string // The ID for the AWS account that the group is in. Currently, you use the ID for // the AWS account that contains your Amazon QuickSight account. AwsAccountId *string // The name of the group that you want to delete. GroupName *string }
type DeleteGroupMembershipInput ¶
type DeleteGroupMembershipInput struct { // The name of the group that you want to delete the user from. GroupName *string // The ID for the AWS account that the group is in. Currently, you use the ID for // the AWS account that contains your Amazon QuickSight account. AwsAccountId *string // The name of the user that you want to delete from the group membership. MemberName *string // The namespace. Currently, you should set this to default. Namespace *string }
type DeleteGroupMembershipOutput ¶
type DeleteGroupMembershipOutput struct { // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteGroupOutput ¶
type DeleteGroupOutput struct { // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteIAMPolicyAssignmentInput ¶
type DeleteIAMPolicyAssignmentInput struct { // The namespace that contains the assignment. Namespace *string // The name of the assignment. AssignmentName *string // The AWS account ID where you want to delete the IAM policy assignment. AwsAccountId *string }
type DeleteIAMPolicyAssignmentOutput ¶
type DeleteIAMPolicyAssignmentOutput struct { // The AWS request ID for this operation. RequestId *string // The name of the assignment. AssignmentName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteNamespaceInput ¶
type DeleteNamespaceInput struct { // The namespace that you want to delete. Namespace *string // The ID for the AWS account that you want to delete the QuickSight namespace // from. AwsAccountId *string }
type DeleteNamespaceOutput ¶
type DeleteNamespaceOutput struct { // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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. AliasName *string // The ID for the template that the specified alias is for. TemplateId *string // The ID of the AWS account that contains the item to delete. AwsAccountId *string }
type DeleteTemplateAliasOutput ¶
type DeleteTemplateAliasOutput struct { // The name for the template alias. AliasName *string // The AWS request ID for this operation. RequestId *string // The Amazon Resource Name (ARN) of the template you want to delete. Arn *string // An ID for the template associated with the deletion. TemplateId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteTemplateInput ¶
type DeleteTemplateInput struct { // 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 // The ID of the AWS account that contains the template that you're deleting. AwsAccountId *string // An ID for the template you want to delete. TemplateId *string }
type DeleteTemplateOutput ¶
type DeleteTemplateOutput struct { // The Amazon Resource Name (ARN) of the resource. Arn *string // An ID for the template. TemplateId *string // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteThemeAliasInput ¶
type DeleteThemeAliasInput struct { // The ID of the AWS account that contains the theme alias to delete. AwsAccountId *string // The ID for the theme that the specified alias is for. ThemeId *string // The unique name for the theme alias to delete. AliasName *string }
type DeleteThemeAliasOutput ¶
type DeleteThemeAliasOutput struct { // An ID for the theme associated with the deletion. ThemeId *string // The Amazon Resource Name (ARN) of the theme resource using the deleted alias. Arn *string // The AWS request ID for this operation. RequestId *string // The name for the theme alias. AliasName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteThemeInput ¶
type DeleteThemeInput struct { // 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 // The ID of the AWS account that contains the theme that you're deleting. AwsAccountId *string // An ID for the theme that you want to delete. ThemeId *string }
type DeleteThemeOutput ¶
type DeleteThemeOutput struct { // The AWS request ID for this operation. RequestId *string // The Amazon Resource Name (ARN) of the resource. Arn *string // An ID for the theme. ThemeId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteUserByPrincipalIdInput ¶
type DeleteUserByPrincipalIdInput struct { // The namespace. Currently, you should set this to default. Namespace *string // The ID for the AWS account that the user is in. Currently, you use the ID for // the AWS account that contains your Amazon QuickSight account. AwsAccountId *string // The principal ID of the user. PrincipalId *string }
type DeleteUserByPrincipalIdOutput ¶
type DeleteUserByPrincipalIdOutput struct { // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteUserInput ¶
type DeleteUserInput struct { // The namespace. Currently, you should set this to default. Namespace *string // The name of the user that you want to delete. UserName *string // The ID for the AWS account that the user is in. Currently, you use the ID for // the AWS account that contains your Amazon QuickSight account. AwsAccountId *string }
type DeleteUserOutput ¶
type DeleteUserOutput struct { // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeAccountCustomizationInput ¶
type DescribeAccountCustomizationInput struct { // The ID for the AWS account that you want to describe QuickSight customizations // for. AwsAccountId *string // The status of the creation of the customization. This is an asynchronous // process. A status of CREATED means that your customization is ready to use. Resolved *bool // The namespace associated with the customization that you're describing. Namespace *string }
type DescribeAccountCustomizationOutput ¶
type DescribeAccountCustomizationOutput struct { // The AWS request ID for this operation. RequestId *string // The namespace associated with the customization that you're describing. Namespace *string // The ID for the AWS account that you want to describe QuickSight customizations // for. AwsAccountId *string // The customizations associated with QuickSight. AccountCustomization *types.AccountCustomization // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeAccountSettingsInput ¶
type DescribeAccountSettingsInput struct { // The ID for the AWS account that contains the QuickSight namespaces that you want // to list. AwsAccountId *string }
type DescribeAccountSettingsOutput ¶
type DescribeAccountSettingsOutput struct { // The settings associated with the QuickSight subscription associated with this // AWS account. This information includes the edition of Amazon QuickSight that you // subscribed to (Standard or Enterprise) and the notification email for the // QuickSight subscription. The QuickSight console, the QuickSight subscription is // sometimes referred to as a QuickSight "account" even though it is technically // not an account, but a subscription in your AWS account. AccountSettings *types.AccountSettings // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeDashboardInput ¶
type DescribeDashboardInput struct { // The ID for the dashboard. DashboardId *string // The alias name. AliasName *string // The ID of the AWS account that contains the dashboard that you're describing. AwsAccountId *string // The version number for the dashboard. If a version number isn't passed, the // latest published dashboard version is described. VersionNumber *int64 }
type DescribeDashboardOutput ¶
type DescribeDashboardOutput struct { // The AWS request ID for this operation. RequestId *string // Information about the dashboard. Dashboard *types.Dashboard // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeDashboardPermissionsInput ¶
type DescribeDashboardPermissionsInput struct { // The ID for the dashboard, also added to the IAM policy. DashboardId *string // The ID of the AWS account that contains the dashboard that you're describing // permissions for. AwsAccountId *string }
type DescribeDashboardPermissionsOutput ¶
type DescribeDashboardPermissionsOutput struct { // The Amazon Resource Name (ARN) of the dashboard. DashboardArn *string // The AWS request ID for this operation. RequestId *string // The ID for the dashboard. DashboardId *string // A structure that contains the permissions for the dashboard. Permissions []*types.ResourcePermission // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeDataSetInput ¶
type DescribeDataSetInput struct { // The AWS account ID. AwsAccountId *string // The ID for the dataset that you want to create. This ID is unique per AWS Region // for each AWS account. DataSetId *string }
type DescribeDataSetOutput ¶
type DescribeDataSetOutput struct { // Information on the dataset. DataSet *types.DataSet // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeDataSetPermissionsInput ¶
type DescribeDataSetPermissionsInput struct { // The AWS account ID. AwsAccountId *string // The ID for the dataset that you want to create. This ID is unique per AWS Region // for each AWS account. DataSetId *string }
type DescribeDataSetPermissionsOutput ¶
type DescribeDataSetPermissionsOutput struct { // A list of resource permissions on the dataset. Permissions []*types.ResourcePermission // The Amazon Resource Name (ARN) of the dataset. DataSetArn *string // The AWS request ID for this operation. RequestId *string // The ID for the dataset that you want to create. This ID is unique per AWS Region // for each AWS account. DataSetId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeDataSourceInput ¶
type DescribeDataSourceInput struct { // The AWS account ID. AwsAccountId *string // The ID of the data source. This ID is unique per AWS Region for each AWS // account. DataSourceId *string }
type DescribeDataSourceOutput ¶
type DescribeDataSourceOutput struct { // The AWS request ID for this operation. RequestId *string // The information on the data source. DataSource *types.DataSource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeDataSourcePermissionsInput ¶
type DescribeDataSourcePermissionsInput struct { // The ID of the data source. This ID is unique per AWS Region for each AWS // account. DataSourceId *string // The AWS account ID. AwsAccountId *string }
type DescribeDataSourcePermissionsOutput ¶
type DescribeDataSourcePermissionsOutput struct { // The ID of the data source. This ID is unique per AWS Region for each AWS // account. DataSourceId *string // The AWS request ID for this operation. RequestId *string // The Amazon Resource Name (ARN) of the data source. DataSourceArn *string // A list of resource permissions on the data source. Permissions []*types.ResourcePermission // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeGroupInput ¶
type DescribeGroupInput struct { // The name of the group that you want to describe. GroupName *string // The namespace. Currently, you should set this to default. Namespace *string // The ID for the AWS account that the group is in. Currently, you use the ID for // the AWS account that contains your Amazon QuickSight account. AwsAccountId *string }
type DescribeGroupOutput ¶
type DescribeGroupOutput struct { // The name of the group. Group *types.Group // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeIAMPolicyAssignmentInput ¶
type DescribeIAMPolicyAssignmentInput struct { // The ID of the AWS account that contains the assignment that you want to // describe. AwsAccountId *string // The namespace that contains the assignment. Namespace *string // The name of the assignment. AssignmentName *string }
type DescribeIAMPolicyAssignmentOutput ¶
type DescribeIAMPolicyAssignmentOutput struct { // The AWS request ID for this operation. RequestId *string // Information describing the IAM policy assignment. IAMPolicyAssignment *types.IAMPolicyAssignment // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeIngestionInput ¶
type DescribeIngestionInput struct { // The AWS account ID. AwsAccountId *string // An ID for the ingestion. IngestionId *string // The ID of the dataset used in the ingestion. DataSetId *string }
type DescribeIngestionOutput ¶
type DescribeIngestionOutput struct { // Information about the ingestion. Ingestion *types.Ingestion // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeNamespaceInput ¶
type DescribeNamespaceInput struct { // The namespace that you want to describe. Namespace *string // The ID for the AWS account that contains the QuickSight namespace that you want // to describe. AwsAccountId *string }
type DescribeNamespaceOutput ¶
type DescribeNamespaceOutput struct { // The information about the namespace that you're describing. The response // includes the namespace ARN, name, AWS Region, creation status, and identity // store. DescribeNamespace also works for namespaces that are in the process of // being created. For incomplete namespaces, this API lists the namespace error // types and messages associated with the creation process. Namespace *types.NamespaceInfoV2 // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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. AliasName *string // The ID of the AWS account that contains the template alias that you're // describing. AwsAccountId *string // The ID for the template. TemplateId *string }
type DescribeTemplateAliasOutput ¶
type DescribeTemplateAliasOutput struct { // The AWS request ID for this operation. RequestId *string // Information about the template alias. TemplateAlias *types.TemplateAlias // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeTemplateInput ¶
type DescribeTemplateInput struct { // The ID of the AWS account that contains the template that you're describing. AwsAccountId *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 // The ID for the template. TemplateId *string }
type DescribeTemplateOutput ¶
type DescribeTemplateOutput struct { // The template structure for the object you want to describe. Template *types.Template // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeTemplatePermissionsInput ¶
type DescribeTemplatePermissionsInput struct { // The ID for the template. TemplateId *string // The ID of the AWS account that contains the template that you're describing. AwsAccountId *string }
type DescribeTemplatePermissionsOutput ¶
type DescribeTemplatePermissionsOutput struct { // A list of resource permissions to be set on the template. Permissions []*types.ResourcePermission // The ID for the template. TemplateId *string // The Amazon Resource Name (ARN) of the template. TemplateArn *string // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeThemeAliasInput ¶
type DescribeThemeAliasInput struct { // The ID of the AWS account that contains the theme alias that you're describing. AwsAccountId *string // The ID for the theme. ThemeId *string // The name of the theme alias that you want to describe. AliasName *string }
type DescribeThemeAliasOutput ¶
type DescribeThemeAliasOutput struct { // Information about the theme alias. ThemeAlias *types.ThemeAlias // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeThemeInput ¶
type DescribeThemeInput struct { // The ID for the theme. 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 ID of the AWS account that contains the theme that you're describing. AwsAccountId *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 }
type DescribeThemeOutput ¶
type DescribeThemeOutput struct { // The AWS request ID for this operation. RequestId *string // The information about the theme that you are describing. Theme *types.Theme // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeThemePermissionsInput ¶
type DescribeThemePermissionsInput struct { // The ID of the AWS account that contains the theme that you're describing. AwsAccountId *string // The ID for the theme that you want to describe permissions for. ThemeId *string }
type DescribeThemePermissionsOutput ¶
type DescribeThemePermissionsOutput struct { // The Amazon Resource Name (ARN) of the theme. ThemeArn *string // The AWS request ID for this operation. RequestId *string // A list of resource permissions set on the theme. Permissions []*types.ResourcePermission // The ID for the theme. ThemeId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeUserInput ¶
type DescribeUserInput struct { // The namespace. Currently, you should set this to default. Namespace *string // The name of the user that you want to describe. UserName *string // The ID for the AWS account that the user is in. Currently, you use the ID for // the AWS account that contains your Amazon QuickSight account. AwsAccountId *string }
type DescribeUserOutput ¶
type DescribeUserOutput struct { // The AWS request ID for this operation. RequestId *string // The user name. User *types.User // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (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 ResolverOptions) (endpoint aws.Endpoint, err error)
type GetDashboardEmbedUrlInput ¶
type GetDashboardEmbedUrlInput struct { // 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 // The ID for the AWS account that contains the dashboard that you're embedding. AwsAccountId *string // The authentication method that the user uses to sign in. IdentityType types.IdentityType // Remove the undo/redo button on the embedded dashboard. The default is FALSE, // which enables the undo/redo button. UndoRedoDisabled *bool // The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT // identity type. You can use this for any Amazon QuickSight 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. UserArn *string // The ID for the dashboard, also added to the IAM policy. DashboardId *string }
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 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 AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetSessionEmbedUrlInput ¶
type GetSessionEmbedUrlInput struct { // How many minutes the session is valid. The session lifetime must be 15-600 // minutes. SessionLifetimeInMinutes *int64 // The ID for the AWS account that contains the QuickSight session that you're // embedding. AwsAccountId *string // The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT // identity type. You can use this for any Amazon QuickSight 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. UserArn *string // The entry point for the embedded session. EntryPoint *string }
type GetSessionEmbedUrlOutput ¶
type GetSessionEmbedUrlOutput struct { // A single-use URL that you can put into your server-side web page to embed your // QuickSight session. This URL is valid for 5 minutes. The API 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 AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type ListDashboardVersionsInput ¶
type ListDashboardVersionsInput struct { // 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 ID of the AWS account that contains the dashboard that you're listing // versions for. AwsAccountId *string // The ID for the dashboard. DashboardId *string }
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 AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListDashboardsInput ¶
type ListDashboardsInput struct { // The ID of the AWS account that contains the dashboards that you're listing. AwsAccountId *string // The token for the next set of results, or null if there are no more results. NextToken *string // The maximum number of results to be returned per request. MaxResults *int32 }
type ListDashboardsOutput ¶
type ListDashboardsOutput struct { // A structure that contains all of the dashboards in your AWS 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 AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListDataSetsInput ¶
type ListDataSetsInput struct { // The maximum number of results to be returned per request. MaxResults *int32 // The AWS account ID. AwsAccountId *string // The token for the next set of results, or null if there are no more results. NextToken *string }
type ListDataSetsOutput ¶
type ListDataSetsOutput struct { // The list of dataset summaries. DataSetSummaries []*types.DataSetSummary // The AWS request ID for this operation. RequestId *string // 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 }
type ListDataSourcesInput ¶
type ListDataSourcesInput struct { // 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 AWS account ID. AwsAccountId *string }
type ListDataSourcesOutput ¶
type ListDataSourcesOutput struct { // The token for the next set of results, or null if there are no more results. NextToken *string // The AWS request ID for this operation. RequestId *string // A list of data sources. DataSources []*types.DataSource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListGroupMembershipsInput ¶
type ListGroupMembershipsInput struct { // 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 // The name of the group that you want to see a membership list of. GroupName *string // The namespace. Currently, you should set this to default. Namespace *string // The ID for the AWS account that the group is in. Currently, you use the ID for // the AWS account that contains your Amazon QuickSight account. AwsAccountId *string }
type ListGroupMembershipsOutput ¶
type ListGroupMembershipsOutput struct { // The AWS request ID for this operation. RequestId *string // A pagination token that can be used in a subsequent request. NextToken *string // The list of the members of the group. GroupMemberList []*types.GroupMember // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListGroupsInput ¶
type ListGroupsInput struct { // A pagination token that can be used in a subsequent request. NextToken *string // The maximum number of results to return. MaxResults *int32 // The ID for the AWS account that the group is in. Currently, you use the ID for // the AWS account that contains your Amazon QuickSight account. AwsAccountId *string // The namespace. Currently, you should set this to default. Namespace *string }
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 AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListIAMPolicyAssignmentsForUserInput ¶
type ListIAMPolicyAssignmentsForUserInput struct { // The ID of the AWS account that contains the assignments. AwsAccountId *string // The namespace of the assignment. Namespace *string // The name of the user. UserName *string // The token for the next set of results, or null if there are no more results. NextToken *string // The maximum number of results to be returned per request. MaxResults *int32 }
type ListIAMPolicyAssignmentsForUserOutput ¶
type ListIAMPolicyAssignmentsForUserOutput struct { // The token for the next set of results, or null if there are no more results. NextToken *string // The AWS request ID for this operation. RequestId *string // The active assignments for this user. ActiveAssignments []*types.ActiveIAMPolicyAssignment // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListIAMPolicyAssignmentsInput ¶
type ListIAMPolicyAssignmentsInput struct { // 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 status of the assignments. AssignmentStatus types.AssignmentStatus // The ID of the AWS account that contains these IAM policy assignments. AwsAccountId *string // The namespace for the assignments. Namespace *string }
type ListIAMPolicyAssignmentsOutput ¶
type ListIAMPolicyAssignmentsOutput struct { // The AWS request ID for this operation. RequestId *string // The token for the next set of results, or null if there are no more results. NextToken *string // Information describing the IAM policy assignments. IAMPolicyAssignments []*types.IAMPolicyAssignmentSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListIngestionsInput ¶
type ListIngestionsInput struct { // The token for the next set of results, or null if there are no more results. NextToken *string // The AWS account ID. AwsAccountId *string // The ID of the dataset used in the ingestion. DataSetId *string // The maximum number of results to be returned per request. MaxResults *int32 }
type ListIngestionsOutput ¶
type ListIngestionsOutput struct { // A list of the ingestions. Ingestions []*types.Ingestion // The AWS request ID for this operation. RequestId *string // 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 }
type ListNamespacesInput ¶
type ListNamespacesInput struct { // The ID for the AWS account that contains the QuickSight namespaces that you want // to list. AwsAccountId *string // The maximum number of results to return. MaxResults *int32 // A pagination token that can be used in a subsequent request. NextToken *string }
type ListNamespacesOutput ¶
type ListNamespacesOutput struct { // The information about the namespaces in this AWS account. The response includes // the namespace ARN, name, AWS Region, notification email address, creation // status, and identity store. Namespaces []*types.NamespaceInfoV2 // The AWS request ID for this operation. RequestId *string // A pagination token that can be used in a subsequent request. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource that you want a list of tags for. ResourceArn *string }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The AWS request ID for this operation. RequestId *string // 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 }
type ListTemplateAliasesInput ¶
type ListTemplateAliasesInput struct { // 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 ID for the template. TemplateId *string // The ID of the AWS account that contains the template aliases that you're // listing. AwsAccountId *string }
type ListTemplateAliasesOutput ¶
type ListTemplateAliasesOutput struct { // A structure containing the list of the template's aliases. TemplateAliasList []*types.TemplateAlias // The token for the next set of results, or null if there are no more results. NextToken *string // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTemplateVersionsInput ¶
type ListTemplateVersionsInput struct { // The ID for the template. TemplateId *string // The maximum number of results to be returned per request. MaxResults *int32 // The ID of the AWS account that contains the templates that you're listing. AwsAccountId *string // The token for the next set of results, or null if there are no more results. NextToken *string }
type ListTemplateVersionsOutput ¶
type ListTemplateVersionsOutput struct { // A structure containing a list of all the versions of the specified template. TemplateVersionSummaryList []*types.TemplateVersionSummary // The AWS request ID for this operation. RequestId *string // 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 }
type ListTemplatesInput ¶
type ListTemplatesInput struct { // The token for the next set of results, or null if there are no more results. NextToken *string // The maximum number of results to be returned per request. MaxResults *int32 // The ID of the AWS account that contains the templates that you're listing. AwsAccountId *string }
type ListTemplatesOutput ¶
type ListTemplatesOutput struct { // The token for the next set of results, or null if there are no more results. NextToken *string // The AWS request ID for this operation. RequestId *string // A structure containing information about the templates in the list. TemplateSummaryList []*types.TemplateSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListThemeAliasesInput ¶
type ListThemeAliasesInput struct { // The maximum number of results to be returned per request. MaxResults *int32 // The ID of the AWS account that contains the theme aliases that you're listing. AwsAccountId *string // The token for the next set of results, or null if there are no more results. NextToken *string // The ID for the theme. ThemeId *string }
type ListThemeAliasesOutput ¶
type ListThemeAliasesOutput struct { // A structure containing the list of the theme's aliases. ThemeAliasList []*types.ThemeAlias // The token for the next set of results, or null if there are no more results. NextToken *string // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListThemeVersionsInput ¶
type ListThemeVersionsInput struct { // The ID for the theme. ThemeId *string // The maximum number of results to be returned per request. MaxResults *int32 // The ID of the AWS account that contains the themes that you're listing. AwsAccountId *string // The token for the next set of results, or null if there are no more results. NextToken *string }
type ListThemeVersionsOutput ¶
type ListThemeVersionsOutput struct { // The AWS request ID for this operation. RequestId *string // A structure containing a list of all the versions of the specified theme. ThemeVersionSummaryList []*types.ThemeVersionSummary // 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 }
type ListThemesInput ¶
type ListThemesInput struct { // The maximum number of results to be returned per request. MaxResults *int32 // The ID of the AWS account that contains the themes that you're listing. AwsAccountId *string // 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 QuickSight. // // * QUICKSIGHT - Display // only the starting themes defined by QuickSight. Type types.ThemeType }
type ListThemesOutput ¶
type ListThemesOutput struct { // The token for the next set of results, or null if there are no more results. NextToken *string // The AWS request ID for this operation. RequestId *string // Information about the themes in the list. ThemeSummaryList []*types.ThemeSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListUserGroupsInput ¶
type ListUserGroupsInput struct { // The maximum number of results to return from this request. MaxResults *int32 // The namespace. Currently, you should set this to default. Namespace *string // A pagination token that can be used in a subsequent request. NextToken *string // The AWS account ID that the user is in. Currently, you use the ID for the AWS // account that contains your Amazon QuickSight account. AwsAccountId *string // The Amazon QuickSight user name that you want to list group memberships for. UserName *string }
type ListUserGroupsOutput ¶
type ListUserGroupsOutput struct { // The AWS request ID for this operation. RequestId *string // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListUsersInput ¶
type ListUsersInput struct { // 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 // The namespace. Currently, you should set this to default. Namespace *string // The ID for the AWS account that the user is in. Currently, you use the ID for // the AWS account that contains your Amazon QuickSight account. AwsAccountId *string }
type ListUsersOutput ¶
type ListUsersOutput struct { // The list of users. UserList []*types.User // The AWS request ID for this operation. RequestId *string // A pagination token that can be used in a subsequent request. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
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 credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions ResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetCredentials ¶
func (o Options) GetCredentials() aws.CredentialsProvider
func (Options) GetEndpointOptions ¶
func (o Options) GetEndpointOptions() ResolverOptions
func (Options) GetEndpointResolver ¶
func (o Options) GetEndpointResolver() EndpointResolver
func (Options) GetHTTPSignerV4 ¶
func (o Options) GetHTTPSignerV4() HTTPSignerV4
func (Options) GetRegion ¶
func (Options) GetRetryer ¶
type RegisterUserInput ¶
type RegisterUserInput struct { // Amazon QuickSight supports several ways of managing the identity of users. This // parameter accepts two values: // // * IAM: A user whose identity maps to an // existing IAM user or role. // // * QUICKSIGHT: A user whose identity is owned and // managed internally by Amazon QuickSight. IdentityType types.IdentityType // 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 // QuickSight 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 // (https://awscli.amazonaws.com/v2/documentation/api/latest/reference/sts/assume-role.html) // in the AWS CLI Reference. SessionName *string // The ARN of the IAM user or role that you are registering with Amazon QuickSight. IamArn *string // The Amazon QuickSight 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 // QuickSight settings. // // * RESTRICTED_READER: This role isn't currently // available for use. // // * RESTRICTED_AUTHOR: This role isn't currently available // for use. UserRole types.UserRole // The namespace. Currently, you should set this to default. Namespace *string // The ID for the AWS account that the user is in. Currently, you use the ID for // the AWS account that contains your Amazon QuickSight account. AwsAccountId *string // (Enterprise edition only) The name of the custom permissions profile that you // want to assign to this user. Currently, custom permissions profile names are // assigned to permissions profiles in the QuickSight console. You use this API to // assign the named set of permissions to a QuickSight user. <p>Customizing // permissions in the QuickSight UI allows you to control a user's access to the // following operations:</p> <ul> <li> <p></p> </li> <li> <p></p> </li> <li> // <p></p> </li> <li> <p></p> </li> </ul> <p>QuickSight custom permissions are // applied through IAM policies. Therefore, they override the permissions typically // granted by assigning QuickSight users to one of the default security cohorts // (admin, author, reader) in QuickSight.</p> <p>This feature is available only to // QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation // for Single Sign-On (SSO).</p> CustomPermissionsName *string // The email address of the user that you want to register. Email *string // The Amazon QuickSight user name that you want to create for the user you are // registering. UserName *string }
type RegisterUserOutput ¶
type RegisterUserOutput struct { // The AWS request ID for this operation. RequestId *string // 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 // The user name. User *types.User // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
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 ResolveEndpointMiddlewareOptions ¶
type ResolveEndpointMiddlewareOptions interface { GetEndpointResolver() EndpointResolver GetEndpointOptions() ResolverOptions }
type ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
type SearchDashboardsInput ¶
type SearchDashboardsInput struct { // The maximum number of results to be returned per request. MaxResults *int32 // The ID of the AWS account that contains the user whose dashboards you're // searching for. 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" // } ] Filters []*types.DashboardSearchFilter // The token for the next set of results, or null if there are no more results. NextToken *string }
type SearchDashboardsOutput ¶
type SearchDashboardsOutput struct { // The AWS request ID for this operation. RequestId *string // 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 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource that you want to tag. ResourceArn *string // Contains a map of the key-value pairs for the resource tag or tags assigned to // the resource. Tags []*types.Tag }
type TagResourceOutput ¶
type TagResourceOutput struct { // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceInput struct { // The keys of the key-value pairs for the resource tag or tags assigned to the // resource. TagKeys []*string // The Amazon Resource Name (ARN) of the resource that you want to untag. ResourceArn *string }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateAccountCustomizationInput ¶
type UpdateAccountCustomizationInput struct { // The ID for the AWS account that you want to update QuickSight customizations // for. AwsAccountId *string // The namespace associated with the customization that you're updating. Namespace *string // The customizations you want to update in QuickSight. AccountCustomization *types.AccountCustomization }
type UpdateAccountCustomizationOutput ¶
type UpdateAccountCustomizationOutput struct { // The AWS request ID for this operation. RequestId *string // The customizations associated with your QuickSight subscription. AccountCustomization *types.AccountCustomization // The ID for the AWS account that you want to update QuickSight customizations // for. AwsAccountId *string // The namespace associated with the customization that you're updating. Namespace *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateAccountSettingsInput ¶
type UpdateAccountSettingsInput struct { // The ID for the AWS account that contains the QuickSight namespaces that you want // to list. AwsAccountId *string // Email address used to send notifications regarding administration of QuickSight. NotificationEmail *string // The default namespace for this AWS Account. Currently, the default is default. // IAM users who register for the first time with QuickSight provide an email that // becomes associated with the default namespace. DefaultNamespace *string }
type UpdateAccountSettingsOutput ¶
type UpdateAccountSettingsOutput struct { // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateDashboardInput ¶
type UpdateDashboardInput struct { // 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 AWS Account and any QuickSight-supported AWS // 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. SourceEntity *types.DashboardSourceEntity // 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, QuickSight 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. DashboardPublishOptions *types.DashboardPublishOptions // 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 AWS // account where you create the dashboard. ThemeArn *string // 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 ID for the dashboard. DashboardId *string // A description for the first version of the dashboard being created. VersionDescription *string // The ID of the AWS account that contains the dashboard that you're updating. AwsAccountId *string // The display name of the dashboard. Name *string }
type UpdateDashboardOutput ¶
type UpdateDashboardOutput struct { // The AWS request ID for this operation. RequestId *string // The Amazon Resource Name (ARN) of the resource. Arn *string // The ARN of the dashboard, including the version number. VersionArn *string // The HTTP status of the request. Status *int32 // The ID for the dashboard. DashboardId *string // The creation status of the request. CreationStatus types.ResourceStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateDashboardPermissionsInput ¶
type UpdateDashboardPermissionsInput struct { // The ID of the AWS account that contains the dashboard whose permissions you're // updating. AwsAccountId *string // The ID for the dashboard. DashboardId *string // The permissions that you want to grant on this resource. GrantPermissions []*types.ResourcePermission // The permissions that you want to revoke from this resource. RevokePermissions []*types.ResourcePermission }
type UpdateDashboardPermissionsOutput ¶
type UpdateDashboardPermissionsOutput struct { // The Amazon Resource Name (ARN) of the dashboard. DashboardArn *string // Information about the permissions on the dashboard. Permissions []*types.ResourcePermission // The ID for the dashboard. DashboardId *string // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateDashboardPublishedVersionInput ¶
type UpdateDashboardPublishedVersionInput struct { // The version number of the dashboard. VersionNumber *int64 // The ID of the AWS account that contains the dashboard that you're updating. AwsAccountId *string // The ID for the dashboard. DashboardId *string }
type UpdateDashboardPublishedVersionOutput ¶
type UpdateDashboardPublishedVersionOutput struct { // The Amazon Resource Name (ARN) of the dashboard. DashboardArn *string // The ID for the dashboard. DashboardId *string // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateDataSetInput ¶
type UpdateDataSetInput struct { // Groupings of columns that work together in certain QuickSight features. // Currently, only geospatial hierarchy is supported. ColumnGroups []*types.ColumnGroup // Indicates whether you want to import the data into SPICE. ImportMode types.DataSetImportMode // The row-level security configuration for the data you want to create. RowLevelPermissionDataSet *types.RowLevelPermissionDataSet // Declares the physical tables that are available in the underlying data sources. PhysicalTableMap map[string]*types.PhysicalTable // The display name for the dataset. Name *string // Configures the combination and transformation of the data from the physical // tables. LogicalTableMap map[string]*types.LogicalTable // The ID for the dataset that you want to update. This ID is unique per AWS Region // for each AWS account. DataSetId *string // The AWS account ID. AwsAccountId *string }
type UpdateDataSetOutput ¶
type UpdateDataSetOutput struct { // The ID of the ingestion, which is triggered as a result of dataset creation if // the import mode is SPICE. IngestionId *string // 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 AWS Region // for each AWS 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 AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateDataSetPermissionsInput ¶
type UpdateDataSetPermissionsInput struct { // The AWS account ID. AwsAccountId *string // The ID for the dataset whose permissions you want to update. This ID is unique // per AWS Region for each AWS account. 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 }
type UpdateDataSetPermissionsOutput ¶
type UpdateDataSetPermissionsOutput struct { // The ID for the dataset whose permissions you want to update. This ID is unique // per AWS Region for each AWS account. DataSetId *string // The Amazon Resource Name (ARN) of the dataset. DataSetArn *string // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateDataSourceInput ¶
type UpdateDataSourceInput struct { // A display name for the data source. Name *string // The credentials that QuickSight that uses to connect to your underlying source. // Currently, only credentials based on user name and password are supported. Credentials *types.DataSourceCredentials // The ID of the data source. This ID is unique per AWS Region for each AWS // account. DataSourceId *string // The AWS account ID. AwsAccountId *string // The parameters that QuickSight uses to connect to your underlying source. DataSourceParameters *types.DataSourceParameters // Secure Socket Layer (SSL) properties that apply when QuickSight connects to your // underlying source. SslProperties *types.SslProperties // Use this parameter only when you want QuickSight to use a VPC connection when // connecting to your underlying source. VpcConnectionProperties *types.VpcConnectionProperties }
type UpdateDataSourceOutput ¶
type UpdateDataSourceOutput struct { // The update status of the data source's last update. UpdateStatus types.ResourceStatus // The ID of the data source. This ID is unique per AWS Region for each AWS // account. DataSourceId *string // The AWS request ID for this operation. RequestId *string // The Amazon Resource Name (ARN) of the data source. Arn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateDataSourcePermissionsInput ¶
type UpdateDataSourcePermissionsInput struct { // The ID of the data source. This ID is unique per AWS Region for each AWS // account. DataSourceId *string // A list of resource permissions that you want to grant on the data source. GrantPermissions []*types.ResourcePermission // The AWS account ID. AwsAccountId *string // A list of resource permissions that you want to revoke on the data source. RevokePermissions []*types.ResourcePermission }
type UpdateDataSourcePermissionsOutput ¶
type UpdateDataSourcePermissionsOutput struct { // The AWS request ID for this operation. RequestId *string // The ID of the data source. This ID is unique per AWS Region for each AWS // account. DataSourceId *string // The Amazon Resource Name (ARN) of the data source. DataSourceArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateGroupInput ¶
type UpdateGroupInput struct { // The ID for the AWS account that the group is in. Currently, you use the ID for // the AWS account that contains your Amazon QuickSight account. AwsAccountId *string // The namespace. Currently, you should set this to default. Namespace *string // The description for the group that you want to update. Description *string // The name of the group that you want to update. GroupName *string }
type UpdateGroupOutput ¶
type UpdateGroupOutput struct { // The AWS request ID for this operation. RequestId *string // The name of the group. Group *types.Group // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateIAMPolicyAssignmentInput ¶
type UpdateIAMPolicyAssignmentInput struct { // The ARN for the IAM policy to apply to the QuickSight users and groups specified // in this assignment. PolicyArn *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 name of the assignment. This name must be unique within an AWS account. AssignmentName *string // The QuickSight users, groups, or both that you want to assign the policy to. Identities map[string][]*string // The ID of the AWS account that contains the IAM policy assignment. AwsAccountId *string // The namespace of the assignment. Namespace *string }
type UpdateIAMPolicyAssignmentOutput ¶
type UpdateIAMPolicyAssignmentOutput struct { // The ARN for the IAM policy applied to the QuickSight users and groups specified // in this assignment. PolicyArn *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 name of the assignment. AssignmentName *string // The QuickSight users, groups, or both that the IAM policy is assigned to. Identities map[string][]*string // The AWS request ID for this operation. RequestId *string // The ID of the assignment. AssignmentId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateTemplateAliasInput ¶
type UpdateTemplateAliasInput struct { // The ID of the AWS account that contains the template alias that you're updating. AwsAccountId *string // The version number of the template. TemplateVersionNumber *int64 // 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. AliasName *string // The ID for the template. TemplateId *string }
type UpdateTemplateAliasOutput ¶
type UpdateTemplateAliasOutput struct { // The AWS request ID for this operation. RequestId *string // The template alias. TemplateAlias *types.TemplateAlias // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateTemplateInput ¶
type UpdateTemplateInput struct { // 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 AWS Account and any QuickSight-supported // AWS 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. SourceEntity *types.TemplateSourceEntity // 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 // The ID for the template. TemplateId *string // The ID of the AWS account that contains the template that you're updating. AwsAccountId *string // The name for the template. Name *string }
type UpdateTemplateOutput ¶
type UpdateTemplateOutput struct { // The creation status of the template. CreationStatus types.ResourceStatus // The Amazon Resource Name (ARN) for the template. Arn *string // The ARN for the template, including the version information of the first // version. VersionArn *string // The AWS request ID for this operation. RequestId *string // The ID for the template. TemplateId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateTemplatePermissionsInput ¶
type UpdateTemplatePermissionsInput struct { // A list of resource permissions to be revoked from the template. RevokePermissions []*types.ResourcePermission // The ID for the template. TemplateId *string // A list of resource permissions to be granted on the template. GrantPermissions []*types.ResourcePermission // The ID of the AWS account that contains the template. AwsAccountId *string }
type UpdateTemplatePermissionsOutput ¶
type UpdateTemplatePermissionsOutput struct { // The Amazon Resource Name (ARN) of the template. TemplateArn *string // The ID for the template. TemplateId *string // The AWS request ID for this operation. RequestId *string // A list of resource permissions to be set on the template. Permissions []*types.ResourcePermission // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateThemeAliasInput ¶
type UpdateThemeAliasInput struct { // The version number of the theme that the alias should reference. ThemeVersionNumber *int64 // The name of the theme alias that you want to update. AliasName *string // The ID of the AWS account that contains the theme alias that you're updating. AwsAccountId *string // The ID for the theme. ThemeId *string }
type UpdateThemeAliasOutput ¶
type UpdateThemeAliasOutput struct { // Information about the theme alias. ThemeAlias *types.ThemeAlias // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateThemeInput ¶
type UpdateThemeInput struct { // The theme configuration, which contains the theme display properties. Configuration *types.ThemeConfiguration // The ID for the theme. ThemeId *string // The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. // All themes initially inherit from a default QuickSight theme. BaseThemeId *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 // The name for the theme. Name *string // The ID of the AWS account that contains the theme that you're updating. AwsAccountId *string }
type UpdateThemeOutput ¶
type UpdateThemeOutput struct { // The ID for the theme. ThemeId *string // The AWS request ID for this operation. RequestId *string // The Amazon Resource Name (ARN) for the new version of the theme. VersionArn *string // The creation status of the theme. CreationStatus types.ResourceStatus // The Amazon Resource Name (ARN) for the theme. Arn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateThemePermissionsInput ¶
type UpdateThemePermissionsInput struct { // A list of resource permissions to be revoked from the theme. RevokePermissions []*types.ResourcePermission // The ID for the theme. ThemeId *string // The ID of the AWS account that contains the theme. AwsAccountId *string // A list of resource permissions to be granted for the theme. GrantPermissions []*types.ResourcePermission }
type UpdateThemePermissionsOutput ¶
type UpdateThemePermissionsOutput struct { // The resulting list of resource permissions for the theme. Permissions []*types.ResourcePermission // The ID for the theme. ThemeId *string // The Amazon Resource Name (ARN) of the theme. ThemeArn *string // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateUserInput ¶
type UpdateUserInput struct { // The namespace. Currently, you should set this to default. Namespace *string // The name of the custom permissions profile that you want to assign to this user. // Currently, custom permissions profile names are assigned to permissions profiles // in the QuickSight console. You use this API to assign the named set of // permissions to a QuickSight user. CustomPermissionsName *string // The email address of the user that you want to update. Email *string // The ID for the AWS account that the user is in. Currently, you use the ID for // the AWS account that contains your Amazon QuickSight account. AwsAccountId *string // The Amazon QuickSight user name that you want to update. UserName *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 // The Amazon QuickSight role of 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 // QuickSight settings. Role types.UserRole }
type UpdateUserOutput ¶
type UpdateUserOutput struct { // The Amazon QuickSight user. User *types.User // The AWS request ID for this operation. RequestId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_CancelIngestion.go api_op_CreateAccountCustomization.go api_op_CreateDashboard.go api_op_CreateDataSet.go api_op_CreateDataSource.go api_op_CreateGroup.go api_op_CreateGroupMembership.go api_op_CreateIAMPolicyAssignment.go api_op_CreateIngestion.go api_op_CreateNamespace.go api_op_CreateTemplate.go api_op_CreateTemplateAlias.go api_op_CreateTheme.go api_op_CreateThemeAlias.go api_op_DeleteAccountCustomization.go api_op_DeleteDashboard.go api_op_DeleteDataSet.go api_op_DeleteDataSource.go api_op_DeleteGroup.go api_op_DeleteGroupMembership.go api_op_DeleteIAMPolicyAssignment.go api_op_DeleteNamespace.go api_op_DeleteTemplate.go api_op_DeleteTemplateAlias.go api_op_DeleteTheme.go api_op_DeleteThemeAlias.go api_op_DeleteUser.go api_op_DeleteUserByPrincipalId.go api_op_DescribeAccountCustomization.go api_op_DescribeAccountSettings.go api_op_DescribeDashboard.go api_op_DescribeDashboardPermissions.go api_op_DescribeDataSet.go api_op_DescribeDataSetPermissions.go api_op_DescribeDataSource.go api_op_DescribeDataSourcePermissions.go api_op_DescribeGroup.go api_op_DescribeIAMPolicyAssignment.go api_op_DescribeIngestion.go api_op_DescribeNamespace.go api_op_DescribeTemplate.go api_op_DescribeTemplateAlias.go api_op_DescribeTemplatePermissions.go api_op_DescribeTheme.go api_op_DescribeThemeAlias.go api_op_DescribeThemePermissions.go api_op_DescribeUser.go api_op_GetDashboardEmbedUrl.go api_op_GetSessionEmbedUrl.go api_op_ListDashboardVersions.go api_op_ListDashboards.go api_op_ListDataSets.go api_op_ListDataSources.go api_op_ListGroupMemberships.go api_op_ListGroups.go api_op_ListIAMPolicyAssignments.go api_op_ListIAMPolicyAssignmentsForUser.go api_op_ListIngestions.go api_op_ListNamespaces.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_ListUserGroups.go api_op_ListUsers.go api_op_RegisterUser.go api_op_SearchDashboards.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateAccountCustomization.go api_op_UpdateAccountSettings.go api_op_UpdateDashboard.go api_op_UpdateDashboardPermissions.go api_op_UpdateDashboardPublishedVersion.go api_op_UpdateDataSet.go api_op_UpdateDataSetPermissions.go api_op_UpdateDataSource.go api_op_UpdateDataSourcePermissions.go api_op_UpdateGroup.go api_op_UpdateIAMPolicyAssignment.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_UpdateUser.go deserializers.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.1.0
- Published
- Sep 29, 2020
- Platform
- js/wasm
- Imports
- 26 packages
- Last checked
- 1 second ago –
Tools for package owners.