repo_name stringlengths 1 52 | repo_creator stringclasses 6
values | programming_language stringclasses 4
values | code stringlengths 0 9.68M | num_lines int64 1 234k |
|---|---|---|---|---|
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists the history of SPICE ingestions for a dataset.
func (c *Client) ListIngestions(ctx context.Context, params *ListIngestionsInput, optFns ...func(*Options)) (*ListIngestionsOutput, error) {
if params == nil {
params = &ListIngestionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListIngestions", params, optFns, c.addOperationListIngestionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListIngestionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListIngestionsInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset used in the ingestion.
//
// This member is required.
DataSetId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
noSmithyDocumentSerde
}
type ListIngestionsOutput struct {
// A list of the ingestions.
Ingestions []types.Ingestion
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListIngestionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListIngestions{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListIngestions{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListIngestionsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListIngestions(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListIngestionsAPIClient is a client that implements the ListIngestions
// operation.
type ListIngestionsAPIClient interface {
ListIngestions(context.Context, *ListIngestionsInput, ...func(*Options)) (*ListIngestionsOutput, error)
}
var _ ListIngestionsAPIClient = (*Client)(nil)
// ListIngestionsPaginatorOptions is the paginator options for ListIngestions
type ListIngestionsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListIngestionsPaginator is a paginator for ListIngestions
type ListIngestionsPaginator struct {
options ListIngestionsPaginatorOptions
client ListIngestionsAPIClient
params *ListIngestionsInput
nextToken *string
firstPage bool
}
// NewListIngestionsPaginator returns a new ListIngestionsPaginator
func NewListIngestionsPaginator(client ListIngestionsAPIClient, params *ListIngestionsInput, optFns ...func(*ListIngestionsPaginatorOptions)) *ListIngestionsPaginator {
if params == nil {
params = &ListIngestionsInput{}
}
options := ListIngestionsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListIngestionsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListIngestionsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListIngestions page.
func (p *ListIngestionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIngestionsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListIngestions(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListIngestions(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "ListIngestions",
}
}
| 236 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists the namespaces for the specified Amazon Web Services account. This
// operation doesn't list deleted namespaces.
func (c *Client) ListNamespaces(ctx context.Context, params *ListNamespacesInput, optFns ...func(*Options)) (*ListNamespacesOutput, error) {
if params == nil {
params = &ListNamespacesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListNamespaces", params, optFns, c.addOperationListNamespacesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListNamespacesOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListNamespacesInput struct {
// The ID for the Amazon Web Services account that contains the Amazon QuickSight
// namespaces that you want to list.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to return.
MaxResults *int32
// A unique pagination token that can be used in a subsequent request. You will
// receive a pagination token in the response body of a previous ListNameSpaces
// API call if there is more data that can be returned. To receive the data, make
// another ListNamespaces API call with the returned token to retrieve the next
// page of data. Each token is valid for 24 hours. If you try to make a
// ListNamespaces API call with an expired token, you will receive a HTTP 400
// InvalidNextTokenException error.
NextToken *string
noSmithyDocumentSerde
}
type ListNamespacesOutput struct {
// The information about the namespaces in this Amazon Web Services account. The
// response includes the namespace ARN, name, Amazon Web Services Region,
// notification email address, creation status, and identity store.
Namespaces []types.NamespaceInfoV2
// A unique pagination token that can be used in a subsequent request. Receiving
// NextToken in your response inticates that there is more data that can be
// returned. To receive the data, make another ListNamespaces API call with the
// returned token to retrieve the next page of data. Each token is valid for 24
// hours. If you try to make a ListNamespaces API call with an expired token, you
// will receive a HTTP 400 InvalidNextTokenException error.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListNamespacesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListNamespaces{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListNamespaces{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListNamespacesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListNamespaces(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListNamespacesAPIClient is a client that implements the ListNamespaces
// operation.
type ListNamespacesAPIClient interface {
ListNamespaces(context.Context, *ListNamespacesInput, ...func(*Options)) (*ListNamespacesOutput, error)
}
var _ ListNamespacesAPIClient = (*Client)(nil)
// ListNamespacesPaginatorOptions is the paginator options for ListNamespaces
type ListNamespacesPaginatorOptions struct {
// The maximum number of results to return.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListNamespacesPaginator is a paginator for ListNamespaces
type ListNamespacesPaginator struct {
options ListNamespacesPaginatorOptions
client ListNamespacesAPIClient
params *ListNamespacesInput
nextToken *string
firstPage bool
}
// NewListNamespacesPaginator returns a new ListNamespacesPaginator
func NewListNamespacesPaginator(client ListNamespacesAPIClient, params *ListNamespacesInput, optFns ...func(*ListNamespacesPaginatorOptions)) *ListNamespacesPaginator {
if params == nil {
params = &ListNamespacesInput{}
}
options := ListNamespacesPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListNamespacesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListNamespacesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListNamespaces page.
func (p *ListNamespacesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListNamespacesOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListNamespaces(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListNamespaces(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "ListNamespaces",
}
}
| 246 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists the refresh schedules of a dataset. Each dataset can have up to 5
// schedules.
func (c *Client) ListRefreshSchedules(ctx context.Context, params *ListRefreshSchedulesInput, optFns ...func(*Options)) (*ListRefreshSchedulesOutput, error) {
if params == nil {
params = &ListRefreshSchedulesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListRefreshSchedules", params, optFns, c.addOperationListRefreshSchedulesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListRefreshSchedulesOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListRefreshSchedulesInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset.
//
// This member is required.
DataSetId *string
noSmithyDocumentSerde
}
type ListRefreshSchedulesOutput struct {
// The list of refresh schedules for the dataset.
RefreshSchedules []types.RefreshSchedule
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListRefreshSchedulesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListRefreshSchedules{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListRefreshSchedules{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListRefreshSchedulesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListRefreshSchedules(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opListRefreshSchedules(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "ListRefreshSchedules",
}
}
| 137 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists the tags assigned to a resource.
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error) {
if params == nil {
params = &ListTagsForResourceInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListTagsForResource", params, optFns, c.addOperationListTagsForResourceMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListTagsForResourceOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListTagsForResourceInput struct {
// The Amazon Resource Name (ARN) of the resource that you want a list of tags for.
//
// This member is required.
ResourceArn *string
noSmithyDocumentSerde
}
type ListTagsForResourceOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Contains a map of the key-value pairs for the resource tag or tags assigned to
// the resource.
Tags []types.Tag
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListTagsForResourceMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListTagsForResource{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListTagsForResource{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListTagsForResourceValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListTagsForResource(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opListTagsForResource(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "ListTagsForResource",
}
}
| 132 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists all the aliases of a template.
func (c *Client) ListTemplateAliases(ctx context.Context, params *ListTemplateAliasesInput, optFns ...func(*Options)) (*ListTemplateAliasesOutput, error) {
if params == nil {
params = &ListTemplateAliasesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListTemplateAliases", params, optFns, c.addOperationListTemplateAliasesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListTemplateAliasesOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListTemplateAliasesInput struct {
// The ID of the Amazon Web Services account that contains the template aliases
// that you're listing.
//
// This member is required.
AwsAccountId *string
// The ID for the template.
//
// This member is required.
TemplateId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
noSmithyDocumentSerde
}
type ListTemplateAliasesOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A structure containing the list of the template's aliases.
TemplateAliasList []types.TemplateAlias
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListTemplateAliasesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListTemplateAliases{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListTemplateAliases{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListTemplateAliasesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListTemplateAliases(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListTemplateAliasesAPIClient is a client that implements the
// ListTemplateAliases operation.
type ListTemplateAliasesAPIClient interface {
ListTemplateAliases(context.Context, *ListTemplateAliasesInput, ...func(*Options)) (*ListTemplateAliasesOutput, error)
}
var _ ListTemplateAliasesAPIClient = (*Client)(nil)
// ListTemplateAliasesPaginatorOptions is the paginator options for
// ListTemplateAliases
type ListTemplateAliasesPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListTemplateAliasesPaginator is a paginator for ListTemplateAliases
type ListTemplateAliasesPaginator struct {
options ListTemplateAliasesPaginatorOptions
client ListTemplateAliasesAPIClient
params *ListTemplateAliasesInput
nextToken *string
firstPage bool
}
// NewListTemplateAliasesPaginator returns a new ListTemplateAliasesPaginator
func NewListTemplateAliasesPaginator(client ListTemplateAliasesAPIClient, params *ListTemplateAliasesInput, optFns ...func(*ListTemplateAliasesPaginatorOptions)) *ListTemplateAliasesPaginator {
if params == nil {
params = &ListTemplateAliasesInput{}
}
options := ListTemplateAliasesPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListTemplateAliasesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListTemplateAliasesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListTemplateAliases page.
func (p *ListTemplateAliasesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTemplateAliasesOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListTemplateAliases(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListTemplateAliases(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "ListTemplateAliases",
}
}
| 238 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists all the templates in the current Amazon QuickSight account.
func (c *Client) ListTemplates(ctx context.Context, params *ListTemplatesInput, optFns ...func(*Options)) (*ListTemplatesOutput, error) {
if params == nil {
params = &ListTemplatesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListTemplates", params, optFns, c.addOperationListTemplatesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListTemplatesOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListTemplatesInput struct {
// The ID of the Amazon Web Services account that contains the templates that
// you're listing.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
noSmithyDocumentSerde
}
type ListTemplatesOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A structure containing information about the templates in the list.
TemplateSummaryList []types.TemplateSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListTemplatesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListTemplates{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListTemplates{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListTemplatesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListTemplates(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListTemplatesAPIClient is a client that implements the ListTemplates operation.
type ListTemplatesAPIClient interface {
ListTemplates(context.Context, *ListTemplatesInput, ...func(*Options)) (*ListTemplatesOutput, error)
}
var _ ListTemplatesAPIClient = (*Client)(nil)
// ListTemplatesPaginatorOptions is the paginator options for ListTemplates
type ListTemplatesPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListTemplatesPaginator is a paginator for ListTemplates
type ListTemplatesPaginator struct {
options ListTemplatesPaginatorOptions
client ListTemplatesAPIClient
params *ListTemplatesInput
nextToken *string
firstPage bool
}
// NewListTemplatesPaginator returns a new ListTemplatesPaginator
func NewListTemplatesPaginator(client ListTemplatesAPIClient, params *ListTemplatesInput, optFns ...func(*ListTemplatesPaginatorOptions)) *ListTemplatesPaginator {
if params == nil {
params = &ListTemplatesInput{}
}
options := ListTemplatesPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListTemplatesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListTemplatesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListTemplates page.
func (p *ListTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTemplatesOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListTemplates(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListTemplates(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "ListTemplates",
}
}
| 231 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists all the versions of the templates in the current Amazon QuickSight
// account.
func (c *Client) ListTemplateVersions(ctx context.Context, params *ListTemplateVersionsInput, optFns ...func(*Options)) (*ListTemplateVersionsOutput, error) {
if params == nil {
params = &ListTemplateVersionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListTemplateVersions", params, optFns, c.addOperationListTemplateVersionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListTemplateVersionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListTemplateVersionsInput struct {
// The ID of the Amazon Web Services account that contains the templates that
// you're listing.
//
// This member is required.
AwsAccountId *string
// The ID for the template.
//
// This member is required.
TemplateId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
noSmithyDocumentSerde
}
type ListTemplateVersionsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A structure containing a list of all the versions of the specified template.
TemplateVersionSummaryList []types.TemplateVersionSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListTemplateVersionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListTemplateVersions{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListTemplateVersions{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListTemplateVersionsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListTemplateVersions(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListTemplateVersionsAPIClient is a client that implements the
// ListTemplateVersions operation.
type ListTemplateVersionsAPIClient interface {
ListTemplateVersions(context.Context, *ListTemplateVersionsInput, ...func(*Options)) (*ListTemplateVersionsOutput, error)
}
var _ ListTemplateVersionsAPIClient = (*Client)(nil)
// ListTemplateVersionsPaginatorOptions is the paginator options for
// ListTemplateVersions
type ListTemplateVersionsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListTemplateVersionsPaginator is a paginator for ListTemplateVersions
type ListTemplateVersionsPaginator struct {
options ListTemplateVersionsPaginatorOptions
client ListTemplateVersionsAPIClient
params *ListTemplateVersionsInput
nextToken *string
firstPage bool
}
// NewListTemplateVersionsPaginator returns a new ListTemplateVersionsPaginator
func NewListTemplateVersionsPaginator(client ListTemplateVersionsAPIClient, params *ListTemplateVersionsInput, optFns ...func(*ListTemplateVersionsPaginatorOptions)) *ListTemplateVersionsPaginator {
if params == nil {
params = &ListTemplateVersionsInput{}
}
options := ListTemplateVersionsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListTemplateVersionsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListTemplateVersionsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListTemplateVersions page.
func (p *ListTemplateVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTemplateVersionsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListTemplateVersions(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListTemplateVersions(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "ListTemplateVersions",
}
}
| 239 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists all the aliases of a theme.
func (c *Client) ListThemeAliases(ctx context.Context, params *ListThemeAliasesInput, optFns ...func(*Options)) (*ListThemeAliasesOutput, error) {
if params == nil {
params = &ListThemeAliasesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListThemeAliases", params, optFns, c.addOperationListThemeAliasesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListThemeAliasesOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListThemeAliasesInput struct {
// The ID of the Amazon Web Services account that contains the theme aliases that
// you're listing.
//
// This member is required.
AwsAccountId *string
// The ID for the theme.
//
// This member is required.
ThemeId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
noSmithyDocumentSerde
}
type ListThemeAliasesOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A structure containing the list of the theme's aliases.
ThemeAliasList []types.ThemeAlias
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListThemeAliasesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListThemeAliases{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListThemeAliases{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListThemeAliasesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListThemeAliases(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opListThemeAliases(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "ListThemeAliases",
}
}
| 146 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists all the themes in the current Amazon Web Services account.
func (c *Client) ListThemes(ctx context.Context, params *ListThemesInput, optFns ...func(*Options)) (*ListThemesOutput, error) {
if params == nil {
params = &ListThemesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListThemes", params, optFns, c.addOperationListThemesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListThemesOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListThemesInput struct {
// The ID of the Amazon Web Services account that contains the themes that you're
// listing.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The type of themes that you want to list. Valid options include the following:
// - ALL (default) - Display all existing themes.
// - CUSTOM - Display only the themes created by people using Amazon QuickSight.
// - QUICKSIGHT - Display only the starting themes defined by Amazon QuickSight.
Type types.ThemeType
noSmithyDocumentSerde
}
type ListThemesOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Information about the themes in the list.
ThemeSummaryList []types.ThemeSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListThemesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListThemes{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListThemes{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListThemesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListThemes(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListThemesAPIClient is a client that implements the ListThemes operation.
type ListThemesAPIClient interface {
ListThemes(context.Context, *ListThemesInput, ...func(*Options)) (*ListThemesOutput, error)
}
var _ ListThemesAPIClient = (*Client)(nil)
// ListThemesPaginatorOptions is the paginator options for ListThemes
type ListThemesPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListThemesPaginator is a paginator for ListThemes
type ListThemesPaginator struct {
options ListThemesPaginatorOptions
client ListThemesAPIClient
params *ListThemesInput
nextToken *string
firstPage bool
}
// NewListThemesPaginator returns a new ListThemesPaginator
func NewListThemesPaginator(client ListThemesAPIClient, params *ListThemesInput, optFns ...func(*ListThemesPaginatorOptions)) *ListThemesPaginator {
if params == nil {
params = &ListThemesInput{}
}
options := ListThemesPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListThemesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListThemesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListThemes page.
func (p *ListThemesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThemesOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListThemes(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListThemes(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "ListThemes",
}
}
| 237 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists all the versions of the themes in the current Amazon Web Services account.
func (c *Client) ListThemeVersions(ctx context.Context, params *ListThemeVersionsInput, optFns ...func(*Options)) (*ListThemeVersionsOutput, error) {
if params == nil {
params = &ListThemeVersionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListThemeVersions", params, optFns, c.addOperationListThemeVersionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListThemeVersionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListThemeVersionsInput struct {
// The ID of the Amazon Web Services account that contains the themes that you're
// listing.
//
// This member is required.
AwsAccountId *string
// The ID for the theme.
//
// This member is required.
ThemeId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
noSmithyDocumentSerde
}
type ListThemeVersionsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A structure containing a list of all the versions of the specified theme.
ThemeVersionSummaryList []types.ThemeVersionSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListThemeVersionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListThemeVersions{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListThemeVersions{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListThemeVersionsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListThemeVersions(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListThemeVersionsAPIClient is a client that implements the ListThemeVersions
// operation.
type ListThemeVersionsAPIClient interface {
ListThemeVersions(context.Context, *ListThemeVersionsInput, ...func(*Options)) (*ListThemeVersionsOutput, error)
}
var _ ListThemeVersionsAPIClient = (*Client)(nil)
// ListThemeVersionsPaginatorOptions is the paginator options for ListThemeVersions
type ListThemeVersionsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListThemeVersionsPaginator is a paginator for ListThemeVersions
type ListThemeVersionsPaginator struct {
options ListThemeVersionsPaginatorOptions
client ListThemeVersionsAPIClient
params *ListThemeVersionsInput
nextToken *string
firstPage bool
}
// NewListThemeVersionsPaginator returns a new ListThemeVersionsPaginator
func NewListThemeVersionsPaginator(client ListThemeVersionsAPIClient, params *ListThemeVersionsInput, optFns ...func(*ListThemeVersionsPaginatorOptions)) *ListThemeVersionsPaginator {
if params == nil {
params = &ListThemeVersionsInput{}
}
options := ListThemeVersionsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListThemeVersionsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListThemeVersionsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListThemeVersions page.
func (p *ListThemeVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListThemeVersionsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListThemeVersions(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListThemeVersions(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "ListThemeVersions",
}
}
| 237 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists all of the refresh schedules for a topic.
func (c *Client) ListTopicRefreshSchedules(ctx context.Context, params *ListTopicRefreshSchedulesInput, optFns ...func(*Options)) (*ListTopicRefreshSchedulesOutput, error) {
if params == nil {
params = &ListTopicRefreshSchedulesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListTopicRefreshSchedules", params, optFns, c.addOperationListTopicRefreshSchedulesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListTopicRefreshSchedulesOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListTopicRefreshSchedulesInput struct {
// The ID of the Amazon Web Services account that contains the topic whose refresh
// schedule you want described.
//
// This member is required.
AwsAccountId *string
// The ID for the topic that you want to describe. This ID is unique per Amazon
// Web Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
noSmithyDocumentSerde
}
type ListTopicRefreshSchedulesOutput struct {
// The list of topic refresh schedules.
RefreshSchedules []types.TopicRefreshScheduleSummary
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the topic.
TopicArn *string
// The ID for the topic that you want to describe. This ID is unique per Amazon
// Web Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListTopicRefreshSchedulesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListTopicRefreshSchedules{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListTopicRefreshSchedules{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListTopicRefreshSchedulesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListTopicRefreshSchedules(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opListTopicRefreshSchedules(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "ListTopicRefreshSchedules",
}
}
| 145 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists all of the topics within an account.
func (c *Client) ListTopics(ctx context.Context, params *ListTopicsInput, optFns ...func(*Options)) (*ListTopicsOutput, error) {
if params == nil {
params = &ListTopicsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListTopics", params, optFns, c.addOperationListTopicsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListTopicsOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListTopicsInput struct {
// The ID of the Amazon Web Services account that contains the topics that you
// want to list.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
noSmithyDocumentSerde
}
type ListTopicsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A list of topic summaries.
TopicsSummaries []types.TopicSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListTopicsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListTopics{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListTopics{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListTopicsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListTopics(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListTopicsAPIClient is a client that implements the ListTopics operation.
type ListTopicsAPIClient interface {
ListTopics(context.Context, *ListTopicsInput, ...func(*Options)) (*ListTopicsOutput, error)
}
var _ ListTopicsAPIClient = (*Client)(nil)
// ListTopicsPaginatorOptions is the paginator options for ListTopics
type ListTopicsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListTopicsPaginator is a paginator for ListTopics
type ListTopicsPaginator struct {
options ListTopicsPaginatorOptions
client ListTopicsAPIClient
params *ListTopicsInput
nextToken *string
firstPage bool
}
// NewListTopicsPaginator returns a new ListTopicsPaginator
func NewListTopicsPaginator(client ListTopicsAPIClient, params *ListTopicsInput, optFns ...func(*ListTopicsPaginatorOptions)) *ListTopicsPaginator {
if params == nil {
params = &ListTopicsInput{}
}
options := ListTopicsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListTopicsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListTopicsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListTopics page.
func (p *ListTopicsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTopicsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListTopics(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListTopics(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "ListTopics",
}
}
| 231 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member
// of.
func (c *Client) ListUserGroups(ctx context.Context, params *ListUserGroupsInput, optFns ...func(*Options)) (*ListUserGroupsOutput, error) {
if params == nil {
params = &ListUserGroupsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListUserGroups", params, optFns, c.addOperationListUserGroupsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListUserGroupsOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListUserGroupsInput struct {
// The Amazon Web Services account ID that the user is in. Currently, you use the
// ID for the Amazon Web Services account that contains your Amazon QuickSight
// account.
//
// This member is required.
AwsAccountId *string
// The namespace. Currently, you should set this to default .
//
// This member is required.
Namespace *string
// The Amazon QuickSight user name that you want to list group memberships for.
//
// This member is required.
UserName *string
// The maximum number of results to return from this request.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
noSmithyDocumentSerde
}
type ListUserGroupsOutput struct {
// The list of groups the user is a member of.
GroupList []types.Group
// A pagination token that can be used in a subsequent request.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListUserGroupsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListUserGroups{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListUserGroups{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListUserGroupsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListUserGroups(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opListUserGroups(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "ListUserGroups",
}
}
| 153 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Returns a list of all of the Amazon QuickSight users belonging to this account.
func (c *Client) ListUsers(ctx context.Context, params *ListUsersInput, optFns ...func(*Options)) (*ListUsersOutput, error) {
if params == nil {
params = &ListUsersInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListUsers", params, optFns, c.addOperationListUsersMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListUsersOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListUsersInput struct {
// The ID for the Amazon Web Services account that the user is in. Currently, you
// use the ID for the Amazon Web Services account that contains your Amazon
// QuickSight account.
//
// This member is required.
AwsAccountId *string
// The namespace. Currently, you should set this to default .
//
// This member is required.
Namespace *string
// The maximum number of results to return from this request.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
noSmithyDocumentSerde
}
type ListUsersOutput struct {
// A pagination token that can be used in a subsequent request.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The list of users.
UserList []types.User
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListUsersMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListUsers{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListUsers{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListUsersValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListUsers(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opListUsers(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "ListUsers",
}
}
| 147 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists all of the VPC connections in the current set Amazon Web Services Region
// of an Amazon Web Services account.
func (c *Client) ListVPCConnections(ctx context.Context, params *ListVPCConnectionsInput, optFns ...func(*Options)) (*ListVPCConnectionsOutput, error) {
if params == nil {
params = &ListVPCConnectionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListVPCConnections", params, optFns, c.addOperationListVPCConnectionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListVPCConnectionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListVPCConnectionsInput struct {
// The Amazon Web Services account ID of the account that contains the VPC
// connections that you want to list.
//
// This member is required.
AwsAccountId *string
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
noSmithyDocumentSerde
}
type ListVPCConnectionsOutput struct {
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// A VPCConnectionSummaries object that returns a summary of VPC connection
// objects.
VPCConnectionSummaries []types.VPCConnectionSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListVPCConnectionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListVPCConnections{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListVPCConnections{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListVPCConnectionsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListVPCConnections(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListVPCConnectionsAPIClient is a client that implements the ListVPCConnections
// operation.
type ListVPCConnectionsAPIClient interface {
ListVPCConnections(context.Context, *ListVPCConnectionsInput, ...func(*Options)) (*ListVPCConnectionsOutput, error)
}
var _ ListVPCConnectionsAPIClient = (*Client)(nil)
// ListVPCConnectionsPaginatorOptions is the paginator options for
// ListVPCConnections
type ListVPCConnectionsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListVPCConnectionsPaginator is a paginator for ListVPCConnections
type ListVPCConnectionsPaginator struct {
options ListVPCConnectionsPaginatorOptions
client ListVPCConnectionsAPIClient
params *ListVPCConnectionsInput
nextToken *string
firstPage bool
}
// NewListVPCConnectionsPaginator returns a new ListVPCConnectionsPaginator
func NewListVPCConnectionsPaginator(client ListVPCConnectionsAPIClient, params *ListVPCConnectionsInput, optFns ...func(*ListVPCConnectionsPaginatorOptions)) *ListVPCConnectionsPaginator {
if params == nil {
params = &ListVPCConnectionsInput{}
}
options := ListVPCConnectionsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListVPCConnectionsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListVPCConnectionsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListVPCConnections page.
func (p *ListVPCConnectionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListVPCConnectionsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListVPCConnections(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListVPCConnections(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "ListVPCConnections",
}
}
| 235 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates or updates the dataset refresh properties for the dataset.
func (c *Client) PutDataSetRefreshProperties(ctx context.Context, params *PutDataSetRefreshPropertiesInput, optFns ...func(*Options)) (*PutDataSetRefreshPropertiesOutput, error) {
if params == nil {
params = &PutDataSetRefreshPropertiesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "PutDataSetRefreshProperties", params, optFns, c.addOperationPutDataSetRefreshPropertiesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*PutDataSetRefreshPropertiesOutput)
out.ResultMetadata = metadata
return out, nil
}
type PutDataSetRefreshPropertiesInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset.
//
// This member is required.
DataSetId *string
// The dataset refresh properties.
//
// This member is required.
DataSetRefreshProperties *types.DataSetRefreshProperties
noSmithyDocumentSerde
}
type PutDataSetRefreshPropertiesOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationPutDataSetRefreshPropertiesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpPutDataSetRefreshProperties{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpPutDataSetRefreshProperties{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpPutDataSetRefreshPropertiesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opPutDataSetRefreshProperties(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opPutDataSetRefreshProperties(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "PutDataSetRefreshProperties",
}
}
| 138 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates an Amazon QuickSight user whose identity is associated with the
// Identity and Access Management (IAM) identity or role specified in the request.
// When you register a new user from the Amazon QuickSight API, Amazon QuickSight
// generates a registration URL. The user accesses this registration URL to create
// their account. Amazon QuickSight doesn't send a registration email to users who
// are registered from the Amazon QuickSight API. If you want new users to receive
// a registration email, then add those users in the Amazon QuickSight console. For
// more information on registering a new user in the Amazon QuickSight console, see
// Inviting users to access Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/managing-users.html#inviting-users)
// .
func (c *Client) RegisterUser(ctx context.Context, params *RegisterUserInput, optFns ...func(*Options)) (*RegisterUserOutput, error) {
if params == nil {
params = &RegisterUserInput{}
}
result, metadata, err := c.invokeOperation(ctx, "RegisterUser", params, optFns, c.addOperationRegisterUserMiddlewares)
if err != nil {
return nil, err
}
out := result.(*RegisterUserOutput)
out.ResultMetadata = metadata
return out, nil
}
type RegisterUserInput struct {
// The ID for the Amazon Web Services account that the user is in. Currently, you
// use the ID for the Amazon Web Services account that contains your Amazon
// QuickSight account.
//
// This member is required.
AwsAccountId *string
// The email address of the user that you want to register.
//
// This member is required.
Email *string
// 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.
//
// This member is required.
IdentityType types.IdentityType
// The namespace. Currently, you should set this to default .
//
// This member is required.
Namespace *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.
//
// This member is required.
UserRole types.UserRole
// The URL of the custom OpenID Connect (OIDC) provider that provides identity to
// let a user federate into Amazon QuickSight with an associated Identity and
// Access Management(IAM) role. This parameter should only be used when
// ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC .
CustomFederationProviderUrl *string
// (Enterprise edition only) The name of the custom permissions profile that you
// want to assign to this user. Customized permissions allows you to control a
// user's access by restricting access the following operations:
// - Create and update data sources
// - Create and update datasets
// - Create and update email reports
// - Subscribe to email reports
// To add custom permissions to an existing user, use UpdateUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html)
// instead. A set of custom permissions includes any combination of these
// restrictions. Currently, you need to create the profile names for custom
// permission sets by using the Amazon QuickSight console. Then, you use the
// RegisterUser API operation to assign the named set of permissions to a Amazon
// QuickSight user. Amazon QuickSight custom permissions are applied through IAM
// policies. Therefore, they override the permissions typically granted by
// assigning Amazon QuickSight users to one of the default security cohorts in
// Amazon QuickSight (admin, author, reader). This feature is available only to
// Amazon QuickSight Enterprise edition subscriptions.
CustomPermissionsName *string
// The type of supported external login provider that provides identity to let a
// user federate into Amazon QuickSight with an associated Identity and Access
// Management(IAM) role. The type of supported external login provider can be one
// of the following.
// - COGNITO : Amazon Cognito. The provider URL is
// cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t
// use the "CustomFederationProviderUrl" parameter which is only needed when the
// external provider is custom.
// - CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider. When choosing
// CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the
// custom OIDC provider URL.
ExternalLoginFederationProviderType *string
// The identity ID for a user in the external login provider.
ExternalLoginId *string
// The ARN of the IAM user or role that you are registering with Amazon QuickSight.
IamArn *string
// You need to use this parameter only when you register one or more users using
// an assumed IAM role. You don't need to provide the session name for other
// scenarios, for example when you are registering an IAM user or an Amazon
// 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://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html)
// in the CLI Reference.
SessionName *string
// The Amazon QuickSight user name that you want to create for the user you are
// registering.
UserName *string
noSmithyDocumentSerde
}
type RegisterUserOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The user's user name.
User *types.User
// The URL the user visits to complete registration and provide a password. This
// is returned only for users with an identity type of QUICKSIGHT .
UserInvitationUrl *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationRegisterUserMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpRegisterUser{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpRegisterUser{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpRegisterUserValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opRegisterUser(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opRegisterUser(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "RegisterUser",
}
}
| 235 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Restores an analysis.
func (c *Client) RestoreAnalysis(ctx context.Context, params *RestoreAnalysisInput, optFns ...func(*Options)) (*RestoreAnalysisOutput, error) {
if params == nil {
params = &RestoreAnalysisInput{}
}
result, metadata, err := c.invokeOperation(ctx, "RestoreAnalysis", params, optFns, c.addOperationRestoreAnalysisMiddlewares)
if err != nil {
return nil, err
}
out := result.(*RestoreAnalysisOutput)
out.ResultMetadata = metadata
return out, nil
}
type RestoreAnalysisInput struct {
// The ID of the analysis that you're restoring.
//
// This member is required.
AnalysisId *string
// The ID of the Amazon Web Services account that contains the analysis.
//
// This member is required.
AwsAccountId *string
noSmithyDocumentSerde
}
type RestoreAnalysisOutput struct {
// The ID of the analysis that you're restoring.
AnalysisId *string
// The Amazon Resource Name (ARN) of the analysis that you're restoring.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationRestoreAnalysisMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpRestoreAnalysis{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpRestoreAnalysis{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpRestoreAnalysisValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opRestoreAnalysis(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opRestoreAnalysis(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "RestoreAnalysis",
}
}
| 138 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Searches for analyses that belong to the user specified in the filter. This
// operation is eventually consistent. The results are best effort and may not
// reflect very recent updates and changes.
func (c *Client) SearchAnalyses(ctx context.Context, params *SearchAnalysesInput, optFns ...func(*Options)) (*SearchAnalysesOutput, error) {
if params == nil {
params = &SearchAnalysesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "SearchAnalyses", params, optFns, c.addOperationSearchAnalysesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*SearchAnalysesOutput)
out.ResultMetadata = metadata
return out, nil
}
type SearchAnalysesInput struct {
// The ID of the Amazon Web Services account that contains the analyses that
// you're searching for.
//
// This member is required.
AwsAccountId *string
// The structure for the search filters that you want to apply to your search.
//
// This member is required.
Filters []types.AnalysisSearchFilter
// The maximum number of results to return.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
noSmithyDocumentSerde
}
type SearchAnalysesOutput struct {
// Metadata describing the analyses that you searched for.
AnalysisSummaryList []types.AnalysisSummary
// A pagination token that can be used in a subsequent request.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationSearchAnalysesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpSearchAnalyses{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpSearchAnalyses{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpSearchAnalysesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opSearchAnalyses(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// SearchAnalysesAPIClient is a client that implements the SearchAnalyses
// operation.
type SearchAnalysesAPIClient interface {
SearchAnalyses(context.Context, *SearchAnalysesInput, ...func(*Options)) (*SearchAnalysesOutput, error)
}
var _ SearchAnalysesAPIClient = (*Client)(nil)
// SearchAnalysesPaginatorOptions is the paginator options for SearchAnalyses
type SearchAnalysesPaginatorOptions struct {
// The maximum number of results to return.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// SearchAnalysesPaginator is a paginator for SearchAnalyses
type SearchAnalysesPaginator struct {
options SearchAnalysesPaginatorOptions
client SearchAnalysesAPIClient
params *SearchAnalysesInput
nextToken *string
firstPage bool
}
// NewSearchAnalysesPaginator returns a new SearchAnalysesPaginator
func NewSearchAnalysesPaginator(client SearchAnalysesAPIClient, params *SearchAnalysesInput, optFns ...func(*SearchAnalysesPaginatorOptions)) *SearchAnalysesPaginator {
if params == nil {
params = &SearchAnalysesInput{}
}
options := SearchAnalysesPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &SearchAnalysesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *SearchAnalysesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next SearchAnalyses page.
func (p *SearchAnalysesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchAnalysesOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.SearchAnalyses(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opSearchAnalyses(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "SearchAnalyses",
}
}
| 239 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Searches for dashboards that belong to a user. This operation is eventually
// consistent. The results are best effort and may not reflect very recent updates
// and changes.
func (c *Client) SearchDashboards(ctx context.Context, params *SearchDashboardsInput, optFns ...func(*Options)) (*SearchDashboardsOutput, error) {
if params == nil {
params = &SearchDashboardsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "SearchDashboards", params, optFns, c.addOperationSearchDashboardsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*SearchDashboardsOutput)
out.ResultMetadata = metadata
return out, nil
}
type SearchDashboardsInput struct {
// The ID of the Amazon Web Services account that contains the user whose
// dashboards you're searching for.
//
// This member is required.
AwsAccountId *string
// The filters to apply to the search. Currently, you can search only by user
// name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator":
// "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"
// } ]
//
// This member is required.
Filters []types.DashboardSearchFilter
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
noSmithyDocumentSerde
}
type SearchDashboardsOutput struct {
// The list of dashboards owned by the user specified in Filters in your request.
DashboardSummaryList []types.DashboardSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationSearchDashboardsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpSearchDashboards{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpSearchDashboards{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpSearchDashboardsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opSearchDashboards(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// SearchDashboardsAPIClient is a client that implements the SearchDashboards
// operation.
type SearchDashboardsAPIClient interface {
SearchDashboards(context.Context, *SearchDashboardsInput, ...func(*Options)) (*SearchDashboardsOutput, error)
}
var _ SearchDashboardsAPIClient = (*Client)(nil)
// SearchDashboardsPaginatorOptions is the paginator options for SearchDashboards
type SearchDashboardsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// SearchDashboardsPaginator is a paginator for SearchDashboards
type SearchDashboardsPaginator struct {
options SearchDashboardsPaginatorOptions
client SearchDashboardsAPIClient
params *SearchDashboardsInput
nextToken *string
firstPage bool
}
// NewSearchDashboardsPaginator returns a new SearchDashboardsPaginator
func NewSearchDashboardsPaginator(client SearchDashboardsAPIClient, params *SearchDashboardsInput, optFns ...func(*SearchDashboardsPaginatorOptions)) *SearchDashboardsPaginator {
if params == nil {
params = &SearchDashboardsInput{}
}
options := SearchDashboardsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &SearchDashboardsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *SearchDashboardsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next SearchDashboards page.
func (p *SearchDashboardsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchDashboardsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.SearchDashboards(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opSearchDashboards(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "SearchDashboards",
}
}
| 242 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Use the SearchDataSets operation to search for datasets that belong to an
// account.
func (c *Client) SearchDataSets(ctx context.Context, params *SearchDataSetsInput, optFns ...func(*Options)) (*SearchDataSetsOutput, error) {
if params == nil {
params = &SearchDataSetsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "SearchDataSets", params, optFns, c.addOperationSearchDataSetsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*SearchDataSetsOutput)
out.ResultMetadata = metadata
return out, nil
}
type SearchDataSetsInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The filters to apply to the search.
//
// This member is required.
Filters []types.DataSetSearchFilter
// The maximum number of results to be returned per request.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
noSmithyDocumentSerde
}
type SearchDataSetsOutput struct {
// A DataSetSummaries object that returns a summary of a dataset.
DataSetSummaries []types.DataSetSummary
// A pagination token that can be used in a subsequent request.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationSearchDataSetsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpSearchDataSets{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpSearchDataSets{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpSearchDataSetsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opSearchDataSets(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// SearchDataSetsAPIClient is a client that implements the SearchDataSets
// operation.
type SearchDataSetsAPIClient interface {
SearchDataSets(context.Context, *SearchDataSetsInput, ...func(*Options)) (*SearchDataSetsOutput, error)
}
var _ SearchDataSetsAPIClient = (*Client)(nil)
// SearchDataSetsPaginatorOptions is the paginator options for SearchDataSets
type SearchDataSetsPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// SearchDataSetsPaginator is a paginator for SearchDataSets
type SearchDataSetsPaginator struct {
options SearchDataSetsPaginatorOptions
client SearchDataSetsAPIClient
params *SearchDataSetsInput
nextToken *string
firstPage bool
}
// NewSearchDataSetsPaginator returns a new SearchDataSetsPaginator
func NewSearchDataSetsPaginator(client SearchDataSetsAPIClient, params *SearchDataSetsInput, optFns ...func(*SearchDataSetsPaginatorOptions)) *SearchDataSetsPaginator {
if params == nil {
params = &SearchDataSetsInput{}
}
options := SearchDataSetsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &SearchDataSetsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *SearchDataSetsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next SearchDataSets page.
func (p *SearchDataSetsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchDataSetsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.SearchDataSets(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opSearchDataSets(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "SearchDataSets",
}
}
| 237 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Use the SearchDataSources operation to search for data sources that belong to
// an account.
func (c *Client) SearchDataSources(ctx context.Context, params *SearchDataSourcesInput, optFns ...func(*Options)) (*SearchDataSourcesOutput, error) {
if params == nil {
params = &SearchDataSourcesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "SearchDataSources", params, optFns, c.addOperationSearchDataSourcesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*SearchDataSourcesOutput)
out.ResultMetadata = metadata
return out, nil
}
type SearchDataSourcesInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The filters to apply to the search.
//
// This member is required.
Filters []types.DataSourceSearchFilter
// The maximum number of results to be returned per request.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
noSmithyDocumentSerde
}
type SearchDataSourcesOutput struct {
// A DataSourceSummaries object that returns a summary of a data source.
DataSourceSummaries []types.DataSourceSummary
// A pagination token that can be used in a subsequent request.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationSearchDataSourcesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpSearchDataSources{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpSearchDataSources{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpSearchDataSourcesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opSearchDataSources(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// SearchDataSourcesAPIClient is a client that implements the SearchDataSources
// operation.
type SearchDataSourcesAPIClient interface {
SearchDataSources(context.Context, *SearchDataSourcesInput, ...func(*Options)) (*SearchDataSourcesOutput, error)
}
var _ SearchDataSourcesAPIClient = (*Client)(nil)
// SearchDataSourcesPaginatorOptions is the paginator options for SearchDataSources
type SearchDataSourcesPaginatorOptions struct {
// The maximum number of results to be returned per request.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// SearchDataSourcesPaginator is a paginator for SearchDataSources
type SearchDataSourcesPaginator struct {
options SearchDataSourcesPaginatorOptions
client SearchDataSourcesAPIClient
params *SearchDataSourcesInput
nextToken *string
firstPage bool
}
// NewSearchDataSourcesPaginator returns a new SearchDataSourcesPaginator
func NewSearchDataSourcesPaginator(client SearchDataSourcesAPIClient, params *SearchDataSourcesInput, optFns ...func(*SearchDataSourcesPaginatorOptions)) *SearchDataSourcesPaginator {
if params == nil {
params = &SearchDataSourcesInput{}
}
options := SearchDataSourcesPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &SearchDataSourcesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *SearchDataSourcesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next SearchDataSources page.
func (p *SearchDataSourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*SearchDataSourcesOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.SearchDataSources(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opSearchDataSources(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "SearchDataSources",
}
}
| 237 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Searches the subfolders in a folder.
func (c *Client) SearchFolders(ctx context.Context, params *SearchFoldersInput, optFns ...func(*Options)) (*SearchFoldersOutput, error) {
if params == nil {
params = &SearchFoldersInput{}
}
result, metadata, err := c.invokeOperation(ctx, "SearchFolders", params, optFns, c.addOperationSearchFoldersMiddlewares)
if err != nil {
return nil, err
}
out := result.(*SearchFoldersOutput)
out.ResultMetadata = metadata
return out, nil
}
type SearchFoldersInput struct {
// The ID for the Amazon Web Services account that contains the folder.
//
// This member is required.
AwsAccountId *string
// The filters to apply to the search. Currently, you can search only by the
// parent folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN",
// "Operator": "StringEquals", "Value":
// "arn:aws:quicksight:us-east-1:1:folder/folderId" } ] .
//
// This member is required.
Filters []types.FolderSearchFilter
// The maximum number of results to be returned per request.
MaxResults *int32
// The token for the next set of results, or null if there are no more results.
NextToken *string
noSmithyDocumentSerde
}
type SearchFoldersOutput struct {
// A structure that contains all of the folders in the Amazon Web Services
// account. This structure provides basic information about the folders.
FolderSummaryList []types.FolderSummary
// The token for the next set of results, or null if there are no more results.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationSearchFoldersMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpSearchFolders{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpSearchFolders{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpSearchFoldersValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opSearchFolders(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opSearchFolders(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "SearchFolders",
}
}
| 149 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Use the SearchGroups operation to search groups in a specified Amazon
// QuickSight namespace using the supplied filters.
func (c *Client) SearchGroups(ctx context.Context, params *SearchGroupsInput, optFns ...func(*Options)) (*SearchGroupsOutput, error) {
if params == nil {
params = &SearchGroupsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "SearchGroups", params, optFns, c.addOperationSearchGroupsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*SearchGroupsOutput)
out.ResultMetadata = metadata
return out, nil
}
type SearchGroupsInput struct {
// The ID for the Amazon Web Services account that the group is in. Currently, you
// use the ID for the Amazon Web Services account that contains your Amazon
// QuickSight account.
//
// This member is required.
AwsAccountId *string
// The structure for the search filters that you want to apply to your search.
//
// This member is required.
Filters []types.GroupSearchFilter
// The namespace that you want to search.
//
// This member is required.
Namespace *string
// The maximum number of results to return from this request.
MaxResults *int32
// A pagination token that can be used in a subsequent request.
NextToken *string
noSmithyDocumentSerde
}
type SearchGroupsOutput struct {
// A list of groups in a specified namespace that match the filters you set in
// your SearchGroups request.
GroupList []types.Group
// A pagination token that can be used in a subsequent request.
NextToken *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationSearchGroupsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpSearchGroups{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpSearchGroups{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpSearchGroupsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opSearchGroups(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opSearchGroups(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "SearchGroups",
}
}
| 154 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Starts an Asset Bundle export job. An Asset Bundle export job exports specified
// Amazon QuickSight assets. You can also choose to export any asset dependencies
// in the same job. Export jobs run asynchronously and can be polled with a
// DescribeAssetBundleExportJob API call. When a job is successfully completed, a
// download URL that contains the exported assets is returned. The URL is valid for
// 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call.
// Each Amazon QuickSight account can run up to 10 export jobs concurrently. The
// API caller must have the necessary permissions in their IAM role to access each
// resource before the resources can be exported.
func (c *Client) StartAssetBundleExportJob(ctx context.Context, params *StartAssetBundleExportJobInput, optFns ...func(*Options)) (*StartAssetBundleExportJobOutput, error) {
if params == nil {
params = &StartAssetBundleExportJobInput{}
}
result, metadata, err := c.invokeOperation(ctx, "StartAssetBundleExportJob", params, optFns, c.addOperationStartAssetBundleExportJobMiddlewares)
if err != nil {
return nil, err
}
out := result.(*StartAssetBundleExportJobOutput)
out.ResultMetadata = metadata
return out, nil
}
type StartAssetBundleExportJobInput struct {
// The ID of the job. This ID is unique while the job is running. After the job is
// completed, you can reuse this ID for another job.
//
// This member is required.
AssetBundleExportJobId *string
// The ID of the Amazon Web Services account to export assets from.
//
// This member is required.
AwsAccountId *string
// The export data format.
//
// This member is required.
ExportFormat types.AssetBundleExportFormat
// An array of resource ARNs to export. The following resources are supported.
// - Analysis
// - Dashboard
// - DataSet
// - DataSource
// - RefreshSchedule
// - Theme
// - VPCConnection
// The API caller must have the necessary permissions in their IAM role to access
// each resource before the resources can be exported.
//
// This member is required.
ResourceArns []string
// An optional collection of structures that generate CloudFormation parameters to
// override the existing resource property values when the resource is exported to
// a new CloudFormation template. Use this field if the ExportFormat field of a
// StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON .
CloudFormationOverridePropertyConfiguration *types.AssetBundleCloudFormationOverridePropertyConfiguration
// A Boolean that determines whether all dependencies of each resource ARN are
// recursively exported with the job. For example, say you provided a Dashboard ARN
// to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE , any
// theme, dataset, and data source resource that is a dependency of the dashboard
// is also exported.
IncludeAllDependencies bool
noSmithyDocumentSerde
}
type StartAssetBundleExportJobOutput struct {
// The Amazon Resource Name (ARN) for the export job.
Arn *string
// The ID of the job. This ID is unique while the job is running. After the job is
// completed, you can reuse this ID for another job.
AssetBundleExportJobId *string
// The Amazon Web Services response ID for this operation.
RequestId *string
// The HTTP status of the response.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationStartAssetBundleExportJobMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpStartAssetBundleExportJob{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpStartAssetBundleExportJob{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpStartAssetBundleExportJobValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opStartAssetBundleExportJob(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opStartAssetBundleExportJob(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "StartAssetBundleExportJob",
}
}
| 181 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Starts an Asset Bundle import job. An Asset Bundle import job imports specified
// Amazon QuickSight assets into an Amazon QuickSight account. You can also choose
// to import a naming prefix and specified configuration overrides. The assets that
// are contained in the bundle file that you provide are used to create or update a
// new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight
// account can run up to 10 import jobs concurrently. The API caller must have the
// necessary "create" , "describe" , and "update" permissions in their IAM role to
// access each resource type that is contained in the bundle file before the
// resources can be imported.
func (c *Client) StartAssetBundleImportJob(ctx context.Context, params *StartAssetBundleImportJobInput, optFns ...func(*Options)) (*StartAssetBundleImportJobOutput, error) {
if params == nil {
params = &StartAssetBundleImportJobInput{}
}
result, metadata, err := c.invokeOperation(ctx, "StartAssetBundleImportJob", params, optFns, c.addOperationStartAssetBundleImportJobMiddlewares)
if err != nil {
return nil, err
}
out := result.(*StartAssetBundleImportJobOutput)
out.ResultMetadata = metadata
return out, nil
}
type StartAssetBundleImportJobInput struct {
// The ID of the job. This ID is unique while the job is running. After the job is
// completed, you can reuse this ID for another job.
//
// This member is required.
AssetBundleImportJobId *string
// The source of the asset bundle zip file that contains the data that you want to
// import.
//
// This member is required.
AssetBundleImportSource *types.AssetBundleImportSource
// The ID of the Amazon Web Services account to import assets into.
//
// This member is required.
AwsAccountId *string
// The failure action for the import job. If you choose ROLLBACK , failed import
// jobs will attempt to undo any asset changes caused by the failed job. If you
// choose DO_NOTHING , failed import jobs will not attempt to roll back any asset
// changes caused by the failed job, possibly keeping the Amazon QuickSight account
// in an inconsistent state.
FailureAction types.AssetBundleImportFailureAction
// Optional overrides to be applied to the resource configuration before import.
OverrideParameters *types.AssetBundleImportJobOverrideParameters
noSmithyDocumentSerde
}
type StartAssetBundleImportJobOutput struct {
// The Amazon Resource Name (ARN) for the import job.
Arn *string
// The ID of the job. This ID is unique while the job is running. After the job is
// completed, you can reuse this ID for another job.
AssetBundleImportJobId *string
// The Amazon Web Services response ID for this operation.
RequestId *string
// The HTTP status of the response.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationStartAssetBundleImportJobMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpStartAssetBundleImportJob{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpStartAssetBundleImportJob{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpStartAssetBundleImportJobValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opStartAssetBundleImportJob(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opStartAssetBundleImportJob(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "StartAssetBundleImportJob",
}
}
| 165 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Assigns one or more tags (key-value pairs) to the specified Amazon 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. Amazon QuickSight supports
// tagging on data set, data source, dashboard, template, and topic. Tagging for
// Amazon QuickSight works in a similar way to tagging for other Amazon Web
// Services services, except for the following:
// - You can't use tags to track costs for Amazon QuickSight. This isn't
// possible because you can't tag the resources that Amazon QuickSight costs are
// based on, for example Amazon QuickSight storage capacity (SPICE), number of
// users, type of users, and usage metrics.
// - Amazon QuickSight doesn't currently support the tag editor for Resource
// Groups.
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error) {
if params == nil {
params = &TagResourceInput{}
}
result, metadata, err := c.invokeOperation(ctx, "TagResource", params, optFns, c.addOperationTagResourceMiddlewares)
if err != nil {
return nil, err
}
out := result.(*TagResourceOutput)
out.ResultMetadata = metadata
return out, nil
}
type TagResourceInput struct {
// The Amazon Resource Name (ARN) of the resource that you want to tag.
//
// This member is required.
ResourceArn *string
// Contains a map of the key-value pairs for the resource tag or tags assigned to
// the resource.
//
// This member is required.
Tags []types.Tag
noSmithyDocumentSerde
}
type TagResourceOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationTagResourceMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpTagResource{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpTagResource{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpTagResourceValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opTagResource(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opTagResource(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "TagResource",
}
}
| 151 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Removes a tag or tags from a resource.
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error) {
if params == nil {
params = &UntagResourceInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UntagResource", params, optFns, c.addOperationUntagResourceMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UntagResourceOutput)
out.ResultMetadata = metadata
return out, nil
}
type UntagResourceInput struct {
// The Amazon Resource Name (ARN) of the resource that you want to untag.
//
// This member is required.
ResourceArn *string
// The keys of the key-value pairs for the resource tag or tags assigned to the
// resource.
//
// This member is required.
TagKeys []string
noSmithyDocumentSerde
}
type UntagResourceOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUntagResourceMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUntagResource{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUntagResource{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUntagResourceValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUntagResource(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUntagResource(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UntagResource",
}
}
| 133 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates Amazon QuickSight customizations for the current Amazon Web Services
// Region. Currently, the only customization that you can use is a theme. You can
// use customizations for your Amazon Web Services account or, if you specify a
// namespace, for a Amazon QuickSight namespace instead. Customizations that apply
// to a namespace override customizations that apply to an Amazon Web Services
// account. To find out which customizations apply, use the
// DescribeAccountCustomization API operation.
func (c *Client) UpdateAccountCustomization(ctx context.Context, params *UpdateAccountCustomizationInput, optFns ...func(*Options)) (*UpdateAccountCustomizationOutput, error) {
if params == nil {
params = &UpdateAccountCustomizationInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateAccountCustomization", params, optFns, c.addOperationUpdateAccountCustomizationMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateAccountCustomizationOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateAccountCustomizationInput struct {
// The Amazon QuickSight customizations you're updating in the current Amazon Web
// Services Region.
//
// This member is required.
AccountCustomization *types.AccountCustomization
// The ID for the Amazon Web Services account that you want to update Amazon
// QuickSight customizations for.
//
// This member is required.
AwsAccountId *string
// The namespace that you want to update Amazon QuickSight customizations for.
Namespace *string
noSmithyDocumentSerde
}
type UpdateAccountCustomizationOutput struct {
// The Amazon QuickSight customizations you're updating in the current Amazon Web
// Services Region.
AccountCustomization *types.AccountCustomization
// The Amazon Resource Name (ARN) for the updated customization for this Amazon
// Web Services account.
Arn *string
// The ID for the Amazon Web Services account that you want to update Amazon
// QuickSight customizations for.
AwsAccountId *string
// The namespace associated with the customization that you're updating.
Namespace *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateAccountCustomizationMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateAccountCustomization{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateAccountCustomization{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateAccountCustomizationValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateAccountCustomization(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateAccountCustomization(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateAccountCustomization",
}
}
| 159 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates the Amazon QuickSight settings in your Amazon Web Services account.
func (c *Client) UpdateAccountSettings(ctx context.Context, params *UpdateAccountSettingsInput, optFns ...func(*Options)) (*UpdateAccountSettingsOutput, error) {
if params == nil {
params = &UpdateAccountSettingsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateAccountSettings", params, optFns, c.addOperationUpdateAccountSettingsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateAccountSettingsOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateAccountSettingsInput struct {
// The ID for the Amazon Web Services account that contains the Amazon QuickSight
// settings that you want to list.
//
// This member is required.
AwsAccountId *string
// The default namespace for this Amazon Web Services account. Currently, the
// default is default . IAM users that register for the first time with Amazon
// QuickSight provide an email address that becomes associated with the default
// namespace.
//
// This member is required.
DefaultNamespace *string
// The email address that you want Amazon QuickSight to send notifications to
// regarding your Amazon Web Services account or Amazon QuickSight subscription.
NotificationEmail *string
// A boolean value that determines whether or not an Amazon QuickSight account can
// be deleted. A True value doesn't allow the account to be deleted and results in
// an error message if a user tries to make a DeleteAccountSubscription request. A
// False value will allow the account to be deleted.
TerminationProtectionEnabled bool
noSmithyDocumentSerde
}
type UpdateAccountSettingsOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateAccountSettingsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateAccountSettings{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateAccountSettings{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateAccountSettingsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateAccountSettings(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateAccountSettings(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateAccountSettings",
}
}
| 146 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates an analysis in Amazon QuickSight
func (c *Client) UpdateAnalysis(ctx context.Context, params *UpdateAnalysisInput, optFns ...func(*Options)) (*UpdateAnalysisOutput, error) {
if params == nil {
params = &UpdateAnalysisInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateAnalysis", params, optFns, c.addOperationUpdateAnalysisMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateAnalysisOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateAnalysisInput struct {
// The ID for the analysis that you're updating. This ID displays in the URL of
// the analysis.
//
// This member is required.
AnalysisId *string
// The ID of the Amazon Web Services account that contains the analysis that
// you're updating.
//
// This member is required.
AwsAccountId *string
// A descriptive name for the analysis that you're updating. This name displays
// for the analysis in the Amazon QuickSight console.
//
// This member is required.
Name *string
// The definition of an analysis. A definition is the data model of all features
// in a Dashboard, Template, or Analysis.
Definition *types.AnalysisDefinition
// The parameter names and override values that you want to use. An analysis can
// have any parameter type, and some parameters might accept multiple values.
Parameters *types.Parameters
// A source entity to use for the analysis that you're updating. This metadata
// structure contains details that describe a source template and one or more
// datasets.
SourceEntity *types.AnalysisSourceEntity
// The Amazon Resource Name (ARN) for the theme to apply to the analysis that
// you're creating. To see the theme in the Amazon QuickSight console, make sure
// that you have access to it.
ThemeArn *string
noSmithyDocumentSerde
}
type UpdateAnalysisOutput struct {
// The ID of the analysis.
AnalysisId *string
// The ARN of the analysis that you're updating.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The update status of the last update that was made to the analysis.
UpdateStatus types.ResourceStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateAnalysisMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateAnalysis{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateAnalysis{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateAnalysisValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateAnalysis(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateAnalysis(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateAnalysis",
}
}
| 168 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates the read and write permissions for an analysis.
func (c *Client) UpdateAnalysisPermissions(ctx context.Context, params *UpdateAnalysisPermissionsInput, optFns ...func(*Options)) (*UpdateAnalysisPermissionsOutput, error) {
if params == nil {
params = &UpdateAnalysisPermissionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateAnalysisPermissions", params, optFns, c.addOperationUpdateAnalysisPermissionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateAnalysisPermissionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateAnalysisPermissionsInput struct {
// The ID of the analysis whose permissions you're updating. The ID is part of the
// analysis URL.
//
// This member is required.
AnalysisId *string
// The ID of the Amazon Web Services account that contains the analysis whose
// permissions you're updating. You must be using the Amazon Web Services account
// that the analysis is in.
//
// This member is required.
AwsAccountId *string
// A structure that describes the permissions to add and the principal to add them
// to.
GrantPermissions []types.ResourcePermission
// A structure that describes the permissions to remove and the principal to
// remove them from.
RevokePermissions []types.ResourcePermission
noSmithyDocumentSerde
}
type UpdateAnalysisPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the analysis that you updated.
AnalysisArn *string
// The ID of the analysis that you updated permissions for.
AnalysisId *string
// A structure that describes the principals and the resource-level permissions on
// an analysis.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateAnalysisPermissionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateAnalysisPermissions{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateAnalysisPermissions{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateAnalysisPermissionsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateAnalysisPermissions(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateAnalysisPermissions(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateAnalysisPermissions",
}
}
| 154 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates a dashboard in an Amazon Web Services account. Updating a Dashboard
// creates a new dashboard version but does not immediately publish the new
// version. You can update the published version of a dashboard by using the
// UpdateDashboardPublishedVersion (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html)
// API operation.
func (c *Client) UpdateDashboard(ctx context.Context, params *UpdateDashboardInput, optFns ...func(*Options)) (*UpdateDashboardOutput, error) {
if params == nil {
params = &UpdateDashboardInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateDashboard", params, optFns, c.addOperationUpdateDashboardMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateDashboardOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateDashboardInput struct {
// The ID of the Amazon Web Services account that contains the dashboard that
// you're updating.
//
// This member is required.
AwsAccountId *string
// The ID for the dashboard.
//
// This member is required.
DashboardId *string
// The display name of the dashboard.
//
// This member is required.
Name *string
// Options for publishing the dashboard when you create it:
// - AvailabilityStatus for AdHocFilteringOption - This status can be either
// ENABLED or DISABLED . When this is set to DISABLED , Amazon 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 definition of a dashboard. A definition is the data model of all features
// in a Dashboard, Template, or Analysis.
Definition *types.DashboardVersionDefinition
// A structure that contains the parameters of the dashboard. These are parameter
// overrides for a dashboard. A dashboard can have any type of parameters, and some
// parameters might accept multiple values.
Parameters *types.Parameters
// The entity that you are using as a source when you update the dashboard. In
// SourceEntity , you specify the type of object you're using as source. You can
// only update a dashboard from a template, so you use a SourceTemplate entity. If
// you need to update a dashboard from an analysis, first convert the analysis to a
// template by using the CreateTemplate (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html)
// API operation. For SourceTemplate , specify the Amazon Resource Name (ARN) of
// the source template. The SourceTemplate ARN can contain any Amazon Web Services
// account and any Amazon QuickSight-supported Amazon Web Services Region. Use the
// DataSetReferences entity within SourceTemplate to list the replacement datasets
// for the placeholders listed in the original. The schema in each dataset must
// match its placeholder.
SourceEntity *types.DashboardSourceEntity
// The Amazon Resource Name (ARN) of the theme that is being used for this
// dashboard. If you add a value for this field, it overrides the value that was
// originally associated with the entity. The theme ARN must exist in the same
// Amazon Web Services account where you create the dashboard.
ThemeArn *string
// A description for the first version of the dashboard being created.
VersionDescription *string
noSmithyDocumentSerde
}
type UpdateDashboardOutput struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// The creation status of the request.
CreationStatus types.ResourceStatus
// The ID for the dashboard.
DashboardId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ARN of the dashboard, including the version number.
VersionArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateDashboardMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateDashboard{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateDashboard{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateDashboardValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateDashboard(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateDashboard(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateDashboard",
}
}
| 198 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates read and write permissions on a dashboard.
func (c *Client) UpdateDashboardPermissions(ctx context.Context, params *UpdateDashboardPermissionsInput, optFns ...func(*Options)) (*UpdateDashboardPermissionsOutput, error) {
if params == nil {
params = &UpdateDashboardPermissionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateDashboardPermissions", params, optFns, c.addOperationUpdateDashboardPermissionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateDashboardPermissionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateDashboardPermissionsInput struct {
// The ID of the Amazon Web Services account that contains the dashboard whose
// permissions you're updating.
//
// This member is required.
AwsAccountId *string
// The ID for the dashboard.
//
// This member is required.
DashboardId *string
// Grants link permissions to all users in a defined namespace.
GrantLinkPermissions []types.ResourcePermission
// The permissions that you want to grant on this resource.
GrantPermissions []types.ResourcePermission
// Revokes link permissions from all users in a defined namespace.
RevokeLinkPermissions []types.ResourcePermission
// The permissions that you want to revoke from this resource.
RevokePermissions []types.ResourcePermission
noSmithyDocumentSerde
}
type UpdateDashboardPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the dashboard.
DashboardArn *string
// The ID for the dashboard.
DashboardId *string
// Updates the permissions of a shared link to an Amazon QuickSight dashboard.
LinkSharingConfiguration *types.LinkSharingConfiguration
// Information about the permissions on the dashboard.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateDashboardPermissionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateDashboardPermissions{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateDashboardPermissions{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateDashboardPermissionsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateDashboardPermissions(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateDashboardPermissions(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateDashboardPermissions",
}
}
| 158 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates the published version of a dashboard.
func (c *Client) UpdateDashboardPublishedVersion(ctx context.Context, params *UpdateDashboardPublishedVersionInput, optFns ...func(*Options)) (*UpdateDashboardPublishedVersionOutput, error) {
if params == nil {
params = &UpdateDashboardPublishedVersionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateDashboardPublishedVersion", params, optFns, c.addOperationUpdateDashboardPublishedVersionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateDashboardPublishedVersionOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateDashboardPublishedVersionInput struct {
// The ID of the Amazon Web Services account that contains the dashboard that
// you're updating.
//
// This member is required.
AwsAccountId *string
// The ID for the dashboard.
//
// This member is required.
DashboardId *string
// The version number of the dashboard.
//
// This member is required.
VersionNumber *int64
noSmithyDocumentSerde
}
type UpdateDashboardPublishedVersionOutput struct {
// The Amazon Resource Name (ARN) of the dashboard.
DashboardArn *string
// The ID for the dashboard.
DashboardId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateDashboardPublishedVersionMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateDashboardPublishedVersion{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateDashboardPublishedVersion{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateDashboardPublishedVersionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateDashboardPublishedVersion(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateDashboardPublishedVersion(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateDashboardPublishedVersion",
}
}
| 144 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates a dataset. This operation doesn't support datasets that include
// uploaded files as a source. Partial updates are not supported by this operation.
func (c *Client) UpdateDataSet(ctx context.Context, params *UpdateDataSetInput, optFns ...func(*Options)) (*UpdateDataSetOutput, error) {
if params == nil {
params = &UpdateDataSetInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateDataSet", params, optFns, c.addOperationUpdateDataSetMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateDataSetOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateDataSetInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID for the dataset that you want to update. This ID is unique per Amazon
// Web Services Region for each Amazon Web Services account.
//
// This member is required.
DataSetId *string
// Indicates whether you want to import the data into SPICE.
//
// This member is required.
ImportMode types.DataSetImportMode
// The display name for the dataset.
//
// This member is required.
Name *string
// Declares the physical tables that are available in the underlying data sources.
//
// This member is required.
PhysicalTableMap map[string]types.PhysicalTable
// Groupings of columns that work together in certain Amazon QuickSight features.
// Currently, only geospatial hierarchy is supported.
ColumnGroups []types.ColumnGroup
// A set of one or more definitions of a ColumnLevelPermissionRule (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html)
// .
ColumnLevelPermissionRules []types.ColumnLevelPermissionRule
// The usage configuration to apply to child datasets that reference this dataset
// as a source.
DataSetUsageConfiguration *types.DataSetUsageConfiguration
// The parameter declarations of the dataset.
DatasetParameters []types.DatasetParameter
// The folder that contains fields and nested subfolders for your dataset.
FieldFolders map[string]types.FieldFolder
// Configures the combination and transformation of the data from the physical
// tables.
LogicalTableMap map[string]types.LogicalTable
// The row-level security configuration for the data you want to create.
RowLevelPermissionDataSet *types.RowLevelPermissionDataSet
// The configuration of tags on a dataset to set row-level security. Row-level
// security tags are currently supported for anonymous embedding only.
RowLevelPermissionTagConfiguration *types.RowLevelPermissionTagConfiguration
noSmithyDocumentSerde
}
type UpdateDataSetOutput struct {
// The Amazon Resource Name (ARN) of the dataset.
Arn *string
// The ID for the dataset that you want to create. This ID is unique per Amazon
// Web Services Region for each Amazon Web Services account.
DataSetId *string
// The ARN for the ingestion, which is triggered as a result of dataset creation
// if the import mode is SPICE.
IngestionArn *string
// The ID of the ingestion, which is triggered as a result of dataset creation if
// the import mode is SPICE.
IngestionId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateDataSetMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateDataSet{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateDataSet{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateDataSetValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateDataSet(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateDataSet(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateDataSet",
}
}
| 194 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates the permissions on a dataset. The permissions resource is
// arn:aws:quicksight:region:aws-account-id:dataset/data-set-id .
func (c *Client) UpdateDataSetPermissions(ctx context.Context, params *UpdateDataSetPermissionsInput, optFns ...func(*Options)) (*UpdateDataSetPermissionsOutput, error) {
if params == nil {
params = &UpdateDataSetPermissionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateDataSetPermissions", params, optFns, c.addOperationUpdateDataSetPermissionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateDataSetPermissionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateDataSetPermissionsInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID for the dataset whose permissions you want to update. This ID is unique
// per Amazon Web Services Region for each Amazon Web Services account.
//
// This member is required.
DataSetId *string
// The resource permissions that you want to grant to the dataset.
GrantPermissions []types.ResourcePermission
// The resource permissions that you want to revoke from the dataset.
RevokePermissions []types.ResourcePermission
noSmithyDocumentSerde
}
type UpdateDataSetPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the dataset.
DataSetArn *string
// The ID for the dataset whose permissions you want to update. This ID is unique
// per Amazon Web Services Region for each Amazon Web Services account.
DataSetId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateDataSetPermissionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateDataSetPermissions{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateDataSetPermissions{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateDataSetPermissionsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateDataSetPermissions(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateDataSetPermissions(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateDataSetPermissions",
}
}
| 148 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates a data source.
func (c *Client) UpdateDataSource(ctx context.Context, params *UpdateDataSourceInput, optFns ...func(*Options)) (*UpdateDataSourceOutput, error) {
if params == nil {
params = &UpdateDataSourceInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateDataSource", params, optFns, c.addOperationUpdateDataSourceMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateDataSourceOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateDataSourceInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
//
// This member is required.
DataSourceId *string
// A display name for the data source.
//
// This member is required.
Name *string
// The credentials that Amazon QuickSight that uses to connect to your underlying
// source. Currently, only credentials based on user name and password are
// supported.
Credentials *types.DataSourceCredentials
// The parameters that Amazon QuickSight uses to connect to your underlying source.
DataSourceParameters types.DataSourceParameters
// Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects
// to your underlying source.
SslProperties *types.SslProperties
// Use this parameter only when you want Amazon QuickSight to use a VPC connection
// when connecting to your underlying source.
VpcConnectionProperties *types.VpcConnectionProperties
noSmithyDocumentSerde
}
type UpdateDataSourceOutput struct {
// The Amazon Resource Name (ARN) of the data source.
Arn *string
// The ID of the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
DataSourceId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The update status of the data source's last update.
UpdateStatus types.ResourceStatus
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateDataSourceMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateDataSource{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateDataSource{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateDataSourceValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateDataSource(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateDataSource(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateDataSource",
}
}
| 165 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates the permissions to a data source.
func (c *Client) UpdateDataSourcePermissions(ctx context.Context, params *UpdateDataSourcePermissionsInput, optFns ...func(*Options)) (*UpdateDataSourcePermissionsOutput, error) {
if params == nil {
params = &UpdateDataSourcePermissionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateDataSourcePermissions", params, optFns, c.addOperationUpdateDataSourcePermissionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateDataSourcePermissionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateDataSourcePermissionsInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
//
// This member is required.
DataSourceId *string
// A list of resource permissions that you want to grant on the data source.
GrantPermissions []types.ResourcePermission
// A list of resource permissions that you want to revoke on the data source.
RevokePermissions []types.ResourcePermission
noSmithyDocumentSerde
}
type UpdateDataSourcePermissionsOutput struct {
// The Amazon Resource Name (ARN) of the data source.
DataSourceArn *string
// The ID of the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
DataSourceId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateDataSourcePermissionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateDataSourcePermissions{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateDataSourcePermissions{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateDataSourcePermissionsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateDataSourcePermissions(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateDataSourcePermissions(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateDataSourcePermissions",
}
}
| 147 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates the name of a folder.
func (c *Client) UpdateFolder(ctx context.Context, params *UpdateFolderInput, optFns ...func(*Options)) (*UpdateFolderOutput, error) {
if params == nil {
params = &UpdateFolderInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateFolder", params, optFns, c.addOperationUpdateFolderMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateFolderOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateFolderInput struct {
// The ID for the Amazon Web Services account that contains the folder to update.
//
// This member is required.
AwsAccountId *string
// The ID of the folder.
//
// This member is required.
FolderId *string
// The name of the folder.
//
// This member is required.
Name *string
noSmithyDocumentSerde
}
type UpdateFolderOutput struct {
// The Amazon Resource Name (ARN) of the folder.
Arn *string
// The ID of the folder.
FolderId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateFolderMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateFolder{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateFolder{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateFolderValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateFolder(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateFolder(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateFolder",
}
}
| 143 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates permissions of a folder.
func (c *Client) UpdateFolderPermissions(ctx context.Context, params *UpdateFolderPermissionsInput, optFns ...func(*Options)) (*UpdateFolderPermissionsOutput, error) {
if params == nil {
params = &UpdateFolderPermissionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateFolderPermissions", params, optFns, c.addOperationUpdateFolderPermissionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateFolderPermissionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateFolderPermissionsInput struct {
// The ID for the Amazon Web Services account that contains the folder to update.
//
// This member is required.
AwsAccountId *string
// The ID of the folder.
//
// This member is required.
FolderId *string
// The permissions that you want to grant on a resource.
GrantPermissions []types.ResourcePermission
// The permissions that you want to revoke from a resource.
RevokePermissions []types.ResourcePermission
noSmithyDocumentSerde
}
type UpdateFolderPermissionsOutput struct {
// The Amazon Resource Name (ARN) of the folder.
Arn *string
// The ID of the folder.
FolderId *string
// Information about the permissions for the folder.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateFolderPermissionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateFolderPermissions{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateFolderPermissions{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateFolderPermissionsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateFolderPermissions(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateFolderPermissions(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateFolderPermissions",
}
}
| 148 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Changes a group description.
func (c *Client) UpdateGroup(ctx context.Context, params *UpdateGroupInput, optFns ...func(*Options)) (*UpdateGroupOutput, error) {
if params == nil {
params = &UpdateGroupInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateGroup", params, optFns, c.addOperationUpdateGroupMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateGroupOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateGroupInput struct {
// The ID for the Amazon Web Services account that the group is in. Currently, you
// use the ID for the Amazon Web Services account that contains your Amazon
// QuickSight account.
//
// This member is required.
AwsAccountId *string
// The name of the group that you want to update.
//
// This member is required.
GroupName *string
// The namespace of the group that you want to update.
//
// This member is required.
Namespace *string
// The description for the group that you want to update.
Description *string
noSmithyDocumentSerde
}
type UpdateGroupOutput struct {
// The name of the group.
Group *types.Group
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateGroupMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateGroup{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateGroup{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateGroupValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateGroup(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateGroup(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateGroup",
}
}
| 146 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates an existing IAM policy assignment. This operation updates only the
// optional parameter or parameters that are specified in the request. This
// overwrites all of the users included in Identities .
func (c *Client) UpdateIAMPolicyAssignment(ctx context.Context, params *UpdateIAMPolicyAssignmentInput, optFns ...func(*Options)) (*UpdateIAMPolicyAssignmentOutput, error) {
if params == nil {
params = &UpdateIAMPolicyAssignmentInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateIAMPolicyAssignment", params, optFns, c.addOperationUpdateIAMPolicyAssignmentMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateIAMPolicyAssignmentOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateIAMPolicyAssignmentInput struct {
// The name of the assignment, also called a rule. The name must be unique within
// the Amazon Web Services account.
//
// This member is required.
AssignmentName *string
// The ID of the Amazon Web Services account that contains the IAM policy
// assignment.
//
// This member is required.
AwsAccountId *string
// The namespace of the assignment.
//
// This member is required.
Namespace *string
// The status of the assignment. Possible values are as follows:
// - ENABLED - Anything specified in this assignment is used when creating the
// data source.
// - DISABLED - This assignment isn't used when creating the data source.
// - DRAFT - This assignment is an unfinished draft and isn't used when creating
// the data source.
AssignmentStatus types.AssignmentStatus
// The Amazon QuickSight users, groups, or both that you want to assign the policy
// to.
Identities map[string][]string
// The ARN for the IAM policy to apply to the Amazon QuickSight users and groups
// specified in this assignment.
PolicyArn *string
noSmithyDocumentSerde
}
type UpdateIAMPolicyAssignmentOutput struct {
// The ID of the assignment.
AssignmentId *string
// The name of the assignment or rule.
AssignmentName *string
// The status of the assignment. Possible values are as follows:
// - ENABLED - Anything specified in this assignment is used when creating the
// data source.
// - DISABLED - This assignment isn't used when creating the data source.
// - DRAFT - This assignment is an unfinished draft and isn't used when creating
// the data source.
AssignmentStatus types.AssignmentStatus
// The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.
Identities map[string][]string
// The ARN for the IAM policy applied to the Amazon QuickSight users and groups
// specified in this assignment.
PolicyArn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateIAMPolicyAssignmentMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateIAMPolicyAssignment{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateIAMPolicyAssignment{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateIAMPolicyAssignmentValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateIAMPolicyAssignment(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateIAMPolicyAssignment(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateIAMPolicyAssignment",
}
}
| 179 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates the content and status of IP rules. To use this operation, you must
// provide the entire map of rules. You can use the DescribeIpRestriction
// operation to get the current rule map.
func (c *Client) UpdateIpRestriction(ctx context.Context, params *UpdateIpRestrictionInput, optFns ...func(*Options)) (*UpdateIpRestrictionOutput, error) {
if params == nil {
params = &UpdateIpRestrictionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateIpRestriction", params, optFns, c.addOperationUpdateIpRestrictionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateIpRestrictionOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateIpRestrictionInput struct {
// The ID of the Amazon Web Services account that contains the IP rules.
//
// This member is required.
AwsAccountId *string
// A value that specifies whether IP rules are turned on.
Enabled *bool
// A map that describes the updated IP rules with CIDR ranges and descriptions.
IpRestrictionRuleMap map[string]string
noSmithyDocumentSerde
}
type UpdateIpRestrictionOutput struct {
// The ID of the Amazon Web Services account that contains the IP rules.
AwsAccountId *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateIpRestrictionMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateIpRestriction{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateIpRestriction{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateIpRestrictionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateIpRestriction(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateIpRestriction(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateIpRestriction",
}
}
| 138 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Use the UpdatePublicSharingSettings operation to turn on or turn off the public
// sharing settings of an Amazon QuickSight dashboard. To use this operation, turn
// on session capacity pricing for your Amazon QuickSight account. Before you can
// turn on public sharing on your account, make sure to give public sharing
// permissions to an administrative user in the Identity and Access Management
// (IAM) console. For more information on using IAM with Amazon QuickSight, see
// Using Amazon QuickSight with IAM (https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html)
// in the Amazon QuickSight User Guide.
func (c *Client) UpdatePublicSharingSettings(ctx context.Context, params *UpdatePublicSharingSettingsInput, optFns ...func(*Options)) (*UpdatePublicSharingSettingsOutput, error) {
if params == nil {
params = &UpdatePublicSharingSettingsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdatePublicSharingSettings", params, optFns, c.addOperationUpdatePublicSharingSettingsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdatePublicSharingSettingsOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdatePublicSharingSettingsInput struct {
// The Amazon Web Services account ID associated with your Amazon QuickSight
// subscription.
//
// This member is required.
AwsAccountId *string
// A Boolean value that indicates whether public sharing is turned on for an
// Amazon QuickSight account.
PublicSharingEnabled bool
noSmithyDocumentSerde
}
type UpdatePublicSharingSettingsOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdatePublicSharingSettingsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdatePublicSharingSettings{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdatePublicSharingSettings{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdatePublicSharingSettingsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdatePublicSharingSettings(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdatePublicSharingSettings(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdatePublicSharingSettings",
}
}
| 139 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates a refresh schedule for a dataset.
func (c *Client) UpdateRefreshSchedule(ctx context.Context, params *UpdateRefreshScheduleInput, optFns ...func(*Options)) (*UpdateRefreshScheduleOutput, error) {
if params == nil {
params = &UpdateRefreshScheduleInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateRefreshSchedule", params, optFns, c.addOperationUpdateRefreshScheduleMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateRefreshScheduleOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateRefreshScheduleInput struct {
// The Amazon Web Services account ID.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset.
//
// This member is required.
DataSetId *string
// The refresh schedule.
//
// This member is required.
Schedule *types.RefreshSchedule
noSmithyDocumentSerde
}
type UpdateRefreshScheduleOutput struct {
// The Amazon Resource Name (ARN) for the refresh schedule.
Arn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The ID of the refresh schedule.
ScheduleId *string
// The HTTP status of the request.
Status int32
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateRefreshScheduleMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateRefreshSchedule{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateRefreshSchedule{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateRefreshScheduleValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateRefreshSchedule(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateRefreshSchedule(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateRefreshSchedule",
}
}
| 144 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates a template from an existing Amazon QuickSight analysis or another
// template.
func (c *Client) UpdateTemplate(ctx context.Context, params *UpdateTemplateInput, optFns ...func(*Options)) (*UpdateTemplateOutput, error) {
if params == nil {
params = &UpdateTemplateInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateTemplate", params, optFns, c.addOperationUpdateTemplateMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateTemplateOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateTemplateInput struct {
// The ID of the Amazon Web Services account that contains the template that
// you're updating.
//
// This member is required.
AwsAccountId *string
// The ID for the template.
//
// This member is required.
TemplateId *string
// The definition of a template. A definition is the data model of all features in
// a Dashboard, Template, or Analysis.
Definition *types.TemplateVersionDefinition
// The name for the template.
Name *string
// The entity that you are using as a source when you update the template. In
// SourceEntity , you specify the type of object you're using as source:
// SourceTemplate for a template or SourceAnalysis for an analysis. Both of these
// require an Amazon Resource Name (ARN). For SourceTemplate , specify the ARN of
// the source template. For SourceAnalysis , specify the ARN of the source
// analysis. The SourceTemplate ARN can contain any Amazon Web Services account
// and any Amazon QuickSight-supported Amazon Web Services Region;. Use the
// DataSetReferences entity within SourceTemplate or SourceAnalysis to list the
// replacement datasets for the placeholders listed in the original. The schema in
// each dataset must match its placeholder.
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
noSmithyDocumentSerde
}
type UpdateTemplateOutput struct {
// The Amazon Resource Name (ARN) for the template.
Arn *string
// The creation status of the template.
CreationStatus types.ResourceStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ID for the template.
TemplateId *string
// The ARN for the template, including the version information of the first
// version.
VersionArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateTemplateMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateTemplate{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateTemplate{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateTemplateValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateTemplate(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateTemplate(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateTemplate",
}
}
| 173 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates the template alias of a template.
func (c *Client) UpdateTemplateAlias(ctx context.Context, params *UpdateTemplateAliasInput, optFns ...func(*Options)) (*UpdateTemplateAliasOutput, error) {
if params == nil {
params = &UpdateTemplateAliasInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateTemplateAlias", params, optFns, c.addOperationUpdateTemplateAliasMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateTemplateAliasOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateTemplateAliasInput struct {
// The alias of the template that you want to update. If you name a specific
// alias, you update the version that the alias points to. You can specify the
// latest version of the template by providing the keyword $LATEST in the AliasName
// parameter. The keyword $PUBLISHED doesn't apply to templates.
//
// This member is required.
AliasName *string
// The ID of the Amazon Web Services account that contains the template alias that
// you're updating.
//
// This member is required.
AwsAccountId *string
// The ID for the template.
//
// This member is required.
TemplateId *string
// The version number of the template.
//
// This member is required.
TemplateVersionNumber *int64
noSmithyDocumentSerde
}
type UpdateTemplateAliasOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The template alias.
TemplateAlias *types.TemplateAlias
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateTemplateAliasMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateTemplateAlias{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateTemplateAlias{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateTemplateAliasValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateTemplateAlias(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateTemplateAlias(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateTemplateAlias",
}
}
| 150 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates the resource permissions for a template.
func (c *Client) UpdateTemplatePermissions(ctx context.Context, params *UpdateTemplatePermissionsInput, optFns ...func(*Options)) (*UpdateTemplatePermissionsOutput, error) {
if params == nil {
params = &UpdateTemplatePermissionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateTemplatePermissions", params, optFns, c.addOperationUpdateTemplatePermissionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateTemplatePermissionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateTemplatePermissionsInput struct {
// The ID of the Amazon Web Services account that contains the template.
//
// This member is required.
AwsAccountId *string
// The ID for the template.
//
// This member is required.
TemplateId *string
// A list of resource permissions to be granted on the template.
GrantPermissions []types.ResourcePermission
// A list of resource permissions to be revoked from the template.
RevokePermissions []types.ResourcePermission
noSmithyDocumentSerde
}
type UpdateTemplatePermissionsOutput struct {
// A list of resource permissions to be set on the template.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the template.
TemplateArn *string
// The ID for the template.
TemplateId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateTemplatePermissionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateTemplatePermissions{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateTemplatePermissions{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateTemplatePermissionsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateTemplatePermissions(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateTemplatePermissions(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateTemplatePermissions",
}
}
| 148 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates a theme.
func (c *Client) UpdateTheme(ctx context.Context, params *UpdateThemeInput, optFns ...func(*Options)) (*UpdateThemeOutput, error) {
if params == nil {
params = &UpdateThemeInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateTheme", params, optFns, c.addOperationUpdateThemeMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateThemeOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateThemeInput struct {
// The ID of the Amazon Web Services account that contains the theme that you're
// updating.
//
// This member is required.
AwsAccountId *string
// The theme ID, defined by Amazon QuickSight, that a custom theme inherits from.
// All themes initially inherit from a default Amazon QuickSight theme.
//
// This member is required.
BaseThemeId *string
// The ID for the theme.
//
// This member is required.
ThemeId *string
// The theme configuration, which contains the theme display properties.
Configuration *types.ThemeConfiguration
// The name for the theme.
Name *string
// A description of the theme version that you're updating Every time that you
// call UpdateTheme , you create a new version of the theme. Each version of the
// theme maintains a description of the version in VersionDescription .
VersionDescription *string
noSmithyDocumentSerde
}
type UpdateThemeOutput struct {
// The Amazon Resource Name (ARN) for the theme.
Arn *string
// The creation status of the theme.
CreationStatus types.ResourceStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ID for the theme.
ThemeId *string
// The Amazon Resource Name (ARN) for the new version of the theme.
VersionArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateThemeMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateTheme{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateTheme{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateThemeValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateTheme(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateTheme(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateTheme",
}
}
| 163 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates an alias of a theme.
func (c *Client) UpdateThemeAlias(ctx context.Context, params *UpdateThemeAliasInput, optFns ...func(*Options)) (*UpdateThemeAliasOutput, error) {
if params == nil {
params = &UpdateThemeAliasInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateThemeAlias", params, optFns, c.addOperationUpdateThemeAliasMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateThemeAliasOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateThemeAliasInput struct {
// The name of the theme alias that you want to update.
//
// This member is required.
AliasName *string
// The ID of the Amazon Web Services account that contains the theme alias that
// you're updating.
//
// This member is required.
AwsAccountId *string
// The ID for the theme.
//
// This member is required.
ThemeId *string
// The version number of the theme that the alias should reference.
//
// This member is required.
ThemeVersionNumber *int64
noSmithyDocumentSerde
}
type UpdateThemeAliasOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// Information about the theme alias.
ThemeAlias *types.ThemeAlias
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateThemeAliasMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateThemeAlias{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateThemeAlias{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateThemeAliasValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateThemeAlias(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateThemeAlias(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateThemeAlias",
}
}
| 147 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// 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 (c *Client) UpdateThemePermissions(ctx context.Context, params *UpdateThemePermissionsInput, optFns ...func(*Options)) (*UpdateThemePermissionsOutput, error) {
if params == nil {
params = &UpdateThemePermissionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateThemePermissions", params, optFns, c.addOperationUpdateThemePermissionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateThemePermissionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateThemePermissionsInput struct {
// The ID of the Amazon Web Services account that contains the theme.
//
// This member is required.
AwsAccountId *string
// The ID for the theme.
//
// This member is required.
ThemeId *string
// A list of resource permissions to be granted for the theme.
GrantPermissions []types.ResourcePermission
// A list of resource permissions to be revoked from the theme.
RevokePermissions []types.ResourcePermission
noSmithyDocumentSerde
}
type UpdateThemePermissionsOutput struct {
// The resulting list of resource permissions for the theme.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the theme.
ThemeArn *string
// The ID for the theme.
ThemeId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateThemePermissionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateThemePermissions{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateThemePermissions{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateThemePermissionsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateThemePermissions(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateThemePermissions(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateThemePermissions",
}
}
| 169 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates a topic.
func (c *Client) UpdateTopic(ctx context.Context, params *UpdateTopicInput, optFns ...func(*Options)) (*UpdateTopicOutput, error) {
if params == nil {
params = &UpdateTopicInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateTopic", params, optFns, c.addOperationUpdateTopicMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateTopicOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateTopicInput struct {
// The ID of the Amazon Web Services account that contains the topic that you want
// to update.
//
// This member is required.
AwsAccountId *string
// The definition of the topic that you want to update.
//
// This member is required.
Topic *types.TopicDetails
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
noSmithyDocumentSerde
}
type UpdateTopicOutput struct {
// The Amazon Resource Name (ARN) of the topic.
Arn *string
// The Amazon Resource Name (ARN) of the topic refresh.
RefreshArn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateTopicMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateTopic{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateTopic{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateTopicValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateTopic(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateTopic(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateTopic",
}
}
| 150 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates the permissions of a topic.
func (c *Client) UpdateTopicPermissions(ctx context.Context, params *UpdateTopicPermissionsInput, optFns ...func(*Options)) (*UpdateTopicPermissionsOutput, error) {
if params == nil {
params = &UpdateTopicPermissionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateTopicPermissions", params, optFns, c.addOperationUpdateTopicPermissionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateTopicPermissionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateTopicPermissionsInput struct {
// The ID of the Amazon Web Services account that contains the topic that you want
// to update the permissions for.
//
// This member is required.
AwsAccountId *string
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
// The resource permissions that you want to grant to the topic.
GrantPermissions []types.ResourcePermission
// The resource permissions that you want to revoke from the topic.
RevokePermissions []types.ResourcePermission
noSmithyDocumentSerde
}
type UpdateTopicPermissionsOutput struct {
// A list of resource permissions on the topic.
Permissions []types.ResourcePermission
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the topic.
TopicArn *string
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateTopicPermissionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateTopicPermissions{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateTopicPermissions{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateTopicPermissionsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateTopicPermissions(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateTopicPermissions(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateTopicPermissions",
}
}
| 151 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates a topic refresh schedule.
func (c *Client) UpdateTopicRefreshSchedule(ctx context.Context, params *UpdateTopicRefreshScheduleInput, optFns ...func(*Options)) (*UpdateTopicRefreshScheduleOutput, error) {
if params == nil {
params = &UpdateTopicRefreshScheduleInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateTopicRefreshSchedule", params, optFns, c.addOperationUpdateTopicRefreshScheduleMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateTopicRefreshScheduleOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateTopicRefreshScheduleInput struct {
// The ID of the Amazon Web Services account that contains the topic whose refresh
// schedule you want to update.
//
// This member is required.
AwsAccountId *string
// The ID of the dataset.
//
// This member is required.
DatasetId *string
// The definition of a refresh schedule.
//
// This member is required.
RefreshSchedule *types.TopicRefreshSchedule
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
//
// This member is required.
TopicId *string
noSmithyDocumentSerde
}
type UpdateTopicRefreshScheduleOutput struct {
// The Amazon Resource Name (ARN) of the dataset.
DatasetArn *string
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon Resource Name (ARN) of the topic.
TopicArn *string
// The ID of the topic that you want to modify. This ID is unique per Amazon Web
// Services Region for each Amazon Web Services account.
TopicId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateTopicRefreshScheduleMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateTopicRefreshSchedule{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateTopicRefreshSchedule{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateTopicRefreshScheduleValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateTopicRefreshSchedule(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateTopicRefreshSchedule(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateTopicRefreshSchedule",
}
}
| 155 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates an Amazon QuickSight user.
func (c *Client) UpdateUser(ctx context.Context, params *UpdateUserInput, optFns ...func(*Options)) (*UpdateUserOutput, error) {
if params == nil {
params = &UpdateUserInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateUser", params, optFns, c.addOperationUpdateUserMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateUserOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateUserInput struct {
// The ID for the Amazon Web Services account that the user is in. Currently, you
// use the ID for the Amazon Web Services account that contains your Amazon
// QuickSight account.
//
// This member is required.
AwsAccountId *string
// The email address of the user that you want to update.
//
// This member is required.
Email *string
// The namespace. Currently, you should set this to default .
//
// This member is required.
Namespace *string
// The Amazon QuickSight role of the user. The role can be one of the following
// default security cohorts:
// - READER : A user who has read-only access to dashboards.
// - AUTHOR : A user who can create data sources, datasets, analyses, and
// dashboards.
// - ADMIN : A user who is an author, who can also manage Amazon QuickSight
// settings.
// The name of the Amazon QuickSight role is invisible to the user except for the
// console screens dealing with permissions.
//
// This member is required.
Role types.UserRole
// The Amazon QuickSight user name that you want to update.
//
// This member is required.
UserName *string
// The URL of the custom OpenID Connect (OIDC) provider that provides identity to
// let a user federate into Amazon QuickSight with an associated Identity and
// Access Management(IAM) role. This parameter should only be used when
// ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC .
CustomFederationProviderUrl *string
// (Enterprise edition only) The name of the custom permissions profile that you
// want to assign to this user. Customized permissions allows you to control a
// user's access by restricting access the following operations:
// - Create and update data sources
// - Create and update datasets
// - Create and update email reports
// - Subscribe to email reports
// A set of custom permissions includes any combination of these restrictions.
// Currently, you need to create the profile names for custom permission sets by
// using the Amazon QuickSight console. Then, you use the RegisterUser API
// operation to assign the named set of permissions to a Amazon QuickSight user.
// Amazon QuickSight custom permissions are applied through IAM policies.
// Therefore, they override the permissions typically granted by assigning Amazon
// QuickSight users to one of the default security cohorts in Amazon QuickSight
// (admin, author, reader). This feature is available only to Amazon QuickSight
// Enterprise edition subscriptions.
CustomPermissionsName *string
// The type of supported external login provider that provides identity to let a
// user federate into Amazon QuickSight with an associated Identity and Access
// Management(IAM) role. The type of supported external login provider can be one
// of the following.
// - COGNITO : Amazon Cognito. The provider URL is
// cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t
// use the "CustomFederationProviderUrl" parameter which is only needed when the
// external provider is custom.
// - CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider. When choosing
// CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the
// custom OIDC provider URL.
// - NONE : This clears all the previously saved external login information for a
// user. Use the DescribeUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html)
// API operation to check the external login information.
ExternalLoginFederationProviderType *string
// The identity ID for a user in the external login provider.
ExternalLoginId *string
// A flag that you use to indicate that you want to remove all custom permissions
// from this user. Using this parameter resets the user to the state it was in
// before a custom permissions profile was applied. This parameter defaults to NULL
// and it doesn't accept any other value.
UnapplyCustomPermissions bool
noSmithyDocumentSerde
}
type UpdateUserOutput struct {
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The Amazon QuickSight user.
User *types.User
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateUserMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateUser{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateUser{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateUserValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateUser(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateUser(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateUser",
}
}
| 210 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates a VPC connection.
func (c *Client) UpdateVPCConnection(ctx context.Context, params *UpdateVPCConnectionInput, optFns ...func(*Options)) (*UpdateVPCConnectionOutput, error) {
if params == nil {
params = &UpdateVPCConnectionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "UpdateVPCConnection", params, optFns, c.addOperationUpdateVPCConnectionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*UpdateVPCConnectionOutput)
out.ResultMetadata = metadata
return out, nil
}
type UpdateVPCConnectionInput struct {
// The Amazon Web Services account ID of the account that contains the VPC
// connection that you want to update.
//
// This member is required.
AwsAccountId *string
// The display name for the VPC connection.
//
// This member is required.
Name *string
// An IAM role associated with the VPC connection.
//
// This member is required.
RoleArn *string
// A list of security group IDs for the VPC connection.
//
// This member is required.
SecurityGroupIds []string
// A list of subnet IDs for the VPC connection.
//
// This member is required.
SubnetIds []string
// The ID of the VPC connection that you're updating. This ID is a unique
// identifier for each Amazon Web Services Region in an Amazon Web Services
// account.
//
// This member is required.
VPCConnectionId *string
// A list of IP addresses of DNS resolver endpoints for the VPC connection.
DnsResolvers []string
noSmithyDocumentSerde
}
type UpdateVPCConnectionOutput struct {
// The Amazon Resource Name (ARN) of the VPC connection.
Arn *string
// The availability status of the VPC connection.
AvailabilityStatus types.VPCConnectionAvailabilityStatus
// The Amazon Web Services request ID for this operation.
RequestId *string
// The HTTP status of the request.
Status int32
// The update status of the VPC connection's last update.
UpdateStatus types.VPCConnectionResourceStatus
// The ID of the VPC connection that you are updating. This ID is a unique
// identifier for each Amazon Web Services Region in anAmazon Web Services account.
VPCConnectionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationUpdateVPCConnectionMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpUpdateVPCConnection{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpUpdateVPCConnection{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpUpdateVPCConnectionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateVPCConnection(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opUpdateVPCConnection(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "quicksight",
OperationName: "UpdateVPCConnection",
}
}
| 172 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
// Package quicksight provides the API client, operations, and parameter types for
// Amazon QuickSight.
//
// Amazon QuickSight API Reference Amazon QuickSight is a fully managed,
// serverless business intelligence service for the Amazon Web Services Cloud that
// makes it easy to extend data and insights to every user in your organization.
// This API reference contains documentation for a programming interface that you
// can use to manage Amazon QuickSight.
package quicksight
| 12 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
import (
"context"
"errors"
"fmt"
"github.com/aws/aws-sdk-go-v2/aws"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
internalendpoints "github.com/aws/aws-sdk-go-v2/service/quicksight/internal/endpoints"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"net/url"
"strings"
)
// EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverOptions = internalendpoints.Options
// EndpointResolver interface for resolving service endpoints.
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
var _ EndpointResolver = &internalendpoints.Resolver{}
// NewDefaultEndpointResolver constructs a new service endpoint resolver
func NewDefaultEndpointResolver() *internalendpoints.Resolver {
return internalendpoints.New()
}
// 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.
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error) {
return fn(region, options)
}
func resolveDefaultEndpointConfiguration(o *Options) {
if o.EndpointResolver != nil {
return
}
o.EndpointResolver = NewDefaultEndpointResolver()
}
// EndpointResolverFromURL returns an EndpointResolver configured using the
// provided endpoint url. By default, the resolved endpoint resolver uses the
// client region as signing region, and the endpoint source is set to
// EndpointSourceCustom.You can provide functional options to configure endpoint
// values for the resolved endpoint.
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver {
e := aws.Endpoint{URL: url, Source: aws.EndpointSourceCustom}
for _, fn := range optFns {
fn(&e)
}
return EndpointResolverFunc(
func(region string, options EndpointResolverOptions) (aws.Endpoint, error) {
if len(e.SigningRegion) == 0 {
e.SigningRegion = region
}
return e, nil
},
)
}
type ResolveEndpoint struct {
Resolver EndpointResolver
Options EndpointResolverOptions
}
func (*ResolveEndpoint) ID() string {
return "ResolveEndpoint"
}
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
out middleware.SerializeOutput, metadata middleware.Metadata, err error,
) {
req, ok := in.Request.(*smithyhttp.Request)
if !ok {
return out, metadata, fmt.Errorf("unknown transport type %T", in.Request)
}
if m.Resolver == nil {
return out, metadata, fmt.Errorf("expected endpoint resolver to not be nil")
}
eo := m.Options
eo.Logger = middleware.GetLogger(ctx)
var endpoint aws.Endpoint
endpoint, err = m.Resolver.ResolveEndpoint(awsmiddleware.GetRegion(ctx), eo)
if err != nil {
return out, metadata, fmt.Errorf("failed to resolve service endpoint, %w", err)
}
req.URL, err = url.Parse(endpoint.URL)
if err != nil {
return out, metadata, fmt.Errorf("failed to parse endpoint URL: %w", err)
}
if len(awsmiddleware.GetSigningName(ctx)) == 0 {
signingName := endpoint.SigningName
if len(signingName) == 0 {
signingName = "quicksight"
}
ctx = awsmiddleware.SetSigningName(ctx, signingName)
}
ctx = awsmiddleware.SetEndpointSource(ctx, endpoint.Source)
ctx = smithyhttp.SetHostnameImmutable(ctx, endpoint.HostnameImmutable)
ctx = awsmiddleware.SetSigningRegion(ctx, endpoint.SigningRegion)
ctx = awsmiddleware.SetPartitionID(ctx, endpoint.PartitionID)
return next.HandleSerialize(ctx, in)
}
func addResolveEndpointMiddleware(stack *middleware.Stack, o Options) error {
return stack.Serialize.Insert(&ResolveEndpoint{
Resolver: o.EndpointResolver,
Options: o.EndpointOptions,
}, "OperationSerializer", middleware.Before)
}
func removeResolveEndpointMiddleware(stack *middleware.Stack) error {
_, err := stack.Serialize.Remove((&ResolveEndpoint{}).ID())
return err
}
type wrappedEndpointResolver struct {
awsResolver aws.EndpointResolverWithOptions
resolver EndpointResolver
}
func (w *wrappedEndpointResolver) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error) {
if w.awsResolver == nil {
goto fallback
}
endpoint, err = w.awsResolver.ResolveEndpoint(ServiceID, region, options)
if err == nil {
return endpoint, nil
}
if nf := (&aws.EndpointNotFoundError{}); !errors.As(err, &nf) {
return endpoint, err
}
fallback:
if w.resolver == nil {
return endpoint, fmt.Errorf("default endpoint resolver provided was nil")
}
return w.resolver.ResolveEndpoint(region, options)
}
type awsEndpointResolverAdaptor func(service, region string) (aws.Endpoint, error)
func (a awsEndpointResolverAdaptor) ResolveEndpoint(service, region string, options ...interface{}) (aws.Endpoint, error) {
return a(service, region)
}
var _ aws.EndpointResolverWithOptions = awsEndpointResolverAdaptor(nil)
// 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.
//
// fallbackResolver must not be nil
func withEndpointResolver(awsResolver aws.EndpointResolver, awsResolverWithOptions aws.EndpointResolverWithOptions, fallbackResolver EndpointResolver) EndpointResolver {
var resolver aws.EndpointResolverWithOptions
if awsResolverWithOptions != nil {
resolver = awsResolverWithOptions
} else if awsResolver != nil {
resolver = awsEndpointResolverAdaptor(awsResolver.ResolveEndpoint)
}
return &wrappedEndpointResolver{
awsResolver: resolver,
resolver: fallbackResolver,
}
}
func finalizeClientEndpointResolverOptions(options *Options) {
options.EndpointOptions.LogDeprecated = options.ClientLogMode.IsDeprecatedUsage()
if len(options.EndpointOptions.ResolvedRegion) == 0 {
const fipsInfix = "-fips-"
const fipsPrefix = "fips-"
const fipsSuffix = "-fips"
if strings.Contains(options.Region, fipsInfix) ||
strings.Contains(options.Region, fipsPrefix) ||
strings.Contains(options.Region, fipsSuffix) {
options.EndpointOptions.ResolvedRegion = strings.ReplaceAll(strings.ReplaceAll(strings.ReplaceAll(
options.Region, fipsInfix, "-"), fipsPrefix, ""), fipsSuffix, "")
options.EndpointOptions.UseFIPSEndpoint = aws.FIPSEndpointStateEnabled
}
}
}
| 201 |
aws-sdk-go-v2 | aws | Go | // Code generated by internal/repotools/cmd/updatemodulemeta DO NOT EDIT.
package quicksight
// goModuleVersion is the tagged release for this module
const goModuleVersion = "1.37.2"
| 7 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package quicksight
| 4 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package endpoints
import (
"github.com/aws/aws-sdk-go-v2/aws"
endpoints "github.com/aws/aws-sdk-go-v2/internal/endpoints/v2"
"github.com/aws/smithy-go/logging"
"regexp"
)
// Options is the endpoint resolver configuration options
type Options struct {
// Logger is a logging implementation that log events should be sent to.
Logger logging.Logger
// LogDeprecated indicates that deprecated endpoints should be logged to the
// provided logger.
LogDeprecated bool
// ResolvedRegion is used to override the region to be resolved, rather then the
// using the value passed to the ResolveEndpoint method. This value is used by the
// SDK to translate regions like fips-us-east-1 or us-east-1-fips to an alternative
// name. You must not set this value directly in your application.
ResolvedRegion string
// DisableHTTPS informs the resolver to return an endpoint that does not use the
// HTTPS scheme.
DisableHTTPS bool
// UseDualStackEndpoint specifies the resolver must resolve a dual-stack endpoint.
UseDualStackEndpoint aws.DualStackEndpointState
// UseFIPSEndpoint specifies the resolver must resolve a FIPS endpoint.
UseFIPSEndpoint aws.FIPSEndpointState
}
func (o Options) GetResolvedRegion() string {
return o.ResolvedRegion
}
func (o Options) GetDisableHTTPS() bool {
return o.DisableHTTPS
}
func (o Options) GetUseDualStackEndpoint() aws.DualStackEndpointState {
return o.UseDualStackEndpoint
}
func (o Options) GetUseFIPSEndpoint() aws.FIPSEndpointState {
return o.UseFIPSEndpoint
}
func transformToSharedOptions(options Options) endpoints.Options {
return endpoints.Options{
Logger: options.Logger,
LogDeprecated: options.LogDeprecated,
ResolvedRegion: options.ResolvedRegion,
DisableHTTPS: options.DisableHTTPS,
UseDualStackEndpoint: options.UseDualStackEndpoint,
UseFIPSEndpoint: options.UseFIPSEndpoint,
}
}
// Resolver QuickSight endpoint resolver
type Resolver struct {
partitions endpoints.Partitions
}
// ResolveEndpoint resolves the service endpoint for the given region and options
func (r *Resolver) ResolveEndpoint(region string, options Options) (endpoint aws.Endpoint, err error) {
if len(region) == 0 {
return endpoint, &aws.MissingRegionError{}
}
opt := transformToSharedOptions(options)
return r.partitions.ResolveEndpoint(region, opt)
}
// New returns a new Resolver
func New() *Resolver {
return &Resolver{
partitions: defaultPartitions,
}
}
var partitionRegexp = struct {
Aws *regexp.Regexp
AwsCn *regexp.Regexp
AwsIso *regexp.Regexp
AwsIsoB *regexp.Regexp
AwsIsoE *regexp.Regexp
AwsIsoF *regexp.Regexp
AwsUsGov *regexp.Regexp
}{
Aws: regexp.MustCompile("^(us|eu|ap|sa|ca|me|af)\\-\\w+\\-\\d+$"),
AwsCn: regexp.MustCompile("^cn\\-\\w+\\-\\d+$"),
AwsIso: regexp.MustCompile("^us\\-iso\\-\\w+\\-\\d+$"),
AwsIsoB: regexp.MustCompile("^us\\-isob\\-\\w+\\-\\d+$"),
AwsIsoE: regexp.MustCompile("^eu\\-isoe\\-\\w+\\-\\d+$"),
AwsIsoF: regexp.MustCompile("^us\\-isof\\-\\w+\\-\\d+$"),
AwsUsGov: regexp.MustCompile("^us\\-gov\\-\\w+\\-\\d+$"),
}
var defaultPartitions = endpoints.Partitions{
{
ID: "aws",
Defaults: map[endpoints.DefaultKey]endpoints.Endpoint{
{
Variant: endpoints.DualStackVariant,
}: {
Hostname: "quicksight.{region}.api.aws",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
{
Variant: endpoints.FIPSVariant,
}: {
Hostname: "quicksight-fips.{region}.amazonaws.com",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
{
Variant: endpoints.FIPSVariant | endpoints.DualStackVariant,
}: {
Hostname: "quicksight-fips.{region}.api.aws",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
{
Variant: 0,
}: {
Hostname: "quicksight.{region}.amazonaws.com",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
},
RegionRegex: partitionRegexp.Aws,
IsRegionalized: true,
Endpoints: endpoints.Endpoints{
endpoints.EndpointKey{
Region: "ap-northeast-1",
}: endpoints.Endpoint{},
endpoints.EndpointKey{
Region: "ap-northeast-2",
}: endpoints.Endpoint{},
endpoints.EndpointKey{
Region: "ap-south-1",
}: endpoints.Endpoint{},
endpoints.EndpointKey{
Region: "ap-southeast-1",
}: endpoints.Endpoint{},
endpoints.EndpointKey{
Region: "ap-southeast-2",
}: endpoints.Endpoint{},
endpoints.EndpointKey{
Region: "ca-central-1",
}: endpoints.Endpoint{},
endpoints.EndpointKey{
Region: "eu-central-1",
}: endpoints.Endpoint{},
endpoints.EndpointKey{
Region: "eu-north-1",
}: endpoints.Endpoint{},
endpoints.EndpointKey{
Region: "eu-west-1",
}: endpoints.Endpoint{},
endpoints.EndpointKey{
Region: "eu-west-2",
}: endpoints.Endpoint{},
endpoints.EndpointKey{
Region: "eu-west-3",
}: endpoints.Endpoint{},
endpoints.EndpointKey{
Region: "sa-east-1",
}: endpoints.Endpoint{},
endpoints.EndpointKey{
Region: "us-east-1",
}: endpoints.Endpoint{},
endpoints.EndpointKey{
Region: "us-east-2",
}: endpoints.Endpoint{},
endpoints.EndpointKey{
Region: "us-west-2",
}: endpoints.Endpoint{},
},
},
{
ID: "aws-cn",
Defaults: map[endpoints.DefaultKey]endpoints.Endpoint{
{
Variant: endpoints.DualStackVariant,
}: {
Hostname: "quicksight.{region}.api.amazonwebservices.com.cn",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
{
Variant: endpoints.FIPSVariant,
}: {
Hostname: "quicksight-fips.{region}.amazonaws.com.cn",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
{
Variant: endpoints.FIPSVariant | endpoints.DualStackVariant,
}: {
Hostname: "quicksight-fips.{region}.api.amazonwebservices.com.cn",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
{
Variant: 0,
}: {
Hostname: "quicksight.{region}.amazonaws.com.cn",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
},
RegionRegex: partitionRegexp.AwsCn,
IsRegionalized: true,
},
{
ID: "aws-iso",
Defaults: map[endpoints.DefaultKey]endpoints.Endpoint{
{
Variant: endpoints.FIPSVariant,
}: {
Hostname: "quicksight-fips.{region}.c2s.ic.gov",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
{
Variant: 0,
}: {
Hostname: "quicksight.{region}.c2s.ic.gov",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
},
RegionRegex: partitionRegexp.AwsIso,
IsRegionalized: true,
},
{
ID: "aws-iso-b",
Defaults: map[endpoints.DefaultKey]endpoints.Endpoint{
{
Variant: endpoints.FIPSVariant,
}: {
Hostname: "quicksight-fips.{region}.sc2s.sgov.gov",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
{
Variant: 0,
}: {
Hostname: "quicksight.{region}.sc2s.sgov.gov",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
},
RegionRegex: partitionRegexp.AwsIsoB,
IsRegionalized: true,
},
{
ID: "aws-iso-e",
Defaults: map[endpoints.DefaultKey]endpoints.Endpoint{
{
Variant: endpoints.FIPSVariant,
}: {
Hostname: "quicksight-fips.{region}.cloud.adc-e.uk",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
{
Variant: 0,
}: {
Hostname: "quicksight.{region}.cloud.adc-e.uk",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
},
RegionRegex: partitionRegexp.AwsIsoE,
IsRegionalized: true,
},
{
ID: "aws-iso-f",
Defaults: map[endpoints.DefaultKey]endpoints.Endpoint{
{
Variant: endpoints.FIPSVariant,
}: {
Hostname: "quicksight-fips.{region}.csp.hci.ic.gov",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
{
Variant: 0,
}: {
Hostname: "quicksight.{region}.csp.hci.ic.gov",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
},
RegionRegex: partitionRegexp.AwsIsoF,
IsRegionalized: true,
},
{
ID: "aws-us-gov",
Defaults: map[endpoints.DefaultKey]endpoints.Endpoint{
{
Variant: endpoints.DualStackVariant,
}: {
Hostname: "quicksight.{region}.api.aws",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
{
Variant: endpoints.FIPSVariant,
}: {
Hostname: "quicksight-fips.{region}.amazonaws.com",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
{
Variant: endpoints.FIPSVariant | endpoints.DualStackVariant,
}: {
Hostname: "quicksight-fips.{region}.api.aws",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
{
Variant: 0,
}: {
Hostname: "quicksight.{region}.amazonaws.com",
Protocols: []string{"https"},
SignatureVersions: []string{"v4"},
},
},
RegionRegex: partitionRegexp.AwsUsGov,
IsRegionalized: true,
Endpoints: endpoints.Endpoints{
endpoints.EndpointKey{
Region: "api",
}: endpoints.Endpoint{},
endpoints.EndpointKey{
Region: "us-gov-west-1",
}: endpoints.Endpoint{},
},
},
}
| 352 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package endpoints
import (
"testing"
)
func TestRegexCompile(t *testing.T) {
_ = defaultPartitions
}
| 12 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package types
type AnalysisErrorType string
// Enum values for AnalysisErrorType
const (
AnalysisErrorTypeAccessDenied AnalysisErrorType = "ACCESS_DENIED"
AnalysisErrorTypeSourceNotFound AnalysisErrorType = "SOURCE_NOT_FOUND"
AnalysisErrorTypeDataSetNotFound AnalysisErrorType = "DATA_SET_NOT_FOUND"
AnalysisErrorTypeInternalFailure AnalysisErrorType = "INTERNAL_FAILURE"
AnalysisErrorTypeParameterValueIncompatible AnalysisErrorType = "PARAMETER_VALUE_INCOMPATIBLE"
AnalysisErrorTypeParameterTypeInvalid AnalysisErrorType = "PARAMETER_TYPE_INVALID"
AnalysisErrorTypeParameterNotFound AnalysisErrorType = "PARAMETER_NOT_FOUND"
AnalysisErrorTypeColumnTypeMismatch AnalysisErrorType = "COLUMN_TYPE_MISMATCH"
AnalysisErrorTypeColumnGeographicRoleMismatch AnalysisErrorType = "COLUMN_GEOGRAPHIC_ROLE_MISMATCH"
AnalysisErrorTypeColumnReplacementMissing AnalysisErrorType = "COLUMN_REPLACEMENT_MISSING"
)
// Values returns all known values for AnalysisErrorType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (AnalysisErrorType) Values() []AnalysisErrorType {
return []AnalysisErrorType{
"ACCESS_DENIED",
"SOURCE_NOT_FOUND",
"DATA_SET_NOT_FOUND",
"INTERNAL_FAILURE",
"PARAMETER_VALUE_INCOMPATIBLE",
"PARAMETER_TYPE_INVALID",
"PARAMETER_NOT_FOUND",
"COLUMN_TYPE_MISMATCH",
"COLUMN_GEOGRAPHIC_ROLE_MISMATCH",
"COLUMN_REPLACEMENT_MISSING",
}
}
type AnalysisFilterAttribute string
// Enum values for AnalysisFilterAttribute
const (
AnalysisFilterAttributeQuicksightUser AnalysisFilterAttribute = "QUICKSIGHT_USER"
AnalysisFilterAttributeQuicksightViewerOrOwner AnalysisFilterAttribute = "QUICKSIGHT_VIEWER_OR_OWNER"
AnalysisFilterAttributeDirectQuicksightViewerOrOwner AnalysisFilterAttribute = "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"
AnalysisFilterAttributeQuicksightOwner AnalysisFilterAttribute = "QUICKSIGHT_OWNER"
AnalysisFilterAttributeDirectQuicksightOwner AnalysisFilterAttribute = "DIRECT_QUICKSIGHT_OWNER"
AnalysisFilterAttributeDirectQuicksightSoleOwner AnalysisFilterAttribute = "DIRECT_QUICKSIGHT_SOLE_OWNER"
AnalysisFilterAttributeAnalysisName AnalysisFilterAttribute = "ANALYSIS_NAME"
)
// Values returns all known values for AnalysisFilterAttribute. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (AnalysisFilterAttribute) Values() []AnalysisFilterAttribute {
return []AnalysisFilterAttribute{
"QUICKSIGHT_USER",
"QUICKSIGHT_VIEWER_OR_OWNER",
"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER",
"QUICKSIGHT_OWNER",
"DIRECT_QUICKSIGHT_OWNER",
"DIRECT_QUICKSIGHT_SOLE_OWNER",
"ANALYSIS_NAME",
}
}
type AnchorOption string
// Enum values for AnchorOption
const (
AnchorOptionNow AnchorOption = "NOW"
)
// Values returns all known values for AnchorOption. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (AnchorOption) Values() []AnchorOption {
return []AnchorOption{
"NOW",
}
}
type ArcThickness string
// Enum values for ArcThickness
const (
ArcThicknessSmall ArcThickness = "SMALL"
ArcThicknessMedium ArcThickness = "MEDIUM"
ArcThicknessLarge ArcThickness = "LARGE"
ArcThicknessWhole ArcThickness = "WHOLE"
)
// Values returns all known values for ArcThickness. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (ArcThickness) Values() []ArcThickness {
return []ArcThickness{
"SMALL",
"MEDIUM",
"LARGE",
"WHOLE",
}
}
type ArcThicknessOptions string
// Enum values for ArcThicknessOptions
const (
ArcThicknessOptionsSmall ArcThicknessOptions = "SMALL"
ArcThicknessOptionsMedium ArcThicknessOptions = "MEDIUM"
ArcThicknessOptionsLarge ArcThicknessOptions = "LARGE"
)
// Values returns all known values for ArcThicknessOptions. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (ArcThicknessOptions) Values() []ArcThicknessOptions {
return []ArcThicknessOptions{
"SMALL",
"MEDIUM",
"LARGE",
}
}
type AssetBundleExportFormat string
// Enum values for AssetBundleExportFormat
const (
AssetBundleExportFormatCloudformationJson AssetBundleExportFormat = "CLOUDFORMATION_JSON"
AssetBundleExportFormatQuicksightJson AssetBundleExportFormat = "QUICKSIGHT_JSON"
)
// Values returns all known values for AssetBundleExportFormat. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (AssetBundleExportFormat) Values() []AssetBundleExportFormat {
return []AssetBundleExportFormat{
"CLOUDFORMATION_JSON",
"QUICKSIGHT_JSON",
}
}
type AssetBundleExportJobAnalysisPropertyToOverride string
// Enum values for AssetBundleExportJobAnalysisPropertyToOverride
const (
AssetBundleExportJobAnalysisPropertyToOverrideName AssetBundleExportJobAnalysisPropertyToOverride = "Name"
)
// Values returns all known values for
// AssetBundleExportJobAnalysisPropertyToOverride. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
func (AssetBundleExportJobAnalysisPropertyToOverride) Values() []AssetBundleExportJobAnalysisPropertyToOverride {
return []AssetBundleExportJobAnalysisPropertyToOverride{
"Name",
}
}
type AssetBundleExportJobDashboardPropertyToOverride string
// Enum values for AssetBundleExportJobDashboardPropertyToOverride
const (
AssetBundleExportJobDashboardPropertyToOverrideName AssetBundleExportJobDashboardPropertyToOverride = "Name"
)
// Values returns all known values for
// AssetBundleExportJobDashboardPropertyToOverride. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
func (AssetBundleExportJobDashboardPropertyToOverride) Values() []AssetBundleExportJobDashboardPropertyToOverride {
return []AssetBundleExportJobDashboardPropertyToOverride{
"Name",
}
}
type AssetBundleExportJobDataSetPropertyToOverride string
// Enum values for AssetBundleExportJobDataSetPropertyToOverride
const (
AssetBundleExportJobDataSetPropertyToOverrideName AssetBundleExportJobDataSetPropertyToOverride = "Name"
)
// Values returns all known values for
// AssetBundleExportJobDataSetPropertyToOverride. Note that this can be expanded in
// the future, and so it is only as up to date as the client. The ordering of this
// slice is not guaranteed to be stable across updates.
func (AssetBundleExportJobDataSetPropertyToOverride) Values() []AssetBundleExportJobDataSetPropertyToOverride {
return []AssetBundleExportJobDataSetPropertyToOverride{
"Name",
}
}
type AssetBundleExportJobDataSourcePropertyToOverride string
// Enum values for AssetBundleExportJobDataSourcePropertyToOverride
const (
AssetBundleExportJobDataSourcePropertyToOverrideName AssetBundleExportJobDataSourcePropertyToOverride = "Name"
AssetBundleExportJobDataSourcePropertyToOverrideDisableSsl AssetBundleExportJobDataSourcePropertyToOverride = "DisableSsl"
AssetBundleExportJobDataSourcePropertyToOverrideSecretArn AssetBundleExportJobDataSourcePropertyToOverride = "SecretArn"
AssetBundleExportJobDataSourcePropertyToOverrideUsername AssetBundleExportJobDataSourcePropertyToOverride = "Username"
AssetBundleExportJobDataSourcePropertyToOverridePassword AssetBundleExportJobDataSourcePropertyToOverride = "Password"
AssetBundleExportJobDataSourcePropertyToOverrideDomain AssetBundleExportJobDataSourcePropertyToOverride = "Domain"
AssetBundleExportJobDataSourcePropertyToOverrideWorkGroup AssetBundleExportJobDataSourcePropertyToOverride = "WorkGroup"
AssetBundleExportJobDataSourcePropertyToOverrideHost AssetBundleExportJobDataSourcePropertyToOverride = "Host"
AssetBundleExportJobDataSourcePropertyToOverridePort AssetBundleExportJobDataSourcePropertyToOverride = "Port"
AssetBundleExportJobDataSourcePropertyToOverrideDatabase AssetBundleExportJobDataSourcePropertyToOverride = "Database"
AssetBundleExportJobDataSourcePropertyToOverrideDataSetName AssetBundleExportJobDataSourcePropertyToOverride = "DataSetName"
AssetBundleExportJobDataSourcePropertyToOverrideCatalog AssetBundleExportJobDataSourcePropertyToOverride = "Catalog"
AssetBundleExportJobDataSourcePropertyToOverrideInstanceId AssetBundleExportJobDataSourcePropertyToOverride = "InstanceId"
AssetBundleExportJobDataSourcePropertyToOverrideClusterId AssetBundleExportJobDataSourcePropertyToOverride = "ClusterId"
AssetBundleExportJobDataSourcePropertyToOverrideManifestFileLocation AssetBundleExportJobDataSourcePropertyToOverride = "ManifestFileLocation"
AssetBundleExportJobDataSourcePropertyToOverrideWarehouse AssetBundleExportJobDataSourcePropertyToOverride = "Warehouse"
AssetBundleExportJobDataSourcePropertyToOverrideRoleArn AssetBundleExportJobDataSourcePropertyToOverride = "RoleArn"
)
// Values returns all known values for
// AssetBundleExportJobDataSourcePropertyToOverride. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
func (AssetBundleExportJobDataSourcePropertyToOverride) Values() []AssetBundleExportJobDataSourcePropertyToOverride {
return []AssetBundleExportJobDataSourcePropertyToOverride{
"Name",
"DisableSsl",
"SecretArn",
"Username",
"Password",
"Domain",
"WorkGroup",
"Host",
"Port",
"Database",
"DataSetName",
"Catalog",
"InstanceId",
"ClusterId",
"ManifestFileLocation",
"Warehouse",
"RoleArn",
}
}
type AssetBundleExportJobRefreshSchedulePropertyToOverride string
// Enum values for AssetBundleExportJobRefreshSchedulePropertyToOverride
const (
AssetBundleExportJobRefreshSchedulePropertyToOverrideStartAfterDateTime AssetBundleExportJobRefreshSchedulePropertyToOverride = "StartAfterDateTime"
)
// Values returns all known values for
// AssetBundleExportJobRefreshSchedulePropertyToOverride. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (AssetBundleExportJobRefreshSchedulePropertyToOverride) Values() []AssetBundleExportJobRefreshSchedulePropertyToOverride {
return []AssetBundleExportJobRefreshSchedulePropertyToOverride{
"StartAfterDateTime",
}
}
type AssetBundleExportJobStatus string
// Enum values for AssetBundleExportJobStatus
const (
AssetBundleExportJobStatusQueuedForImmediateExecution AssetBundleExportJobStatus = "QUEUED_FOR_IMMEDIATE_EXECUTION"
AssetBundleExportJobStatusInProgress AssetBundleExportJobStatus = "IN_PROGRESS"
AssetBundleExportJobStatusSuccessful AssetBundleExportJobStatus = "SUCCESSFUL"
AssetBundleExportJobStatusFailed AssetBundleExportJobStatus = "FAILED"
)
// Values returns all known values for AssetBundleExportJobStatus. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (AssetBundleExportJobStatus) Values() []AssetBundleExportJobStatus {
return []AssetBundleExportJobStatus{
"QUEUED_FOR_IMMEDIATE_EXECUTION",
"IN_PROGRESS",
"SUCCESSFUL",
"FAILED",
}
}
type AssetBundleExportJobThemePropertyToOverride string
// Enum values for AssetBundleExportJobThemePropertyToOverride
const (
AssetBundleExportJobThemePropertyToOverrideName AssetBundleExportJobThemePropertyToOverride = "Name"
)
// Values returns all known values for
// AssetBundleExportJobThemePropertyToOverride. Note that this can be expanded in
// the future, and so it is only as up to date as the client. The ordering of this
// slice is not guaranteed to be stable across updates.
func (AssetBundleExportJobThemePropertyToOverride) Values() []AssetBundleExportJobThemePropertyToOverride {
return []AssetBundleExportJobThemePropertyToOverride{
"Name",
}
}
type AssetBundleExportJobVPCConnectionPropertyToOverride string
// Enum values for AssetBundleExportJobVPCConnectionPropertyToOverride
const (
AssetBundleExportJobVPCConnectionPropertyToOverrideName AssetBundleExportJobVPCConnectionPropertyToOverride = "Name"
AssetBundleExportJobVPCConnectionPropertyToOverrideDnsResolvers AssetBundleExportJobVPCConnectionPropertyToOverride = "DnsResolvers"
AssetBundleExportJobVPCConnectionPropertyToOverrideRoleArn AssetBundleExportJobVPCConnectionPropertyToOverride = "RoleArn"
)
// Values returns all known values for
// AssetBundleExportJobVPCConnectionPropertyToOverride. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (AssetBundleExportJobVPCConnectionPropertyToOverride) Values() []AssetBundleExportJobVPCConnectionPropertyToOverride {
return []AssetBundleExportJobVPCConnectionPropertyToOverride{
"Name",
"DnsResolvers",
"RoleArn",
}
}
type AssetBundleImportFailureAction string
// Enum values for AssetBundleImportFailureAction
const (
AssetBundleImportFailureActionDoNothing AssetBundleImportFailureAction = "DO_NOTHING"
AssetBundleImportFailureActionRollback AssetBundleImportFailureAction = "ROLLBACK"
)
// Values returns all known values for AssetBundleImportFailureAction. Note that
// this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (AssetBundleImportFailureAction) Values() []AssetBundleImportFailureAction {
return []AssetBundleImportFailureAction{
"DO_NOTHING",
"ROLLBACK",
}
}
type AssetBundleImportJobStatus string
// Enum values for AssetBundleImportJobStatus
const (
AssetBundleImportJobStatusQueuedForImmediateExecution AssetBundleImportJobStatus = "QUEUED_FOR_IMMEDIATE_EXECUTION"
AssetBundleImportJobStatusInProgress AssetBundleImportJobStatus = "IN_PROGRESS"
AssetBundleImportJobStatusSuccessful AssetBundleImportJobStatus = "SUCCESSFUL"
AssetBundleImportJobStatusFailed AssetBundleImportJobStatus = "FAILED"
AssetBundleImportJobStatusFailedRollbackInProgress AssetBundleImportJobStatus = "FAILED_ROLLBACK_IN_PROGRESS"
AssetBundleImportJobStatusFailedRollbackCompleted AssetBundleImportJobStatus = "FAILED_ROLLBACK_COMPLETED"
AssetBundleImportJobStatusFailedRollbackError AssetBundleImportJobStatus = "FAILED_ROLLBACK_ERROR"
)
// Values returns all known values for AssetBundleImportJobStatus. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (AssetBundleImportJobStatus) Values() []AssetBundleImportJobStatus {
return []AssetBundleImportJobStatus{
"QUEUED_FOR_IMMEDIATE_EXECUTION",
"IN_PROGRESS",
"SUCCESSFUL",
"FAILED",
"FAILED_ROLLBACK_IN_PROGRESS",
"FAILED_ROLLBACK_COMPLETED",
"FAILED_ROLLBACK_ERROR",
}
}
type AssignmentStatus string
// Enum values for AssignmentStatus
const (
AssignmentStatusEnabled AssignmentStatus = "ENABLED"
AssignmentStatusDraft AssignmentStatus = "DRAFT"
AssignmentStatusDisabled AssignmentStatus = "DISABLED"
)
// Values returns all known values for AssignmentStatus. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (AssignmentStatus) Values() []AssignmentStatus {
return []AssignmentStatus{
"ENABLED",
"DRAFT",
"DISABLED",
}
}
type AuthenticationMethodOption string
// Enum values for AuthenticationMethodOption
const (
AuthenticationMethodOptionIamAndQuicksight AuthenticationMethodOption = "IAM_AND_QUICKSIGHT"
AuthenticationMethodOptionIamOnly AuthenticationMethodOption = "IAM_ONLY"
AuthenticationMethodOptionActiveDirectory AuthenticationMethodOption = "ACTIVE_DIRECTORY"
)
// Values returns all known values for AuthenticationMethodOption. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (AuthenticationMethodOption) Values() []AuthenticationMethodOption {
return []AuthenticationMethodOption{
"IAM_AND_QUICKSIGHT",
"IAM_ONLY",
"ACTIVE_DIRECTORY",
}
}
type AuthorSpecifiedAggregation string
// Enum values for AuthorSpecifiedAggregation
const (
AuthorSpecifiedAggregationCount AuthorSpecifiedAggregation = "COUNT"
AuthorSpecifiedAggregationDistinctCount AuthorSpecifiedAggregation = "DISTINCT_COUNT"
AuthorSpecifiedAggregationMin AuthorSpecifiedAggregation = "MIN"
AuthorSpecifiedAggregationMax AuthorSpecifiedAggregation = "MAX"
AuthorSpecifiedAggregationMedian AuthorSpecifiedAggregation = "MEDIAN"
AuthorSpecifiedAggregationSum AuthorSpecifiedAggregation = "SUM"
AuthorSpecifiedAggregationAverage AuthorSpecifiedAggregation = "AVERAGE"
AuthorSpecifiedAggregationStdev AuthorSpecifiedAggregation = "STDEV"
AuthorSpecifiedAggregationStdevp AuthorSpecifiedAggregation = "STDEVP"
AuthorSpecifiedAggregationVar AuthorSpecifiedAggregation = "VAR"
AuthorSpecifiedAggregationVarp AuthorSpecifiedAggregation = "VARP"
AuthorSpecifiedAggregationPercentile AuthorSpecifiedAggregation = "PERCENTILE"
)
// Values returns all known values for AuthorSpecifiedAggregation. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (AuthorSpecifiedAggregation) Values() []AuthorSpecifiedAggregation {
return []AuthorSpecifiedAggregation{
"COUNT",
"DISTINCT_COUNT",
"MIN",
"MAX",
"MEDIAN",
"SUM",
"AVERAGE",
"STDEV",
"STDEVP",
"VAR",
"VARP",
"PERCENTILE",
}
}
type AxisBinding string
// Enum values for AxisBinding
const (
AxisBindingPrimaryYaxis AxisBinding = "PRIMARY_YAXIS"
AxisBindingSecondaryYaxis AxisBinding = "SECONDARY_YAXIS"
)
// Values returns all known values for AxisBinding. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
func (AxisBinding) Values() []AxisBinding {
return []AxisBinding{
"PRIMARY_YAXIS",
"SECONDARY_YAXIS",
}
}
type BarChartOrientation string
// Enum values for BarChartOrientation
const (
BarChartOrientationHorizontal BarChartOrientation = "HORIZONTAL"
BarChartOrientationVertical BarChartOrientation = "VERTICAL"
)
// Values returns all known values for BarChartOrientation. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (BarChartOrientation) Values() []BarChartOrientation {
return []BarChartOrientation{
"HORIZONTAL",
"VERTICAL",
}
}
type BarsArrangement string
// Enum values for BarsArrangement
const (
BarsArrangementClustered BarsArrangement = "CLUSTERED"
BarsArrangementStacked BarsArrangement = "STACKED"
BarsArrangementStackedPercent BarsArrangement = "STACKED_PERCENT"
)
// Values returns all known values for BarsArrangement. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (BarsArrangement) Values() []BarsArrangement {
return []BarsArrangement{
"CLUSTERED",
"STACKED",
"STACKED_PERCENT",
}
}
type BaseMapStyleType string
// Enum values for BaseMapStyleType
const (
BaseMapStyleTypeLightGray BaseMapStyleType = "LIGHT_GRAY"
BaseMapStyleTypeDarkGray BaseMapStyleType = "DARK_GRAY"
BaseMapStyleTypeStreet BaseMapStyleType = "STREET"
BaseMapStyleTypeImagery BaseMapStyleType = "IMAGERY"
)
// Values returns all known values for BaseMapStyleType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (BaseMapStyleType) Values() []BaseMapStyleType {
return []BaseMapStyleType{
"LIGHT_GRAY",
"DARK_GRAY",
"STREET",
"IMAGERY",
}
}
type BoxPlotFillStyle string
// Enum values for BoxPlotFillStyle
const (
BoxPlotFillStyleSolid BoxPlotFillStyle = "SOLID"
BoxPlotFillStyleTransparent BoxPlotFillStyle = "TRANSPARENT"
)
// Values returns all known values for BoxPlotFillStyle. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (BoxPlotFillStyle) Values() []BoxPlotFillStyle {
return []BoxPlotFillStyle{
"SOLID",
"TRANSPARENT",
}
}
type CategoricalAggregationFunction string
// Enum values for CategoricalAggregationFunction
const (
CategoricalAggregationFunctionCount CategoricalAggregationFunction = "COUNT"
CategoricalAggregationFunctionDistinctCount CategoricalAggregationFunction = "DISTINCT_COUNT"
)
// Values returns all known values for CategoricalAggregationFunction. Note that
// this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (CategoricalAggregationFunction) Values() []CategoricalAggregationFunction {
return []CategoricalAggregationFunction{
"COUNT",
"DISTINCT_COUNT",
}
}
type CategoryFilterFunction string
// Enum values for CategoryFilterFunction
const (
CategoryFilterFunctionExact CategoryFilterFunction = "EXACT"
CategoryFilterFunctionContains CategoryFilterFunction = "CONTAINS"
)
// Values returns all known values for CategoryFilterFunction. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (CategoryFilterFunction) Values() []CategoryFilterFunction {
return []CategoryFilterFunction{
"EXACT",
"CONTAINS",
}
}
type CategoryFilterMatchOperator string
// Enum values for CategoryFilterMatchOperator
const (
CategoryFilterMatchOperatorEquals CategoryFilterMatchOperator = "EQUALS"
CategoryFilterMatchOperatorDoesNotEqual CategoryFilterMatchOperator = "DOES_NOT_EQUAL"
CategoryFilterMatchOperatorContains CategoryFilterMatchOperator = "CONTAINS"
CategoryFilterMatchOperatorDoesNotContain CategoryFilterMatchOperator = "DOES_NOT_CONTAIN"
CategoryFilterMatchOperatorStartsWith CategoryFilterMatchOperator = "STARTS_WITH"
CategoryFilterMatchOperatorEndsWith CategoryFilterMatchOperator = "ENDS_WITH"
)
// Values returns all known values for CategoryFilterMatchOperator. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (CategoryFilterMatchOperator) Values() []CategoryFilterMatchOperator {
return []CategoryFilterMatchOperator{
"EQUALS",
"DOES_NOT_EQUAL",
"CONTAINS",
"DOES_NOT_CONTAIN",
"STARTS_WITH",
"ENDS_WITH",
}
}
type CategoryFilterSelectAllOptions string
// Enum values for CategoryFilterSelectAllOptions
const (
CategoryFilterSelectAllOptionsFilterAllValues CategoryFilterSelectAllOptions = "FILTER_ALL_VALUES"
)
// Values returns all known values for CategoryFilterSelectAllOptions. Note that
// this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (CategoryFilterSelectAllOptions) Values() []CategoryFilterSelectAllOptions {
return []CategoryFilterSelectAllOptions{
"FILTER_ALL_VALUES",
}
}
type CategoryFilterType string
// Enum values for CategoryFilterType
const (
CategoryFilterTypeCustomFilter CategoryFilterType = "CUSTOM_FILTER"
CategoryFilterTypeCustomFilterList CategoryFilterType = "CUSTOM_FILTER_LIST"
CategoryFilterTypeFilterList CategoryFilterType = "FILTER_LIST"
)
// Values returns all known values for CategoryFilterType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (CategoryFilterType) Values() []CategoryFilterType {
return []CategoryFilterType{
"CUSTOM_FILTER",
"CUSTOM_FILTER_LIST",
"FILTER_LIST",
}
}
type ColorFillType string
// Enum values for ColorFillType
const (
ColorFillTypeDiscrete ColorFillType = "DISCRETE"
ColorFillTypeGradient ColorFillType = "GRADIENT"
)
// Values returns all known values for ColorFillType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (ColorFillType) Values() []ColorFillType {
return []ColorFillType{
"DISCRETE",
"GRADIENT",
}
}
type ColumnDataRole string
// Enum values for ColumnDataRole
const (
ColumnDataRoleDimension ColumnDataRole = "DIMENSION"
ColumnDataRoleMeasure ColumnDataRole = "MEASURE"
)
// Values returns all known values for ColumnDataRole. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (ColumnDataRole) Values() []ColumnDataRole {
return []ColumnDataRole{
"DIMENSION",
"MEASURE",
}
}
type ColumnDataType string
// Enum values for ColumnDataType
const (
ColumnDataTypeString ColumnDataType = "STRING"
ColumnDataTypeInteger ColumnDataType = "INTEGER"
ColumnDataTypeDecimal ColumnDataType = "DECIMAL"
ColumnDataTypeDatetime ColumnDataType = "DATETIME"
)
// Values returns all known values for ColumnDataType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (ColumnDataType) Values() []ColumnDataType {
return []ColumnDataType{
"STRING",
"INTEGER",
"DECIMAL",
"DATETIME",
}
}
type ColumnOrderingType string
// Enum values for ColumnOrderingType
const (
ColumnOrderingTypeGreaterIsBetter ColumnOrderingType = "GREATER_IS_BETTER"
ColumnOrderingTypeLesserIsBetter ColumnOrderingType = "LESSER_IS_BETTER"
ColumnOrderingTypeSpecified ColumnOrderingType = "SPECIFIED"
)
// Values returns all known values for ColumnOrderingType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (ColumnOrderingType) Values() []ColumnOrderingType {
return []ColumnOrderingType{
"GREATER_IS_BETTER",
"LESSER_IS_BETTER",
"SPECIFIED",
}
}
type ColumnRole string
// Enum values for ColumnRole
const (
ColumnRoleDimension ColumnRole = "DIMENSION"
ColumnRoleMeasure ColumnRole = "MEASURE"
)
// Values returns all known values for ColumnRole. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
func (ColumnRole) Values() []ColumnRole {
return []ColumnRole{
"DIMENSION",
"MEASURE",
}
}
type ColumnTagName string
// Enum values for ColumnTagName
const (
ColumnTagNameColumnGeographicRole ColumnTagName = "COLUMN_GEOGRAPHIC_ROLE"
ColumnTagNameColumnDescription ColumnTagName = "COLUMN_DESCRIPTION"
)
// Values returns all known values for ColumnTagName. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (ColumnTagName) Values() []ColumnTagName {
return []ColumnTagName{
"COLUMN_GEOGRAPHIC_ROLE",
"COLUMN_DESCRIPTION",
}
}
type ComparisonMethod string
// Enum values for ComparisonMethod
const (
ComparisonMethodDifference ComparisonMethod = "DIFFERENCE"
ComparisonMethodPercentDifference ComparisonMethod = "PERCENT_DIFFERENCE"
ComparisonMethodPercent ComparisonMethod = "PERCENT"
)
// Values returns all known values for ComparisonMethod. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (ComparisonMethod) Values() []ComparisonMethod {
return []ComparisonMethod{
"DIFFERENCE",
"PERCENT_DIFFERENCE",
"PERCENT",
}
}
type ConditionalFormattingIconDisplayOption string
// Enum values for ConditionalFormattingIconDisplayOption
const (
ConditionalFormattingIconDisplayOptionIconOnly ConditionalFormattingIconDisplayOption = "ICON_ONLY"
)
// Values returns all known values for ConditionalFormattingIconDisplayOption.
// Note that this can be expanded in the future, and so it is only as up to date as
// the client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (ConditionalFormattingIconDisplayOption) Values() []ConditionalFormattingIconDisplayOption {
return []ConditionalFormattingIconDisplayOption{
"ICON_ONLY",
}
}
type ConditionalFormattingIconSetType string
// Enum values for ConditionalFormattingIconSetType
const (
ConditionalFormattingIconSetTypePlusMinus ConditionalFormattingIconSetType = "PLUS_MINUS"
ConditionalFormattingIconSetTypeCheckX ConditionalFormattingIconSetType = "CHECK_X"
ConditionalFormattingIconSetTypeThreeColorArrow ConditionalFormattingIconSetType = "THREE_COLOR_ARROW"
ConditionalFormattingIconSetTypeThreeGrayArrow ConditionalFormattingIconSetType = "THREE_GRAY_ARROW"
ConditionalFormattingIconSetTypeCaretUpMinusDown ConditionalFormattingIconSetType = "CARET_UP_MINUS_DOWN"
ConditionalFormattingIconSetTypeThreeShape ConditionalFormattingIconSetType = "THREE_SHAPE"
ConditionalFormattingIconSetTypeThreeCircle ConditionalFormattingIconSetType = "THREE_CIRCLE"
ConditionalFormattingIconSetTypeFlags ConditionalFormattingIconSetType = "FLAGS"
ConditionalFormattingIconSetTypeBars ConditionalFormattingIconSetType = "BARS"
ConditionalFormattingIconSetTypeFourColorArrow ConditionalFormattingIconSetType = "FOUR_COLOR_ARROW"
ConditionalFormattingIconSetTypeFourGrayArrow ConditionalFormattingIconSetType = "FOUR_GRAY_ARROW"
)
// Values returns all known values for ConditionalFormattingIconSetType. Note that
// this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (ConditionalFormattingIconSetType) Values() []ConditionalFormattingIconSetType {
return []ConditionalFormattingIconSetType{
"PLUS_MINUS",
"CHECK_X",
"THREE_COLOR_ARROW",
"THREE_GRAY_ARROW",
"CARET_UP_MINUS_DOWN",
"THREE_SHAPE",
"THREE_CIRCLE",
"FLAGS",
"BARS",
"FOUR_COLOR_ARROW",
"FOUR_GRAY_ARROW",
}
}
type ConstantType string
// Enum values for ConstantType
const (
ConstantTypeSingular ConstantType = "SINGULAR"
ConstantTypeRange ConstantType = "RANGE"
ConstantTypeCollective ConstantType = "COLLECTIVE"
)
// Values returns all known values for ConstantType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (ConstantType) Values() []ConstantType {
return []ConstantType{
"SINGULAR",
"RANGE",
"COLLECTIVE",
}
}
type CrossDatasetTypes string
// Enum values for CrossDatasetTypes
const (
CrossDatasetTypesAllDatasets CrossDatasetTypes = "ALL_DATASETS"
CrossDatasetTypesSingleDataset CrossDatasetTypes = "SINGLE_DATASET"
)
// Values returns all known values for CrossDatasetTypes. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (CrossDatasetTypes) Values() []CrossDatasetTypes {
return []CrossDatasetTypes{
"ALL_DATASETS",
"SINGLE_DATASET",
}
}
type CustomContentImageScalingConfiguration string
// Enum values for CustomContentImageScalingConfiguration
const (
CustomContentImageScalingConfigurationFitToHeight CustomContentImageScalingConfiguration = "FIT_TO_HEIGHT"
CustomContentImageScalingConfigurationFitToWidth CustomContentImageScalingConfiguration = "FIT_TO_WIDTH"
CustomContentImageScalingConfigurationDoNotScale CustomContentImageScalingConfiguration = "DO_NOT_SCALE"
CustomContentImageScalingConfigurationScaleToVisual CustomContentImageScalingConfiguration = "SCALE_TO_VISUAL"
)
// Values returns all known values for CustomContentImageScalingConfiguration.
// Note that this can be expanded in the future, and so it is only as up to date as
// the client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (CustomContentImageScalingConfiguration) Values() []CustomContentImageScalingConfiguration {
return []CustomContentImageScalingConfiguration{
"FIT_TO_HEIGHT",
"FIT_TO_WIDTH",
"DO_NOT_SCALE",
"SCALE_TO_VISUAL",
}
}
type CustomContentType string
// Enum values for CustomContentType
const (
CustomContentTypeImage CustomContentType = "IMAGE"
CustomContentTypeOtherEmbeddedContent CustomContentType = "OTHER_EMBEDDED_CONTENT"
)
// Values returns all known values for CustomContentType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (CustomContentType) Values() []CustomContentType {
return []CustomContentType{
"IMAGE",
"OTHER_EMBEDDED_CONTENT",
}
}
type DashboardBehavior string
// Enum values for DashboardBehavior
const (
DashboardBehaviorEnabled DashboardBehavior = "ENABLED"
DashboardBehaviorDisabled DashboardBehavior = "DISABLED"
)
// Values returns all known values for DashboardBehavior. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (DashboardBehavior) Values() []DashboardBehavior {
return []DashboardBehavior{
"ENABLED",
"DISABLED",
}
}
type DashboardErrorType string
// Enum values for DashboardErrorType
const (
DashboardErrorTypeAccessDenied DashboardErrorType = "ACCESS_DENIED"
DashboardErrorTypeSourceNotFound DashboardErrorType = "SOURCE_NOT_FOUND"
DashboardErrorTypeDataSetNotFound DashboardErrorType = "DATA_SET_NOT_FOUND"
DashboardErrorTypeInternalFailure DashboardErrorType = "INTERNAL_FAILURE"
DashboardErrorTypeParameterValueIncompatible DashboardErrorType = "PARAMETER_VALUE_INCOMPATIBLE"
DashboardErrorTypeParameterTypeInvalid DashboardErrorType = "PARAMETER_TYPE_INVALID"
DashboardErrorTypeParameterNotFound DashboardErrorType = "PARAMETER_NOT_FOUND"
DashboardErrorTypeColumnTypeMismatch DashboardErrorType = "COLUMN_TYPE_MISMATCH"
DashboardErrorTypeColumnGeographicRoleMismatch DashboardErrorType = "COLUMN_GEOGRAPHIC_ROLE_MISMATCH"
DashboardErrorTypeColumnReplacementMissing DashboardErrorType = "COLUMN_REPLACEMENT_MISSING"
)
// Values returns all known values for DashboardErrorType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (DashboardErrorType) Values() []DashboardErrorType {
return []DashboardErrorType{
"ACCESS_DENIED",
"SOURCE_NOT_FOUND",
"DATA_SET_NOT_FOUND",
"INTERNAL_FAILURE",
"PARAMETER_VALUE_INCOMPATIBLE",
"PARAMETER_TYPE_INVALID",
"PARAMETER_NOT_FOUND",
"COLUMN_TYPE_MISMATCH",
"COLUMN_GEOGRAPHIC_ROLE_MISMATCH",
"COLUMN_REPLACEMENT_MISSING",
}
}
type DashboardFilterAttribute string
// Enum values for DashboardFilterAttribute
const (
DashboardFilterAttributeQuicksightUser DashboardFilterAttribute = "QUICKSIGHT_USER"
DashboardFilterAttributeQuicksightViewerOrOwner DashboardFilterAttribute = "QUICKSIGHT_VIEWER_OR_OWNER"
DashboardFilterAttributeDirectQuicksightViewerOrOwner DashboardFilterAttribute = "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"
DashboardFilterAttributeQuicksightOwner DashboardFilterAttribute = "QUICKSIGHT_OWNER"
DashboardFilterAttributeDirectQuicksightOwner DashboardFilterAttribute = "DIRECT_QUICKSIGHT_OWNER"
DashboardFilterAttributeDirectQuicksightSoleOwner DashboardFilterAttribute = "DIRECT_QUICKSIGHT_SOLE_OWNER"
DashboardFilterAttributeDashboardName DashboardFilterAttribute = "DASHBOARD_NAME"
)
// Values returns all known values for DashboardFilterAttribute. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (DashboardFilterAttribute) Values() []DashboardFilterAttribute {
return []DashboardFilterAttribute{
"QUICKSIGHT_USER",
"QUICKSIGHT_VIEWER_OR_OWNER",
"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER",
"QUICKSIGHT_OWNER",
"DIRECT_QUICKSIGHT_OWNER",
"DIRECT_QUICKSIGHT_SOLE_OWNER",
"DASHBOARD_NAME",
}
}
type DashboardUIState string
// Enum values for DashboardUIState
const (
DashboardUIStateExpanded DashboardUIState = "EXPANDED"
DashboardUIStateCollapsed DashboardUIState = "COLLAPSED"
)
// Values returns all known values for DashboardUIState. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (DashboardUIState) Values() []DashboardUIState {
return []DashboardUIState{
"EXPANDED",
"COLLAPSED",
}
}
type DataLabelContent string
// Enum values for DataLabelContent
const (
DataLabelContentValue DataLabelContent = "VALUE"
DataLabelContentPercent DataLabelContent = "PERCENT"
DataLabelContentValueAndPercent DataLabelContent = "VALUE_AND_PERCENT"
)
// Values returns all known values for DataLabelContent. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (DataLabelContent) Values() []DataLabelContent {
return []DataLabelContent{
"VALUE",
"PERCENT",
"VALUE_AND_PERCENT",
}
}
type DataLabelOverlap string
// Enum values for DataLabelOverlap
const (
DataLabelOverlapDisableOverlap DataLabelOverlap = "DISABLE_OVERLAP"
DataLabelOverlapEnableOverlap DataLabelOverlap = "ENABLE_OVERLAP"
)
// Values returns all known values for DataLabelOverlap. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (DataLabelOverlap) Values() []DataLabelOverlap {
return []DataLabelOverlap{
"DISABLE_OVERLAP",
"ENABLE_OVERLAP",
}
}
type DataLabelPosition string
// Enum values for DataLabelPosition
const (
DataLabelPositionInside DataLabelPosition = "INSIDE"
DataLabelPositionOutside DataLabelPosition = "OUTSIDE"
DataLabelPositionLeft DataLabelPosition = "LEFT"
DataLabelPositionTop DataLabelPosition = "TOP"
DataLabelPositionBottom DataLabelPosition = "BOTTOM"
DataLabelPositionRight DataLabelPosition = "RIGHT"
)
// Values returns all known values for DataLabelPosition. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (DataLabelPosition) Values() []DataLabelPosition {
return []DataLabelPosition{
"INSIDE",
"OUTSIDE",
"LEFT",
"TOP",
"BOTTOM",
"RIGHT",
}
}
type DataSetFilterAttribute string
// Enum values for DataSetFilterAttribute
const (
DataSetFilterAttributeQuicksightViewerOrOwner DataSetFilterAttribute = "QUICKSIGHT_VIEWER_OR_OWNER"
DataSetFilterAttributeQuicksightOwner DataSetFilterAttribute = "QUICKSIGHT_OWNER"
DataSetFilterAttributeDirectQuicksightViewerOrOwner DataSetFilterAttribute = "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"
DataSetFilterAttributeDirectQuicksightOwner DataSetFilterAttribute = "DIRECT_QUICKSIGHT_OWNER"
DataSetFilterAttributeDirectQuicksightSoleOwner DataSetFilterAttribute = "DIRECT_QUICKSIGHT_SOLE_OWNER"
DataSetFilterAttributeDatasetName DataSetFilterAttribute = "DATASET_NAME"
)
// Values returns all known values for DataSetFilterAttribute. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (DataSetFilterAttribute) Values() []DataSetFilterAttribute {
return []DataSetFilterAttribute{
"QUICKSIGHT_VIEWER_OR_OWNER",
"QUICKSIGHT_OWNER",
"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER",
"DIRECT_QUICKSIGHT_OWNER",
"DIRECT_QUICKSIGHT_SOLE_OWNER",
"DATASET_NAME",
}
}
type DataSetImportMode string
// Enum values for DataSetImportMode
const (
DataSetImportModeSpice DataSetImportMode = "SPICE"
DataSetImportModeDirectQuery DataSetImportMode = "DIRECT_QUERY"
)
// Values returns all known values for DataSetImportMode. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (DataSetImportMode) Values() []DataSetImportMode {
return []DataSetImportMode{
"SPICE",
"DIRECT_QUERY",
}
}
type DatasetParameterValueType string
// Enum values for DatasetParameterValueType
const (
DatasetParameterValueTypeMultiValued DatasetParameterValueType = "MULTI_VALUED"
DatasetParameterValueTypeSingleValued DatasetParameterValueType = "SINGLE_VALUED"
)
// Values returns all known values for DatasetParameterValueType. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (DatasetParameterValueType) Values() []DatasetParameterValueType {
return []DatasetParameterValueType{
"MULTI_VALUED",
"SINGLE_VALUED",
}
}
type DataSourceErrorInfoType string
// Enum values for DataSourceErrorInfoType
const (
DataSourceErrorInfoTypeAccessDenied DataSourceErrorInfoType = "ACCESS_DENIED"
DataSourceErrorInfoTypeCopySourceNotFound DataSourceErrorInfoType = "COPY_SOURCE_NOT_FOUND"
DataSourceErrorInfoTypeTimeout DataSourceErrorInfoType = "TIMEOUT"
DataSourceErrorInfoTypeEngineVersionNotSupported DataSourceErrorInfoType = "ENGINE_VERSION_NOT_SUPPORTED"
DataSourceErrorInfoTypeUnknownHost DataSourceErrorInfoType = "UNKNOWN_HOST"
DataSourceErrorInfoTypeGenericSqlFailure DataSourceErrorInfoType = "GENERIC_SQL_FAILURE"
DataSourceErrorInfoTypeConflict DataSourceErrorInfoType = "CONFLICT"
DataSourceErrorInfoTypeUnknown DataSourceErrorInfoType = "UNKNOWN"
)
// Values returns all known values for DataSourceErrorInfoType. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (DataSourceErrorInfoType) Values() []DataSourceErrorInfoType {
return []DataSourceErrorInfoType{
"ACCESS_DENIED",
"COPY_SOURCE_NOT_FOUND",
"TIMEOUT",
"ENGINE_VERSION_NOT_SUPPORTED",
"UNKNOWN_HOST",
"GENERIC_SQL_FAILURE",
"CONFLICT",
"UNKNOWN",
}
}
type DataSourceFilterAttribute string
// Enum values for DataSourceFilterAttribute
const (
DataSourceFilterAttributeDirectQuicksightViewerOrOwner DataSourceFilterAttribute = "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"
DataSourceFilterAttributeDirectQuicksightOwner DataSourceFilterAttribute = "DIRECT_QUICKSIGHT_OWNER"
DataSourceFilterAttributeDirectQuicksightSoleOwner DataSourceFilterAttribute = "DIRECT_QUICKSIGHT_SOLE_OWNER"
DataSourceFilterAttributeDatasourceName DataSourceFilterAttribute = "DATASOURCE_NAME"
)
// Values returns all known values for DataSourceFilterAttribute. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (DataSourceFilterAttribute) Values() []DataSourceFilterAttribute {
return []DataSourceFilterAttribute{
"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER",
"DIRECT_QUICKSIGHT_OWNER",
"DIRECT_QUICKSIGHT_SOLE_OWNER",
"DATASOURCE_NAME",
}
}
type DataSourceType string
// Enum values for DataSourceType
const (
DataSourceTypeAdobeAnalytics DataSourceType = "ADOBE_ANALYTICS"
DataSourceTypeAmazonElasticsearch DataSourceType = "AMAZON_ELASTICSEARCH"
DataSourceTypeAthena DataSourceType = "ATHENA"
DataSourceTypeAurora DataSourceType = "AURORA"
DataSourceTypeAuroraPostgresql DataSourceType = "AURORA_POSTGRESQL"
DataSourceTypeAwsIotAnalytics DataSourceType = "AWS_IOT_ANALYTICS"
DataSourceTypeGithub DataSourceType = "GITHUB"
DataSourceTypeJira DataSourceType = "JIRA"
DataSourceTypeMariadb DataSourceType = "MARIADB"
DataSourceTypeMysql DataSourceType = "MYSQL"
DataSourceTypeOracle DataSourceType = "ORACLE"
DataSourceTypePostgresql DataSourceType = "POSTGRESQL"
DataSourceTypePresto DataSourceType = "PRESTO"
DataSourceTypeRedshift DataSourceType = "REDSHIFT"
DataSourceTypeS3 DataSourceType = "S3"
DataSourceTypeSalesforce DataSourceType = "SALESFORCE"
DataSourceTypeServicenow DataSourceType = "SERVICENOW"
DataSourceTypeSnowflake DataSourceType = "SNOWFLAKE"
DataSourceTypeSpark DataSourceType = "SPARK"
DataSourceTypeSqlserver DataSourceType = "SQLSERVER"
DataSourceTypeTeradata DataSourceType = "TERADATA"
DataSourceTypeTwitter DataSourceType = "TWITTER"
DataSourceTypeTimestream DataSourceType = "TIMESTREAM"
DataSourceTypeAmazonOpensearch DataSourceType = "AMAZON_OPENSEARCH"
DataSourceTypeExasol DataSourceType = "EXASOL"
DataSourceTypeDatabricks DataSourceType = "DATABRICKS"
)
// Values returns all known values for DataSourceType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (DataSourceType) Values() []DataSourceType {
return []DataSourceType{
"ADOBE_ANALYTICS",
"AMAZON_ELASTICSEARCH",
"ATHENA",
"AURORA",
"AURORA_POSTGRESQL",
"AWS_IOT_ANALYTICS",
"GITHUB",
"JIRA",
"MARIADB",
"MYSQL",
"ORACLE",
"POSTGRESQL",
"PRESTO",
"REDSHIFT",
"S3",
"SALESFORCE",
"SERVICENOW",
"SNOWFLAKE",
"SPARK",
"SQLSERVER",
"TERADATA",
"TWITTER",
"TIMESTREAM",
"AMAZON_OPENSEARCH",
"EXASOL",
"DATABRICKS",
}
}
type DateAggregationFunction string
// Enum values for DateAggregationFunction
const (
DateAggregationFunctionCount DateAggregationFunction = "COUNT"
DateAggregationFunctionDistinctCount DateAggregationFunction = "DISTINCT_COUNT"
DateAggregationFunctionMin DateAggregationFunction = "MIN"
DateAggregationFunctionMax DateAggregationFunction = "MAX"
)
// Values returns all known values for DateAggregationFunction. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (DateAggregationFunction) Values() []DateAggregationFunction {
return []DateAggregationFunction{
"COUNT",
"DISTINCT_COUNT",
"MIN",
"MAX",
}
}
type DayOfWeek string
// Enum values for DayOfWeek
const (
DayOfWeekSunday DayOfWeek = "SUNDAY"
DayOfWeekMonday DayOfWeek = "MONDAY"
DayOfWeekTuesday DayOfWeek = "TUESDAY"
DayOfWeekWednesday DayOfWeek = "WEDNESDAY"
DayOfWeekThursday DayOfWeek = "THURSDAY"
DayOfWeekFriday DayOfWeek = "FRIDAY"
DayOfWeekSaturday DayOfWeek = "SATURDAY"
)
// Values returns all known values for DayOfWeek. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
func (DayOfWeek) Values() []DayOfWeek {
return []DayOfWeek{
"SUNDAY",
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
}
}
type DefaultAggregation string
// Enum values for DefaultAggregation
const (
DefaultAggregationSum DefaultAggregation = "SUM"
DefaultAggregationMax DefaultAggregation = "MAX"
DefaultAggregationMin DefaultAggregation = "MIN"
DefaultAggregationCount DefaultAggregation = "COUNT"
DefaultAggregationDistinctCount DefaultAggregation = "DISTINCT_COUNT"
DefaultAggregationAverage DefaultAggregation = "AVERAGE"
)
// Values returns all known values for DefaultAggregation. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (DefaultAggregation) Values() []DefaultAggregation {
return []DefaultAggregation{
"SUM",
"MAX",
"MIN",
"COUNT",
"DISTINCT_COUNT",
"AVERAGE",
}
}
type DisplayFormat string
// Enum values for DisplayFormat
const (
DisplayFormatAuto DisplayFormat = "AUTO"
DisplayFormatPercent DisplayFormat = "PERCENT"
DisplayFormatCurrency DisplayFormat = "CURRENCY"
DisplayFormatNumber DisplayFormat = "NUMBER"
DisplayFormatDate DisplayFormat = "DATE"
DisplayFormatString DisplayFormat = "STRING"
)
// Values returns all known values for DisplayFormat. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (DisplayFormat) Values() []DisplayFormat {
return []DisplayFormat{
"AUTO",
"PERCENT",
"CURRENCY",
"NUMBER",
"DATE",
"STRING",
}
}
type Edition string
// Enum values for Edition
const (
EditionStandard Edition = "STANDARD"
EditionEnterprise Edition = "ENTERPRISE"
EditionEnterpriseAndQ Edition = "ENTERPRISE_AND_Q"
)
// Values returns all known values for Edition. Note that this can be expanded in
// the future, and so it is only as up to date as the client. The ordering of this
// slice is not guaranteed to be stable across updates.
func (Edition) Values() []Edition {
return []Edition{
"STANDARD",
"ENTERPRISE",
"ENTERPRISE_AND_Q",
}
}
type EmbeddingIdentityType string
// Enum values for EmbeddingIdentityType
const (
EmbeddingIdentityTypeIam EmbeddingIdentityType = "IAM"
EmbeddingIdentityTypeQuicksight EmbeddingIdentityType = "QUICKSIGHT"
EmbeddingIdentityTypeAnonymous EmbeddingIdentityType = "ANONYMOUS"
)
// Values returns all known values for EmbeddingIdentityType. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (EmbeddingIdentityType) Values() []EmbeddingIdentityType {
return []EmbeddingIdentityType{
"IAM",
"QUICKSIGHT",
"ANONYMOUS",
}
}
type ExceptionResourceType string
// Enum values for ExceptionResourceType
const (
ExceptionResourceTypeUser ExceptionResourceType = "USER"
ExceptionResourceTypeGroup ExceptionResourceType = "GROUP"
ExceptionResourceTypeNamespace ExceptionResourceType = "NAMESPACE"
ExceptionResourceTypeAccountSettings ExceptionResourceType = "ACCOUNT_SETTINGS"
ExceptionResourceTypeIampolicyAssignment ExceptionResourceType = "IAMPOLICY_ASSIGNMENT"
ExceptionResourceTypeDataSource ExceptionResourceType = "DATA_SOURCE"
ExceptionResourceTypeDataSet ExceptionResourceType = "DATA_SET"
ExceptionResourceTypeVpcConnection ExceptionResourceType = "VPC_CONNECTION"
ExceptionResourceTypeIngestion ExceptionResourceType = "INGESTION"
)
// Values returns all known values for ExceptionResourceType. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (ExceptionResourceType) Values() []ExceptionResourceType {
return []ExceptionResourceType{
"USER",
"GROUP",
"NAMESPACE",
"ACCOUNT_SETTINGS",
"IAMPOLICY_ASSIGNMENT",
"DATA_SOURCE",
"DATA_SET",
"VPC_CONNECTION",
"INGESTION",
}
}
type FileFormat string
// Enum values for FileFormat
const (
FileFormatCsv FileFormat = "CSV"
FileFormatTsv FileFormat = "TSV"
FileFormatClf FileFormat = "CLF"
FileFormatElf FileFormat = "ELF"
FileFormatXlsx FileFormat = "XLSX"
FileFormatJson FileFormat = "JSON"
)
// Values returns all known values for FileFormat. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
func (FileFormat) Values() []FileFormat {
return []FileFormat{
"CSV",
"TSV",
"CLF",
"ELF",
"XLSX",
"JSON",
}
}
type FilterClass string
// Enum values for FilterClass
const (
FilterClassEnforcedValueFilter FilterClass = "ENFORCED_VALUE_FILTER"
FilterClassConditionalValueFilter FilterClass = "CONDITIONAL_VALUE_FILTER"
FilterClassNamedValueFilter FilterClass = "NAMED_VALUE_FILTER"
)
// Values returns all known values for FilterClass. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
func (FilterClass) Values() []FilterClass {
return []FilterClass{
"ENFORCED_VALUE_FILTER",
"CONDITIONAL_VALUE_FILTER",
"NAMED_VALUE_FILTER",
}
}
type FilterNullOption string
// Enum values for FilterNullOption
const (
FilterNullOptionAllValues FilterNullOption = "ALL_VALUES"
FilterNullOptionNullsOnly FilterNullOption = "NULLS_ONLY"
FilterNullOptionNonNullsOnly FilterNullOption = "NON_NULLS_ONLY"
)
// Values returns all known values for FilterNullOption. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (FilterNullOption) Values() []FilterNullOption {
return []FilterNullOption{
"ALL_VALUES",
"NULLS_ONLY",
"NON_NULLS_ONLY",
}
}
type FilterOperator string
// Enum values for FilterOperator
const (
FilterOperatorStringEquals FilterOperator = "StringEquals"
FilterOperatorStringLike FilterOperator = "StringLike"
)
// Values returns all known values for FilterOperator. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (FilterOperator) Values() []FilterOperator {
return []FilterOperator{
"StringEquals",
"StringLike",
}
}
type FilterVisualScope string
// Enum values for FilterVisualScope
const (
FilterVisualScopeAllVisuals FilterVisualScope = "ALL_VISUALS"
FilterVisualScopeSelectedVisuals FilterVisualScope = "SELECTED_VISUALS"
)
// Values returns all known values for FilterVisualScope. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (FilterVisualScope) Values() []FilterVisualScope {
return []FilterVisualScope{
"ALL_VISUALS",
"SELECTED_VISUALS",
}
}
type FolderFilterAttribute string
// Enum values for FolderFilterAttribute
const (
FolderFilterAttributeParentFolderArn FolderFilterAttribute = "PARENT_FOLDER_ARN"
FolderFilterAttributeDirectQuicksightOwner FolderFilterAttribute = "DIRECT_QUICKSIGHT_OWNER"
FolderFilterAttributeDirectQuicksightSoleOwner FolderFilterAttribute = "DIRECT_QUICKSIGHT_SOLE_OWNER"
FolderFilterAttributeDirectQuicksightViewerOrOwner FolderFilterAttribute = "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"
FolderFilterAttributeQuicksightOwner FolderFilterAttribute = "QUICKSIGHT_OWNER"
FolderFilterAttributeQuicksightViewerOrOwner FolderFilterAttribute = "QUICKSIGHT_VIEWER_OR_OWNER"
FolderFilterAttributeFolderName FolderFilterAttribute = "FOLDER_NAME"
)
// Values returns all known values for FolderFilterAttribute. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (FolderFilterAttribute) Values() []FolderFilterAttribute {
return []FolderFilterAttribute{
"PARENT_FOLDER_ARN",
"DIRECT_QUICKSIGHT_OWNER",
"DIRECT_QUICKSIGHT_SOLE_OWNER",
"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER",
"QUICKSIGHT_OWNER",
"QUICKSIGHT_VIEWER_OR_OWNER",
"FOLDER_NAME",
}
}
type FolderType string
// Enum values for FolderType
const (
FolderTypeShared FolderType = "SHARED"
)
// Values returns all known values for FolderType. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
func (FolderType) Values() []FolderType {
return []FolderType{
"SHARED",
}
}
type FontDecoration string
// Enum values for FontDecoration
const (
FontDecorationUnderline FontDecoration = "UNDERLINE"
FontDecorationNone FontDecoration = "NONE"
)
// Values returns all known values for FontDecoration. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (FontDecoration) Values() []FontDecoration {
return []FontDecoration{
"UNDERLINE",
"NONE",
}
}
type FontStyle string
// Enum values for FontStyle
const (
FontStyleNormal FontStyle = "NORMAL"
FontStyleItalic FontStyle = "ITALIC"
)
// Values returns all known values for FontStyle. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
func (FontStyle) Values() []FontStyle {
return []FontStyle{
"NORMAL",
"ITALIC",
}
}
type FontWeightName string
// Enum values for FontWeightName
const (
FontWeightNameNormal FontWeightName = "NORMAL"
FontWeightNameBold FontWeightName = "BOLD"
)
// Values returns all known values for FontWeightName. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (FontWeightName) Values() []FontWeightName {
return []FontWeightName{
"NORMAL",
"BOLD",
}
}
type ForecastComputationSeasonality string
// Enum values for ForecastComputationSeasonality
const (
ForecastComputationSeasonalityAutomatic ForecastComputationSeasonality = "AUTOMATIC"
ForecastComputationSeasonalityCustom ForecastComputationSeasonality = "CUSTOM"
)
// Values returns all known values for ForecastComputationSeasonality. Note that
// this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (ForecastComputationSeasonality) Values() []ForecastComputationSeasonality {
return []ForecastComputationSeasonality{
"AUTOMATIC",
"CUSTOM",
}
}
type FunnelChartMeasureDataLabelStyle string
// Enum values for FunnelChartMeasureDataLabelStyle
const (
FunnelChartMeasureDataLabelStyleValueOnly FunnelChartMeasureDataLabelStyle = "VALUE_ONLY"
FunnelChartMeasureDataLabelStylePercentageByFirstStage FunnelChartMeasureDataLabelStyle = "PERCENTAGE_BY_FIRST_STAGE"
FunnelChartMeasureDataLabelStylePercentageByPreviousStage FunnelChartMeasureDataLabelStyle = "PERCENTAGE_BY_PREVIOUS_STAGE"
FunnelChartMeasureDataLabelStyleValueAndPercentageByFirstStage FunnelChartMeasureDataLabelStyle = "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE"
FunnelChartMeasureDataLabelStyleValueAndPercentageByPreviousStage FunnelChartMeasureDataLabelStyle = "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE"
)
// Values returns all known values for FunnelChartMeasureDataLabelStyle. Note that
// this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (FunnelChartMeasureDataLabelStyle) Values() []FunnelChartMeasureDataLabelStyle {
return []FunnelChartMeasureDataLabelStyle{
"VALUE_ONLY",
"PERCENTAGE_BY_FIRST_STAGE",
"PERCENTAGE_BY_PREVIOUS_STAGE",
"VALUE_AND_PERCENTAGE_BY_FIRST_STAGE",
"VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE",
}
}
type GeoSpatialCountryCode string
// Enum values for GeoSpatialCountryCode
const (
GeoSpatialCountryCodeUs GeoSpatialCountryCode = "US"
)
// Values returns all known values for GeoSpatialCountryCode. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (GeoSpatialCountryCode) Values() []GeoSpatialCountryCode {
return []GeoSpatialCountryCode{
"US",
}
}
type GeoSpatialDataRole string
// Enum values for GeoSpatialDataRole
const (
GeoSpatialDataRoleCountry GeoSpatialDataRole = "COUNTRY"
GeoSpatialDataRoleState GeoSpatialDataRole = "STATE"
GeoSpatialDataRoleCounty GeoSpatialDataRole = "COUNTY"
GeoSpatialDataRoleCity GeoSpatialDataRole = "CITY"
GeoSpatialDataRolePostcode GeoSpatialDataRole = "POSTCODE"
GeoSpatialDataRoleLongitude GeoSpatialDataRole = "LONGITUDE"
GeoSpatialDataRoleLatitude GeoSpatialDataRole = "LATITUDE"
)
// Values returns all known values for GeoSpatialDataRole. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (GeoSpatialDataRole) Values() []GeoSpatialDataRole {
return []GeoSpatialDataRole{
"COUNTRY",
"STATE",
"COUNTY",
"CITY",
"POSTCODE",
"LONGITUDE",
"LATITUDE",
}
}
type GeospatialSelectedPointStyle string
// Enum values for GeospatialSelectedPointStyle
const (
GeospatialSelectedPointStylePoint GeospatialSelectedPointStyle = "POINT"
GeospatialSelectedPointStyleCluster GeospatialSelectedPointStyle = "CLUSTER"
GeospatialSelectedPointStyleHeatmap GeospatialSelectedPointStyle = "HEATMAP"
)
// Values returns all known values for GeospatialSelectedPointStyle. Note that
// this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (GeospatialSelectedPointStyle) Values() []GeospatialSelectedPointStyle {
return []GeospatialSelectedPointStyle{
"POINT",
"CLUSTER",
"HEATMAP",
}
}
type GroupFilterAttribute string
// Enum values for GroupFilterAttribute
const (
GroupFilterAttributeGroupName GroupFilterAttribute = "GROUP_NAME"
)
// Values returns all known values for GroupFilterAttribute. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (GroupFilterAttribute) Values() []GroupFilterAttribute {
return []GroupFilterAttribute{
"GROUP_NAME",
}
}
type GroupFilterOperator string
// Enum values for GroupFilterOperator
const (
GroupFilterOperatorStartsWith GroupFilterOperator = "StartsWith"
)
// Values returns all known values for GroupFilterOperator. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (GroupFilterOperator) Values() []GroupFilterOperator {
return []GroupFilterOperator{
"StartsWith",
}
}
type HistogramBinType string
// Enum values for HistogramBinType
const (
HistogramBinTypeBinCount HistogramBinType = "BIN_COUNT"
HistogramBinTypeBinWidth HistogramBinType = "BIN_WIDTH"
)
// Values returns all known values for HistogramBinType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (HistogramBinType) Values() []HistogramBinType {
return []HistogramBinType{
"BIN_COUNT",
"BIN_WIDTH",
}
}
type HorizontalTextAlignment string
// Enum values for HorizontalTextAlignment
const (
HorizontalTextAlignmentLeft HorizontalTextAlignment = "LEFT"
HorizontalTextAlignmentCenter HorizontalTextAlignment = "CENTER"
HorizontalTextAlignmentRight HorizontalTextAlignment = "RIGHT"
HorizontalTextAlignmentAuto HorizontalTextAlignment = "AUTO"
)
// Values returns all known values for HorizontalTextAlignment. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (HorizontalTextAlignment) Values() []HorizontalTextAlignment {
return []HorizontalTextAlignment{
"LEFT",
"CENTER",
"RIGHT",
"AUTO",
}
}
type Icon string
// Enum values for Icon
const (
IconCaretUp Icon = "CARET_UP"
IconCaretDown Icon = "CARET_DOWN"
IconPlus Icon = "PLUS"
IconMinus Icon = "MINUS"
IconArrowUp Icon = "ARROW_UP"
IconArrowDown Icon = "ARROW_DOWN"
IconArrowLeft Icon = "ARROW_LEFT"
IconArrowUpLeft Icon = "ARROW_UP_LEFT"
IconArrowDownLeft Icon = "ARROW_DOWN_LEFT"
IconArrowRight Icon = "ARROW_RIGHT"
IconArrowUpRight Icon = "ARROW_UP_RIGHT"
IconArrowDownRight Icon = "ARROW_DOWN_RIGHT"
IconFaceUp Icon = "FACE_UP"
IconFaceDown Icon = "FACE_DOWN"
IconFaceFlat Icon = "FACE_FLAT"
IconOneBar Icon = "ONE_BAR"
IconTwoBar Icon = "TWO_BAR"
IconThreeBar Icon = "THREE_BAR"
IconCircle Icon = "CIRCLE"
IconTriangle Icon = "TRIANGLE"
IconSquare Icon = "SQUARE"
IconFlag Icon = "FLAG"
IconThumbsUp Icon = "THUMBS_UP"
IconThumbsDown Icon = "THUMBS_DOWN"
IconCheckmark Icon = "CHECKMARK"
IconX Icon = "X"
)
// Values returns all known values for Icon. Note that this can be expanded in the
// future, and so it is only as up to date as the client. The ordering of this
// slice is not guaranteed to be stable across updates.
func (Icon) Values() []Icon {
return []Icon{
"CARET_UP",
"CARET_DOWN",
"PLUS",
"MINUS",
"ARROW_UP",
"ARROW_DOWN",
"ARROW_LEFT",
"ARROW_UP_LEFT",
"ARROW_DOWN_LEFT",
"ARROW_RIGHT",
"ARROW_UP_RIGHT",
"ARROW_DOWN_RIGHT",
"FACE_UP",
"FACE_DOWN",
"FACE_FLAT",
"ONE_BAR",
"TWO_BAR",
"THREE_BAR",
"CIRCLE",
"TRIANGLE",
"SQUARE",
"FLAG",
"THUMBS_UP",
"THUMBS_DOWN",
"CHECKMARK",
"X",
}
}
type IdentityStore string
// Enum values for IdentityStore
const (
IdentityStoreQuicksight IdentityStore = "QUICKSIGHT"
)
// Values returns all known values for IdentityStore. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (IdentityStore) Values() []IdentityStore {
return []IdentityStore{
"QUICKSIGHT",
}
}
type IdentityType string
// Enum values for IdentityType
const (
IdentityTypeIam IdentityType = "IAM"
IdentityTypeQuicksight IdentityType = "QUICKSIGHT"
)
// Values returns all known values for IdentityType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (IdentityType) Values() []IdentityType {
return []IdentityType{
"IAM",
"QUICKSIGHT",
}
}
type IngestionErrorType string
// Enum values for IngestionErrorType
const (
IngestionErrorTypeFailureToAssumeRole IngestionErrorType = "FAILURE_TO_ASSUME_ROLE"
IngestionErrorTypeIngestionSuperseded IngestionErrorType = "INGESTION_SUPERSEDED"
IngestionErrorTypeIngestionCanceled IngestionErrorType = "INGESTION_CANCELED"
IngestionErrorTypeDataSetDeleted IngestionErrorType = "DATA_SET_DELETED"
IngestionErrorTypeDataSetNotSpice IngestionErrorType = "DATA_SET_NOT_SPICE"
IngestionErrorTypeS3UploadedFileDeleted IngestionErrorType = "S3_UPLOADED_FILE_DELETED"
IngestionErrorTypeS3ManifestError IngestionErrorType = "S3_MANIFEST_ERROR"
IngestionErrorTypeDataToleranceException IngestionErrorType = "DATA_TOLERANCE_EXCEPTION"
IngestionErrorTypeSpiceTableNotFound IngestionErrorType = "SPICE_TABLE_NOT_FOUND"
IngestionErrorTypeDataSetSizeLimitExceeded IngestionErrorType = "DATA_SET_SIZE_LIMIT_EXCEEDED"
IngestionErrorTypeRowSizeLimitExceeded IngestionErrorType = "ROW_SIZE_LIMIT_EXCEEDED"
IngestionErrorTypeAccountCapacityLimitExceeded IngestionErrorType = "ACCOUNT_CAPACITY_LIMIT_EXCEEDED"
IngestionErrorTypeCustomerError IngestionErrorType = "CUSTOMER_ERROR"
IngestionErrorTypeDataSourceNotFound IngestionErrorType = "DATA_SOURCE_NOT_FOUND"
IngestionErrorTypeIamRoleNotAvailable IngestionErrorType = "IAM_ROLE_NOT_AVAILABLE"
IngestionErrorTypeConnectionFailure IngestionErrorType = "CONNECTION_FAILURE"
IngestionErrorTypeSqlTableNotFound IngestionErrorType = "SQL_TABLE_NOT_FOUND"
IngestionErrorTypePermissionDenied IngestionErrorType = "PERMISSION_DENIED"
IngestionErrorTypeSslCertificateValidationFailure IngestionErrorType = "SSL_CERTIFICATE_VALIDATION_FAILURE"
IngestionErrorTypeOauthTokenFailure IngestionErrorType = "OAUTH_TOKEN_FAILURE"
IngestionErrorTypeSourceApiLimitExceededFailure IngestionErrorType = "SOURCE_API_LIMIT_EXCEEDED_FAILURE"
IngestionErrorTypePasswordAuthenticationFailure IngestionErrorType = "PASSWORD_AUTHENTICATION_FAILURE"
IngestionErrorTypeSqlSchemaMismatchError IngestionErrorType = "SQL_SCHEMA_MISMATCH_ERROR"
IngestionErrorTypeInvalidDateFormat IngestionErrorType = "INVALID_DATE_FORMAT"
IngestionErrorTypeInvalidDataprepSyntax IngestionErrorType = "INVALID_DATAPREP_SYNTAX"
IngestionErrorTypeSourceResourceLimitExceeded IngestionErrorType = "SOURCE_RESOURCE_LIMIT_EXCEEDED"
IngestionErrorTypeSqlInvalidParameterValue IngestionErrorType = "SQL_INVALID_PARAMETER_VALUE"
IngestionErrorTypeQueryTimeout IngestionErrorType = "QUERY_TIMEOUT"
IngestionErrorTypeSqlNumericOverflow IngestionErrorType = "SQL_NUMERIC_OVERFLOW"
IngestionErrorTypeUnresolvableHost IngestionErrorType = "UNRESOLVABLE_HOST"
IngestionErrorTypeUnroutableHost IngestionErrorType = "UNROUTABLE_HOST"
IngestionErrorTypeSqlException IngestionErrorType = "SQL_EXCEPTION"
IngestionErrorTypeS3FileInaccessible IngestionErrorType = "S3_FILE_INACCESSIBLE"
IngestionErrorTypeIotFileNotFound IngestionErrorType = "IOT_FILE_NOT_FOUND"
IngestionErrorTypeIotDataSetFileEmpty IngestionErrorType = "IOT_DATA_SET_FILE_EMPTY"
IngestionErrorTypeInvalidDataSourceConfig IngestionErrorType = "INVALID_DATA_SOURCE_CONFIG"
IngestionErrorTypeDataSourceAuthFailed IngestionErrorType = "DATA_SOURCE_AUTH_FAILED"
IngestionErrorTypeDataSourceConnectionFailed IngestionErrorType = "DATA_SOURCE_CONNECTION_FAILED"
IngestionErrorTypeFailureToProcessJsonFile IngestionErrorType = "FAILURE_TO_PROCESS_JSON_FILE"
IngestionErrorTypeInternalServiceError IngestionErrorType = "INTERNAL_SERVICE_ERROR"
IngestionErrorTypeRefreshSuppressedByEdit IngestionErrorType = "REFRESH_SUPPRESSED_BY_EDIT"
IngestionErrorTypePermissionNotFound IngestionErrorType = "PERMISSION_NOT_FOUND"
IngestionErrorTypeElasticsearchCursorNotEnabled IngestionErrorType = "ELASTICSEARCH_CURSOR_NOT_ENABLED"
IngestionErrorTypeCursorNotEnabled IngestionErrorType = "CURSOR_NOT_ENABLED"
IngestionErrorTypeDuplicateColumnNamesFound IngestionErrorType = "DUPLICATE_COLUMN_NAMES_FOUND"
)
// Values returns all known values for IngestionErrorType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (IngestionErrorType) Values() []IngestionErrorType {
return []IngestionErrorType{
"FAILURE_TO_ASSUME_ROLE",
"INGESTION_SUPERSEDED",
"INGESTION_CANCELED",
"DATA_SET_DELETED",
"DATA_SET_NOT_SPICE",
"S3_UPLOADED_FILE_DELETED",
"S3_MANIFEST_ERROR",
"DATA_TOLERANCE_EXCEPTION",
"SPICE_TABLE_NOT_FOUND",
"DATA_SET_SIZE_LIMIT_EXCEEDED",
"ROW_SIZE_LIMIT_EXCEEDED",
"ACCOUNT_CAPACITY_LIMIT_EXCEEDED",
"CUSTOMER_ERROR",
"DATA_SOURCE_NOT_FOUND",
"IAM_ROLE_NOT_AVAILABLE",
"CONNECTION_FAILURE",
"SQL_TABLE_NOT_FOUND",
"PERMISSION_DENIED",
"SSL_CERTIFICATE_VALIDATION_FAILURE",
"OAUTH_TOKEN_FAILURE",
"SOURCE_API_LIMIT_EXCEEDED_FAILURE",
"PASSWORD_AUTHENTICATION_FAILURE",
"SQL_SCHEMA_MISMATCH_ERROR",
"INVALID_DATE_FORMAT",
"INVALID_DATAPREP_SYNTAX",
"SOURCE_RESOURCE_LIMIT_EXCEEDED",
"SQL_INVALID_PARAMETER_VALUE",
"QUERY_TIMEOUT",
"SQL_NUMERIC_OVERFLOW",
"UNRESOLVABLE_HOST",
"UNROUTABLE_HOST",
"SQL_EXCEPTION",
"S3_FILE_INACCESSIBLE",
"IOT_FILE_NOT_FOUND",
"IOT_DATA_SET_FILE_EMPTY",
"INVALID_DATA_SOURCE_CONFIG",
"DATA_SOURCE_AUTH_FAILED",
"DATA_SOURCE_CONNECTION_FAILED",
"FAILURE_TO_PROCESS_JSON_FILE",
"INTERNAL_SERVICE_ERROR",
"REFRESH_SUPPRESSED_BY_EDIT",
"PERMISSION_NOT_FOUND",
"ELASTICSEARCH_CURSOR_NOT_ENABLED",
"CURSOR_NOT_ENABLED",
"DUPLICATE_COLUMN_NAMES_FOUND",
}
}
type IngestionRequestSource string
// Enum values for IngestionRequestSource
const (
IngestionRequestSourceManual IngestionRequestSource = "MANUAL"
IngestionRequestSourceScheduled IngestionRequestSource = "SCHEDULED"
)
// Values returns all known values for IngestionRequestSource. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (IngestionRequestSource) Values() []IngestionRequestSource {
return []IngestionRequestSource{
"MANUAL",
"SCHEDULED",
}
}
type IngestionRequestType string
// Enum values for IngestionRequestType
const (
IngestionRequestTypeInitialIngestion IngestionRequestType = "INITIAL_INGESTION"
IngestionRequestTypeEdit IngestionRequestType = "EDIT"
IngestionRequestTypeIncrementalRefresh IngestionRequestType = "INCREMENTAL_REFRESH"
IngestionRequestTypeFullRefresh IngestionRequestType = "FULL_REFRESH"
)
// Values returns all known values for IngestionRequestType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (IngestionRequestType) Values() []IngestionRequestType {
return []IngestionRequestType{
"INITIAL_INGESTION",
"EDIT",
"INCREMENTAL_REFRESH",
"FULL_REFRESH",
}
}
type IngestionStatus string
// Enum values for IngestionStatus
const (
IngestionStatusInitialized IngestionStatus = "INITIALIZED"
IngestionStatusQueued IngestionStatus = "QUEUED"
IngestionStatusRunning IngestionStatus = "RUNNING"
IngestionStatusFailed IngestionStatus = "FAILED"
IngestionStatusCompleted IngestionStatus = "COMPLETED"
IngestionStatusCancelled IngestionStatus = "CANCELLED"
)
// Values returns all known values for IngestionStatus. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (IngestionStatus) Values() []IngestionStatus {
return []IngestionStatus{
"INITIALIZED",
"QUEUED",
"RUNNING",
"FAILED",
"COMPLETED",
"CANCELLED",
}
}
type IngestionType string
// Enum values for IngestionType
const (
IngestionTypeIncrementalRefresh IngestionType = "INCREMENTAL_REFRESH"
IngestionTypeFullRefresh IngestionType = "FULL_REFRESH"
)
// Values returns all known values for IngestionType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (IngestionType) Values() []IngestionType {
return []IngestionType{
"INCREMENTAL_REFRESH",
"FULL_REFRESH",
}
}
type InputColumnDataType string
// Enum values for InputColumnDataType
const (
InputColumnDataTypeString InputColumnDataType = "STRING"
InputColumnDataTypeInteger InputColumnDataType = "INTEGER"
InputColumnDataTypeDecimal InputColumnDataType = "DECIMAL"
InputColumnDataTypeDatetime InputColumnDataType = "DATETIME"
InputColumnDataTypeBit InputColumnDataType = "BIT"
InputColumnDataTypeBoolean InputColumnDataType = "BOOLEAN"
InputColumnDataTypeJson InputColumnDataType = "JSON"
)
// Values returns all known values for InputColumnDataType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (InputColumnDataType) Values() []InputColumnDataType {
return []InputColumnDataType{
"STRING",
"INTEGER",
"DECIMAL",
"DATETIME",
"BIT",
"BOOLEAN",
"JSON",
}
}
type JoinType string
// Enum values for JoinType
const (
JoinTypeInner JoinType = "INNER"
JoinTypeOuter JoinType = "OUTER"
JoinTypeLeft JoinType = "LEFT"
JoinTypeRight JoinType = "RIGHT"
)
// Values returns all known values for JoinType. Note that this can be expanded in
// the future, and so it is only as up to date as the client. The ordering of this
// slice is not guaranteed to be stable across updates.
func (JoinType) Values() []JoinType {
return []JoinType{
"INNER",
"OUTER",
"LEFT",
"RIGHT",
}
}
type LayoutElementType string
// Enum values for LayoutElementType
const (
LayoutElementTypeVisual LayoutElementType = "VISUAL"
LayoutElementTypeFilterControl LayoutElementType = "FILTER_CONTROL"
LayoutElementTypeParameterControl LayoutElementType = "PARAMETER_CONTROL"
LayoutElementTypeTextBox LayoutElementType = "TEXT_BOX"
)
// Values returns all known values for LayoutElementType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (LayoutElementType) Values() []LayoutElementType {
return []LayoutElementType{
"VISUAL",
"FILTER_CONTROL",
"PARAMETER_CONTROL",
"TEXT_BOX",
}
}
type LegendPosition string
// Enum values for LegendPosition
const (
LegendPositionAuto LegendPosition = "AUTO"
LegendPositionRight LegendPosition = "RIGHT"
LegendPositionBottom LegendPosition = "BOTTOM"
LegendPositionTop LegendPosition = "TOP"
)
// Values returns all known values for LegendPosition. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (LegendPosition) Values() []LegendPosition {
return []LegendPosition{
"AUTO",
"RIGHT",
"BOTTOM",
"TOP",
}
}
type LineChartLineStyle string
// Enum values for LineChartLineStyle
const (
LineChartLineStyleSolid LineChartLineStyle = "SOLID"
LineChartLineStyleDotted LineChartLineStyle = "DOTTED"
LineChartLineStyleDashed LineChartLineStyle = "DASHED"
)
// Values returns all known values for LineChartLineStyle. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (LineChartLineStyle) Values() []LineChartLineStyle {
return []LineChartLineStyle{
"SOLID",
"DOTTED",
"DASHED",
}
}
type LineChartMarkerShape string
// Enum values for LineChartMarkerShape
const (
LineChartMarkerShapeCircle LineChartMarkerShape = "CIRCLE"
LineChartMarkerShapeTriangle LineChartMarkerShape = "TRIANGLE"
LineChartMarkerShapeSquare LineChartMarkerShape = "SQUARE"
LineChartMarkerShapeDiamond LineChartMarkerShape = "DIAMOND"
LineChartMarkerShapeRoundedSquare LineChartMarkerShape = "ROUNDED_SQUARE"
)
// Values returns all known values for LineChartMarkerShape. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (LineChartMarkerShape) Values() []LineChartMarkerShape {
return []LineChartMarkerShape{
"CIRCLE",
"TRIANGLE",
"SQUARE",
"DIAMOND",
"ROUNDED_SQUARE",
}
}
type LineChartType string
// Enum values for LineChartType
const (
LineChartTypeLine LineChartType = "LINE"
LineChartTypeArea LineChartType = "AREA"
LineChartTypeStackedArea LineChartType = "STACKED_AREA"
)
// Values returns all known values for LineChartType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (LineChartType) Values() []LineChartType {
return []LineChartType{
"LINE",
"AREA",
"STACKED_AREA",
}
}
type LineInterpolation string
// Enum values for LineInterpolation
const (
LineInterpolationLinear LineInterpolation = "LINEAR"
LineInterpolationSmooth LineInterpolation = "SMOOTH"
LineInterpolationStepped LineInterpolation = "STEPPED"
)
// Values returns all known values for LineInterpolation. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (LineInterpolation) Values() []LineInterpolation {
return []LineInterpolation{
"LINEAR",
"SMOOTH",
"STEPPED",
}
}
type LookbackWindowSizeUnit string
// Enum values for LookbackWindowSizeUnit
const (
LookbackWindowSizeUnitHour LookbackWindowSizeUnit = "HOUR"
LookbackWindowSizeUnitDay LookbackWindowSizeUnit = "DAY"
LookbackWindowSizeUnitWeek LookbackWindowSizeUnit = "WEEK"
)
// Values returns all known values for LookbackWindowSizeUnit. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (LookbackWindowSizeUnit) Values() []LookbackWindowSizeUnit {
return []LookbackWindowSizeUnit{
"HOUR",
"DAY",
"WEEK",
}
}
type MapZoomMode string
// Enum values for MapZoomMode
const (
MapZoomModeAuto MapZoomMode = "AUTO"
MapZoomModeManual MapZoomMode = "MANUAL"
)
// Values returns all known values for MapZoomMode. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
func (MapZoomMode) Values() []MapZoomMode {
return []MapZoomMode{
"AUTO",
"MANUAL",
}
}
type MaximumMinimumComputationType string
// Enum values for MaximumMinimumComputationType
const (
MaximumMinimumComputationTypeMaximum MaximumMinimumComputationType = "MAXIMUM"
MaximumMinimumComputationTypeMinimum MaximumMinimumComputationType = "MINIMUM"
)
// Values returns all known values for MaximumMinimumComputationType. Note that
// this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (MaximumMinimumComputationType) Values() []MaximumMinimumComputationType {
return []MaximumMinimumComputationType{
"MAXIMUM",
"MINIMUM",
}
}
type MemberType string
// Enum values for MemberType
const (
MemberTypeDashboard MemberType = "DASHBOARD"
MemberTypeAnalysis MemberType = "ANALYSIS"
MemberTypeDataset MemberType = "DATASET"
)
// Values returns all known values for MemberType. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
func (MemberType) Values() []MemberType {
return []MemberType{
"DASHBOARD",
"ANALYSIS",
"DATASET",
}
}
type MissingDataTreatmentOption string
// Enum values for MissingDataTreatmentOption
const (
MissingDataTreatmentOptionInterpolate MissingDataTreatmentOption = "INTERPOLATE"
MissingDataTreatmentOptionShowAsZero MissingDataTreatmentOption = "SHOW_AS_ZERO"
MissingDataTreatmentOptionShowAsBlank MissingDataTreatmentOption = "SHOW_AS_BLANK"
)
// Values returns all known values for MissingDataTreatmentOption. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (MissingDataTreatmentOption) Values() []MissingDataTreatmentOption {
return []MissingDataTreatmentOption{
"INTERPOLATE",
"SHOW_AS_ZERO",
"SHOW_AS_BLANK",
}
}
type NamedEntityAggType string
// Enum values for NamedEntityAggType
const (
NamedEntityAggTypeSum NamedEntityAggType = "SUM"
NamedEntityAggTypeMin NamedEntityAggType = "MIN"
NamedEntityAggTypeMax NamedEntityAggType = "MAX"
NamedEntityAggTypeCount NamedEntityAggType = "COUNT"
NamedEntityAggTypeAverage NamedEntityAggType = "AVERAGE"
NamedEntityAggTypeDistinctCount NamedEntityAggType = "DISTINCT_COUNT"
NamedEntityAggTypeStdev NamedEntityAggType = "STDEV"
NamedEntityAggTypeStdevp NamedEntityAggType = "STDEVP"
NamedEntityAggTypeVar NamedEntityAggType = "VAR"
NamedEntityAggTypeVarp NamedEntityAggType = "VARP"
NamedEntityAggTypePercentile NamedEntityAggType = "PERCENTILE"
NamedEntityAggTypeMedian NamedEntityAggType = "MEDIAN"
NamedEntityAggTypeCustom NamedEntityAggType = "CUSTOM"
)
// Values returns all known values for NamedEntityAggType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (NamedEntityAggType) Values() []NamedEntityAggType {
return []NamedEntityAggType{
"SUM",
"MIN",
"MAX",
"COUNT",
"AVERAGE",
"DISTINCT_COUNT",
"STDEV",
"STDEVP",
"VAR",
"VARP",
"PERCENTILE",
"MEDIAN",
"CUSTOM",
}
}
type NamedFilterAggType string
// Enum values for NamedFilterAggType
const (
NamedFilterAggTypeNoAggregation NamedFilterAggType = "NO_AGGREGATION"
NamedFilterAggTypeSum NamedFilterAggType = "SUM"
NamedFilterAggTypeAverage NamedFilterAggType = "AVERAGE"
NamedFilterAggTypeCount NamedFilterAggType = "COUNT"
NamedFilterAggTypeDistinctCount NamedFilterAggType = "DISTINCT_COUNT"
NamedFilterAggTypeMax NamedFilterAggType = "MAX"
NamedFilterAggTypeMedian NamedFilterAggType = "MEDIAN"
NamedFilterAggTypeMin NamedFilterAggType = "MIN"
NamedFilterAggTypeStdev NamedFilterAggType = "STDEV"
NamedFilterAggTypeStdevp NamedFilterAggType = "STDEVP"
NamedFilterAggTypeVar NamedFilterAggType = "VAR"
NamedFilterAggTypeVarp NamedFilterAggType = "VARP"
)
// Values returns all known values for NamedFilterAggType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (NamedFilterAggType) Values() []NamedFilterAggType {
return []NamedFilterAggType{
"NO_AGGREGATION",
"SUM",
"AVERAGE",
"COUNT",
"DISTINCT_COUNT",
"MAX",
"MEDIAN",
"MIN",
"STDEV",
"STDEVP",
"VAR",
"VARP",
}
}
type NamedFilterType string
// Enum values for NamedFilterType
const (
NamedFilterTypeCategoryFilter NamedFilterType = "CATEGORY_FILTER"
NamedFilterTypeNumericEqualityFilter NamedFilterType = "NUMERIC_EQUALITY_FILTER"
NamedFilterTypeNumericRangeFilter NamedFilterType = "NUMERIC_RANGE_FILTER"
NamedFilterTypeDateRangeFilter NamedFilterType = "DATE_RANGE_FILTER"
NamedFilterTypeRelativeDateFilter NamedFilterType = "RELATIVE_DATE_FILTER"
)
// Values returns all known values for NamedFilterType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (NamedFilterType) Values() []NamedFilterType {
return []NamedFilterType{
"CATEGORY_FILTER",
"NUMERIC_EQUALITY_FILTER",
"NUMERIC_RANGE_FILTER",
"DATE_RANGE_FILTER",
"RELATIVE_DATE_FILTER",
}
}
type NamespaceErrorType string
// Enum values for NamespaceErrorType
const (
NamespaceErrorTypePermissionDenied NamespaceErrorType = "PERMISSION_DENIED"
NamespaceErrorTypeInternalServiceError NamespaceErrorType = "INTERNAL_SERVICE_ERROR"
)
// Values returns all known values for NamespaceErrorType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (NamespaceErrorType) Values() []NamespaceErrorType {
return []NamespaceErrorType{
"PERMISSION_DENIED",
"INTERNAL_SERVICE_ERROR",
}
}
type NamespaceStatus string
// Enum values for NamespaceStatus
const (
NamespaceStatusCreated NamespaceStatus = "CREATED"
NamespaceStatusCreating NamespaceStatus = "CREATING"
NamespaceStatusDeleting NamespaceStatus = "DELETING"
NamespaceStatusRetryableFailure NamespaceStatus = "RETRYABLE_FAILURE"
NamespaceStatusNonRetryableFailure NamespaceStatus = "NON_RETRYABLE_FAILURE"
)
// Values returns all known values for NamespaceStatus. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (NamespaceStatus) Values() []NamespaceStatus {
return []NamespaceStatus{
"CREATED",
"CREATING",
"DELETING",
"RETRYABLE_FAILURE",
"NON_RETRYABLE_FAILURE",
}
}
type NegativeValueDisplayMode string
// Enum values for NegativeValueDisplayMode
const (
NegativeValueDisplayModePositive NegativeValueDisplayMode = "POSITIVE"
NegativeValueDisplayModeNegative NegativeValueDisplayMode = "NEGATIVE"
)
// Values returns all known values for NegativeValueDisplayMode. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (NegativeValueDisplayMode) Values() []NegativeValueDisplayMode {
return []NegativeValueDisplayMode{
"POSITIVE",
"NEGATIVE",
}
}
type NetworkInterfaceStatus string
// Enum values for NetworkInterfaceStatus
const (
NetworkInterfaceStatusCreating NetworkInterfaceStatus = "CREATING"
NetworkInterfaceStatusAvailable NetworkInterfaceStatus = "AVAILABLE"
NetworkInterfaceStatusCreationFailed NetworkInterfaceStatus = "CREATION_FAILED"
NetworkInterfaceStatusUpdating NetworkInterfaceStatus = "UPDATING"
NetworkInterfaceStatusUpdateFailed NetworkInterfaceStatus = "UPDATE_FAILED"
NetworkInterfaceStatusDeleting NetworkInterfaceStatus = "DELETING"
NetworkInterfaceStatusDeleted NetworkInterfaceStatus = "DELETED"
NetworkInterfaceStatusDeletionFailed NetworkInterfaceStatus = "DELETION_FAILED"
NetworkInterfaceStatusDeletionScheduled NetworkInterfaceStatus = "DELETION_SCHEDULED"
NetworkInterfaceStatusAttachmentFailedRollbackFailed NetworkInterfaceStatus = "ATTACHMENT_FAILED_ROLLBACK_FAILED"
)
// Values returns all known values for NetworkInterfaceStatus. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (NetworkInterfaceStatus) Values() []NetworkInterfaceStatus {
return []NetworkInterfaceStatus{
"CREATING",
"AVAILABLE",
"CREATION_FAILED",
"UPDATING",
"UPDATE_FAILED",
"DELETING",
"DELETED",
"DELETION_FAILED",
"DELETION_SCHEDULED",
"ATTACHMENT_FAILED_ROLLBACK_FAILED",
}
}
type NumberScale string
// Enum values for NumberScale
const (
NumberScaleNone NumberScale = "NONE"
NumberScaleAuto NumberScale = "AUTO"
NumberScaleThousands NumberScale = "THOUSANDS"
NumberScaleMillions NumberScale = "MILLIONS"
NumberScaleBillions NumberScale = "BILLIONS"
NumberScaleTrillions NumberScale = "TRILLIONS"
)
// Values returns all known values for NumberScale. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
func (NumberScale) Values() []NumberScale {
return []NumberScale{
"NONE",
"AUTO",
"THOUSANDS",
"MILLIONS",
"BILLIONS",
"TRILLIONS",
}
}
type NumericEqualityMatchOperator string
// Enum values for NumericEqualityMatchOperator
const (
NumericEqualityMatchOperatorEquals NumericEqualityMatchOperator = "EQUALS"
NumericEqualityMatchOperatorDoesNotEqual NumericEqualityMatchOperator = "DOES_NOT_EQUAL"
)
// Values returns all known values for NumericEqualityMatchOperator. Note that
// this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (NumericEqualityMatchOperator) Values() []NumericEqualityMatchOperator {
return []NumericEqualityMatchOperator{
"EQUALS",
"DOES_NOT_EQUAL",
}
}
type NumericFilterSelectAllOptions string
// Enum values for NumericFilterSelectAllOptions
const (
NumericFilterSelectAllOptionsFilterAllValues NumericFilterSelectAllOptions = "FILTER_ALL_VALUES"
)
// Values returns all known values for NumericFilterSelectAllOptions. Note that
// this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (NumericFilterSelectAllOptions) Values() []NumericFilterSelectAllOptions {
return []NumericFilterSelectAllOptions{
"FILTER_ALL_VALUES",
}
}
type NumericSeparatorSymbol string
// Enum values for NumericSeparatorSymbol
const (
NumericSeparatorSymbolComma NumericSeparatorSymbol = "COMMA"
NumericSeparatorSymbolDot NumericSeparatorSymbol = "DOT"
NumericSeparatorSymbolSpace NumericSeparatorSymbol = "SPACE"
)
// Values returns all known values for NumericSeparatorSymbol. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (NumericSeparatorSymbol) Values() []NumericSeparatorSymbol {
return []NumericSeparatorSymbol{
"COMMA",
"DOT",
"SPACE",
}
}
type OtherCategories string
// Enum values for OtherCategories
const (
OtherCategoriesInclude OtherCategories = "INCLUDE"
OtherCategoriesExclude OtherCategories = "EXCLUDE"
)
// Values returns all known values for OtherCategories. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (OtherCategories) Values() []OtherCategories {
return []OtherCategories{
"INCLUDE",
"EXCLUDE",
}
}
type PanelBorderStyle string
// Enum values for PanelBorderStyle
const (
PanelBorderStyleSolid PanelBorderStyle = "SOLID"
PanelBorderStyleDashed PanelBorderStyle = "DASHED"
PanelBorderStyleDotted PanelBorderStyle = "DOTTED"
)
// Values returns all known values for PanelBorderStyle. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (PanelBorderStyle) Values() []PanelBorderStyle {
return []PanelBorderStyle{
"SOLID",
"DASHED",
"DOTTED",
}
}
type PaperOrientation string
// Enum values for PaperOrientation
const (
PaperOrientationPortrait PaperOrientation = "PORTRAIT"
PaperOrientationLandscape PaperOrientation = "LANDSCAPE"
)
// Values returns all known values for PaperOrientation. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (PaperOrientation) Values() []PaperOrientation {
return []PaperOrientation{
"PORTRAIT",
"LANDSCAPE",
}
}
type PaperSize string
// Enum values for PaperSize
const (
PaperSizeUsLetter PaperSize = "US_LETTER"
PaperSizeUsLegal PaperSize = "US_LEGAL"
PaperSizeUsTabloidLedger PaperSize = "US_TABLOID_LEDGER"
PaperSizeA0 PaperSize = "A0"
PaperSizeA1 PaperSize = "A1"
PaperSizeA2 PaperSize = "A2"
PaperSizeA3 PaperSize = "A3"
PaperSizeA4 PaperSize = "A4"
PaperSizeA5 PaperSize = "A5"
PaperSizeJisB4 PaperSize = "JIS_B4"
PaperSizeJisB5 PaperSize = "JIS_B5"
)
// Values returns all known values for PaperSize. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
func (PaperSize) Values() []PaperSize {
return []PaperSize{
"US_LETTER",
"US_LEGAL",
"US_TABLOID_LEDGER",
"A0",
"A1",
"A2",
"A3",
"A4",
"A5",
"JIS_B4",
"JIS_B5",
}
}
type ParameterValueType string
// Enum values for ParameterValueType
const (
ParameterValueTypeMultiValued ParameterValueType = "MULTI_VALUED"
ParameterValueTypeSingleValued ParameterValueType = "SINGLE_VALUED"
)
// Values returns all known values for ParameterValueType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (ParameterValueType) Values() []ParameterValueType {
return []ParameterValueType{
"MULTI_VALUED",
"SINGLE_VALUED",
}
}
type PivotTableConditionalFormattingScopeRole string
// Enum values for PivotTableConditionalFormattingScopeRole
const (
PivotTableConditionalFormattingScopeRoleField PivotTableConditionalFormattingScopeRole = "FIELD"
PivotTableConditionalFormattingScopeRoleFieldTotal PivotTableConditionalFormattingScopeRole = "FIELD_TOTAL"
PivotTableConditionalFormattingScopeRoleGrandTotal PivotTableConditionalFormattingScopeRole = "GRAND_TOTAL"
)
// Values returns all known values for PivotTableConditionalFormattingScopeRole.
// Note that this can be expanded in the future, and so it is only as up to date as
// the client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (PivotTableConditionalFormattingScopeRole) Values() []PivotTableConditionalFormattingScopeRole {
return []PivotTableConditionalFormattingScopeRole{
"FIELD",
"FIELD_TOTAL",
"GRAND_TOTAL",
}
}
type PivotTableFieldCollapseState string
// Enum values for PivotTableFieldCollapseState
const (
PivotTableFieldCollapseStateCollapsed PivotTableFieldCollapseState = "COLLAPSED"
PivotTableFieldCollapseStateExpanded PivotTableFieldCollapseState = "EXPANDED"
)
// Values returns all known values for PivotTableFieldCollapseState. Note that
// this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (PivotTableFieldCollapseState) Values() []PivotTableFieldCollapseState {
return []PivotTableFieldCollapseState{
"COLLAPSED",
"EXPANDED",
}
}
type PivotTableMetricPlacement string
// Enum values for PivotTableMetricPlacement
const (
PivotTableMetricPlacementRow PivotTableMetricPlacement = "ROW"
PivotTableMetricPlacementColumn PivotTableMetricPlacement = "COLUMN"
)
// Values returns all known values for PivotTableMetricPlacement. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (PivotTableMetricPlacement) Values() []PivotTableMetricPlacement {
return []PivotTableMetricPlacement{
"ROW",
"COLUMN",
}
}
type PivotTableSubtotalLevel string
// Enum values for PivotTableSubtotalLevel
const (
PivotTableSubtotalLevelAll PivotTableSubtotalLevel = "ALL"
PivotTableSubtotalLevelCustom PivotTableSubtotalLevel = "CUSTOM"
PivotTableSubtotalLevelLast PivotTableSubtotalLevel = "LAST"
)
// Values returns all known values for PivotTableSubtotalLevel. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (PivotTableSubtotalLevel) Values() []PivotTableSubtotalLevel {
return []PivotTableSubtotalLevel{
"ALL",
"CUSTOM",
"LAST",
}
}
type PrimaryValueDisplayType string
// Enum values for PrimaryValueDisplayType
const (
PrimaryValueDisplayTypeHidden PrimaryValueDisplayType = "HIDDEN"
PrimaryValueDisplayTypeComparison PrimaryValueDisplayType = "COMPARISON"
PrimaryValueDisplayTypeActual PrimaryValueDisplayType = "ACTUAL"
)
// Values returns all known values for PrimaryValueDisplayType. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (PrimaryValueDisplayType) Values() []PrimaryValueDisplayType {
return []PrimaryValueDisplayType{
"HIDDEN",
"COMPARISON",
"ACTUAL",
}
}
type PropertyRole string
// Enum values for PropertyRole
const (
PropertyRolePrimary PropertyRole = "PRIMARY"
PropertyRoleId PropertyRole = "ID"
)
// Values returns all known values for PropertyRole. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (PropertyRole) Values() []PropertyRole {
return []PropertyRole{
"PRIMARY",
"ID",
}
}
type PropertyUsage string
// Enum values for PropertyUsage
const (
PropertyUsageInherit PropertyUsage = "INHERIT"
PropertyUsageDimension PropertyUsage = "DIMENSION"
PropertyUsageMeasure PropertyUsage = "MEASURE"
)
// Values returns all known values for PropertyUsage. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (PropertyUsage) Values() []PropertyUsage {
return []PropertyUsage{
"INHERIT",
"DIMENSION",
"MEASURE",
}
}
type RadarChartAxesRangeScale string
// Enum values for RadarChartAxesRangeScale
const (
RadarChartAxesRangeScaleAuto RadarChartAxesRangeScale = "AUTO"
RadarChartAxesRangeScaleIndependent RadarChartAxesRangeScale = "INDEPENDENT"
RadarChartAxesRangeScaleShared RadarChartAxesRangeScale = "SHARED"
)
// Values returns all known values for RadarChartAxesRangeScale. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (RadarChartAxesRangeScale) Values() []RadarChartAxesRangeScale {
return []RadarChartAxesRangeScale{
"AUTO",
"INDEPENDENT",
"SHARED",
}
}
type RadarChartShape string
// Enum values for RadarChartShape
const (
RadarChartShapeCircle RadarChartShape = "CIRCLE"
RadarChartShapePolygon RadarChartShape = "POLYGON"
)
// Values returns all known values for RadarChartShape. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (RadarChartShape) Values() []RadarChartShape {
return []RadarChartShape{
"CIRCLE",
"POLYGON",
}
}
type ReferenceLineLabelHorizontalPosition string
// Enum values for ReferenceLineLabelHorizontalPosition
const (
ReferenceLineLabelHorizontalPositionLeft ReferenceLineLabelHorizontalPosition = "LEFT"
ReferenceLineLabelHorizontalPositionCenter ReferenceLineLabelHorizontalPosition = "CENTER"
ReferenceLineLabelHorizontalPositionRight ReferenceLineLabelHorizontalPosition = "RIGHT"
)
// Values returns all known values for ReferenceLineLabelHorizontalPosition. Note
// that this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (ReferenceLineLabelHorizontalPosition) Values() []ReferenceLineLabelHorizontalPosition {
return []ReferenceLineLabelHorizontalPosition{
"LEFT",
"CENTER",
"RIGHT",
}
}
type ReferenceLineLabelVerticalPosition string
// Enum values for ReferenceLineLabelVerticalPosition
const (
ReferenceLineLabelVerticalPositionAbove ReferenceLineLabelVerticalPosition = "ABOVE"
ReferenceLineLabelVerticalPositionBelow ReferenceLineLabelVerticalPosition = "BELOW"
)
// Values returns all known values for ReferenceLineLabelVerticalPosition. Note
// that this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (ReferenceLineLabelVerticalPosition) Values() []ReferenceLineLabelVerticalPosition {
return []ReferenceLineLabelVerticalPosition{
"ABOVE",
"BELOW",
}
}
type ReferenceLinePatternType string
// Enum values for ReferenceLinePatternType
const (
ReferenceLinePatternTypeSolid ReferenceLinePatternType = "SOLID"
ReferenceLinePatternTypeDashed ReferenceLinePatternType = "DASHED"
ReferenceLinePatternTypeDotted ReferenceLinePatternType = "DOTTED"
)
// Values returns all known values for ReferenceLinePatternType. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (ReferenceLinePatternType) Values() []ReferenceLinePatternType {
return []ReferenceLinePatternType{
"SOLID",
"DASHED",
"DOTTED",
}
}
type ReferenceLineValueLabelRelativePosition string
// Enum values for ReferenceLineValueLabelRelativePosition
const (
ReferenceLineValueLabelRelativePositionBeforeCustomLabel ReferenceLineValueLabelRelativePosition = "BEFORE_CUSTOM_LABEL"
ReferenceLineValueLabelRelativePositionAfterCustomLabel ReferenceLineValueLabelRelativePosition = "AFTER_CUSTOM_LABEL"
)
// Values returns all known values for ReferenceLineValueLabelRelativePosition.
// Note that this can be expanded in the future, and so it is only as up to date as
// the client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (ReferenceLineValueLabelRelativePosition) Values() []ReferenceLineValueLabelRelativePosition {
return []ReferenceLineValueLabelRelativePosition{
"BEFORE_CUSTOM_LABEL",
"AFTER_CUSTOM_LABEL",
}
}
type RefreshInterval string
// Enum values for RefreshInterval
const (
RefreshIntervalMinute15 RefreshInterval = "MINUTE15"
RefreshIntervalMinute30 RefreshInterval = "MINUTE30"
RefreshIntervalHourly RefreshInterval = "HOURLY"
RefreshIntervalDaily RefreshInterval = "DAILY"
RefreshIntervalWeekly RefreshInterval = "WEEKLY"
RefreshIntervalMonthly RefreshInterval = "MONTHLY"
)
// Values returns all known values for RefreshInterval. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (RefreshInterval) Values() []RefreshInterval {
return []RefreshInterval{
"MINUTE15",
"MINUTE30",
"HOURLY",
"DAILY",
"WEEKLY",
"MONTHLY",
}
}
type RelativeDateType string
// Enum values for RelativeDateType
const (
RelativeDateTypePrevious RelativeDateType = "PREVIOUS"
RelativeDateTypeThis RelativeDateType = "THIS"
RelativeDateTypeLast RelativeDateType = "LAST"
RelativeDateTypeNow RelativeDateType = "NOW"
RelativeDateTypeNext RelativeDateType = "NEXT"
)
// Values returns all known values for RelativeDateType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (RelativeDateType) Values() []RelativeDateType {
return []RelativeDateType{
"PREVIOUS",
"THIS",
"LAST",
"NOW",
"NEXT",
}
}
type RelativeFontSize string
// Enum values for RelativeFontSize
const (
RelativeFontSizeExtraSmall RelativeFontSize = "EXTRA_SMALL"
RelativeFontSizeSmall RelativeFontSize = "SMALL"
RelativeFontSizeMedium RelativeFontSize = "MEDIUM"
RelativeFontSizeLarge RelativeFontSize = "LARGE"
RelativeFontSizeExtraLarge RelativeFontSize = "EXTRA_LARGE"
)
// Values returns all known values for RelativeFontSize. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (RelativeFontSize) Values() []RelativeFontSize {
return []RelativeFontSize{
"EXTRA_SMALL",
"SMALL",
"MEDIUM",
"LARGE",
"EXTRA_LARGE",
}
}
type ResizeOption string
// Enum values for ResizeOption
const (
ResizeOptionFixed ResizeOption = "FIXED"
ResizeOptionResponsive ResizeOption = "RESPONSIVE"
)
// Values returns all known values for ResizeOption. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (ResizeOption) Values() []ResizeOption {
return []ResizeOption{
"FIXED",
"RESPONSIVE",
}
}
type ResourceStatus string
// Enum values for ResourceStatus
const (
ResourceStatusCreationInProgress ResourceStatus = "CREATION_IN_PROGRESS"
ResourceStatusCreationSuccessful ResourceStatus = "CREATION_SUCCESSFUL"
ResourceStatusCreationFailed ResourceStatus = "CREATION_FAILED"
ResourceStatusUpdateInProgress ResourceStatus = "UPDATE_IN_PROGRESS"
ResourceStatusUpdateSuccessful ResourceStatus = "UPDATE_SUCCESSFUL"
ResourceStatusUpdateFailed ResourceStatus = "UPDATE_FAILED"
ResourceStatusDeleted ResourceStatus = "DELETED"
)
// Values returns all known values for ResourceStatus. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (ResourceStatus) Values() []ResourceStatus {
return []ResourceStatus{
"CREATION_IN_PROGRESS",
"CREATION_SUCCESSFUL",
"CREATION_FAILED",
"UPDATE_IN_PROGRESS",
"UPDATE_SUCCESSFUL",
"UPDATE_FAILED",
"DELETED",
}
}
type RowLevelPermissionFormatVersion string
// Enum values for RowLevelPermissionFormatVersion
const (
RowLevelPermissionFormatVersionVersion1 RowLevelPermissionFormatVersion = "VERSION_1"
RowLevelPermissionFormatVersionVersion2 RowLevelPermissionFormatVersion = "VERSION_2"
)
// Values returns all known values for RowLevelPermissionFormatVersion. Note that
// this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (RowLevelPermissionFormatVersion) Values() []RowLevelPermissionFormatVersion {
return []RowLevelPermissionFormatVersion{
"VERSION_1",
"VERSION_2",
}
}
type RowLevelPermissionPolicy string
// Enum values for RowLevelPermissionPolicy
const (
RowLevelPermissionPolicyGrantAccess RowLevelPermissionPolicy = "GRANT_ACCESS"
RowLevelPermissionPolicyDenyAccess RowLevelPermissionPolicy = "DENY_ACCESS"
)
// Values returns all known values for RowLevelPermissionPolicy. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (RowLevelPermissionPolicy) Values() []RowLevelPermissionPolicy {
return []RowLevelPermissionPolicy{
"GRANT_ACCESS",
"DENY_ACCESS",
}
}
type SectionPageBreakStatus string
// Enum values for SectionPageBreakStatus
const (
SectionPageBreakStatusEnabled SectionPageBreakStatus = "ENABLED"
SectionPageBreakStatusDisabled SectionPageBreakStatus = "DISABLED"
)
// Values returns all known values for SectionPageBreakStatus. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (SectionPageBreakStatus) Values() []SectionPageBreakStatus {
return []SectionPageBreakStatus{
"ENABLED",
"DISABLED",
}
}
type SelectAllValueOptions string
// Enum values for SelectAllValueOptions
const (
SelectAllValueOptionsAllValues SelectAllValueOptions = "ALL_VALUES"
)
// Values returns all known values for SelectAllValueOptions. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (SelectAllValueOptions) Values() []SelectAllValueOptions {
return []SelectAllValueOptions{
"ALL_VALUES",
}
}
type SelectedFieldOptions string
// Enum values for SelectedFieldOptions
const (
SelectedFieldOptionsAllFields SelectedFieldOptions = "ALL_FIELDS"
)
// Values returns all known values for SelectedFieldOptions. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (SelectedFieldOptions) Values() []SelectedFieldOptions {
return []SelectedFieldOptions{
"ALL_FIELDS",
}
}
type SelectedTooltipType string
// Enum values for SelectedTooltipType
const (
SelectedTooltipTypeBasic SelectedTooltipType = "BASIC"
SelectedTooltipTypeDetailed SelectedTooltipType = "DETAILED"
)
// Values returns all known values for SelectedTooltipType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (SelectedTooltipType) Values() []SelectedTooltipType {
return []SelectedTooltipType{
"BASIC",
"DETAILED",
}
}
type SheetContentType string
// Enum values for SheetContentType
const (
SheetContentTypePaginated SheetContentType = "PAGINATED"
SheetContentTypeInteractive SheetContentType = "INTERACTIVE"
)
// Values returns all known values for SheetContentType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (SheetContentType) Values() []SheetContentType {
return []SheetContentType{
"PAGINATED",
"INTERACTIVE",
}
}
type SheetControlDateTimePickerType string
// Enum values for SheetControlDateTimePickerType
const (
SheetControlDateTimePickerTypeSingleValued SheetControlDateTimePickerType = "SINGLE_VALUED"
SheetControlDateTimePickerTypeDateRange SheetControlDateTimePickerType = "DATE_RANGE"
)
// Values returns all known values for SheetControlDateTimePickerType. Note that
// this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (SheetControlDateTimePickerType) Values() []SheetControlDateTimePickerType {
return []SheetControlDateTimePickerType{
"SINGLE_VALUED",
"DATE_RANGE",
}
}
type SheetControlListType string
// Enum values for SheetControlListType
const (
SheetControlListTypeMultiSelect SheetControlListType = "MULTI_SELECT"
SheetControlListTypeSingleSelect SheetControlListType = "SINGLE_SELECT"
)
// Values returns all known values for SheetControlListType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (SheetControlListType) Values() []SheetControlListType {
return []SheetControlListType{
"MULTI_SELECT",
"SINGLE_SELECT",
}
}
type SheetControlSliderType string
// Enum values for SheetControlSliderType
const (
SheetControlSliderTypeSinglePoint SheetControlSliderType = "SINGLE_POINT"
SheetControlSliderTypeRange SheetControlSliderType = "RANGE"
)
// Values returns all known values for SheetControlSliderType. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (SheetControlSliderType) Values() []SheetControlSliderType {
return []SheetControlSliderType{
"SINGLE_POINT",
"RANGE",
}
}
type SimpleNumericalAggregationFunction string
// Enum values for SimpleNumericalAggregationFunction
const (
SimpleNumericalAggregationFunctionSum SimpleNumericalAggregationFunction = "SUM"
SimpleNumericalAggregationFunctionAverage SimpleNumericalAggregationFunction = "AVERAGE"
SimpleNumericalAggregationFunctionMin SimpleNumericalAggregationFunction = "MIN"
SimpleNumericalAggregationFunctionMax SimpleNumericalAggregationFunction = "MAX"
SimpleNumericalAggregationFunctionCount SimpleNumericalAggregationFunction = "COUNT"
SimpleNumericalAggregationFunctionDistinctCount SimpleNumericalAggregationFunction = "DISTINCT_COUNT"
SimpleNumericalAggregationFunctionVar SimpleNumericalAggregationFunction = "VAR"
SimpleNumericalAggregationFunctionVarp SimpleNumericalAggregationFunction = "VARP"
SimpleNumericalAggregationFunctionStdev SimpleNumericalAggregationFunction = "STDEV"
SimpleNumericalAggregationFunctionStdevp SimpleNumericalAggregationFunction = "STDEVP"
SimpleNumericalAggregationFunctionMedian SimpleNumericalAggregationFunction = "MEDIAN"
)
// Values returns all known values for SimpleNumericalAggregationFunction. Note
// that this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (SimpleNumericalAggregationFunction) Values() []SimpleNumericalAggregationFunction {
return []SimpleNumericalAggregationFunction{
"SUM",
"AVERAGE",
"MIN",
"MAX",
"COUNT",
"DISTINCT_COUNT",
"VAR",
"VARP",
"STDEV",
"STDEVP",
"MEDIAN",
}
}
type SortDirection string
// Enum values for SortDirection
const (
SortDirectionAsc SortDirection = "ASC"
SortDirectionDesc SortDirection = "DESC"
)
// Values returns all known values for SortDirection. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (SortDirection) Values() []SortDirection {
return []SortDirection{
"ASC",
"DESC",
}
}
type Status string
// Enum values for Status
const (
StatusEnabled Status = "ENABLED"
StatusDisabled Status = "DISABLED"
)
// Values returns all known values for Status. Note that this can be expanded in
// the future, and so it is only as up to date as the client. The ordering of this
// slice is not guaranteed to be stable across updates.
func (Status) Values() []Status {
return []Status{
"ENABLED",
"DISABLED",
}
}
type TableBorderStyle string
// Enum values for TableBorderStyle
const (
TableBorderStyleNone TableBorderStyle = "NONE"
TableBorderStyleSolid TableBorderStyle = "SOLID"
)
// Values returns all known values for TableBorderStyle. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (TableBorderStyle) Values() []TableBorderStyle {
return []TableBorderStyle{
"NONE",
"SOLID",
}
}
type TableCellImageScalingConfiguration string
// Enum values for TableCellImageScalingConfiguration
const (
TableCellImageScalingConfigurationFitToCellHeight TableCellImageScalingConfiguration = "FIT_TO_CELL_HEIGHT"
TableCellImageScalingConfigurationFitToCellWidth TableCellImageScalingConfiguration = "FIT_TO_CELL_WIDTH"
TableCellImageScalingConfigurationDoNotScale TableCellImageScalingConfiguration = "DO_NOT_SCALE"
)
// Values returns all known values for TableCellImageScalingConfiguration. Note
// that this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (TableCellImageScalingConfiguration) Values() []TableCellImageScalingConfiguration {
return []TableCellImageScalingConfiguration{
"FIT_TO_CELL_HEIGHT",
"FIT_TO_CELL_WIDTH",
"DO_NOT_SCALE",
}
}
type TableFieldIconSetType string
// Enum values for TableFieldIconSetType
const (
TableFieldIconSetTypeLink TableFieldIconSetType = "LINK"
)
// Values returns all known values for TableFieldIconSetType. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (TableFieldIconSetType) Values() []TableFieldIconSetType {
return []TableFieldIconSetType{
"LINK",
}
}
type TableOrientation string
// Enum values for TableOrientation
const (
TableOrientationVertical TableOrientation = "VERTICAL"
TableOrientationHorizontal TableOrientation = "HORIZONTAL"
)
// Values returns all known values for TableOrientation. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (TableOrientation) Values() []TableOrientation {
return []TableOrientation{
"VERTICAL",
"HORIZONTAL",
}
}
type TableTotalsPlacement string
// Enum values for TableTotalsPlacement
const (
TableTotalsPlacementStart TableTotalsPlacement = "START"
TableTotalsPlacementEnd TableTotalsPlacement = "END"
)
// Values returns all known values for TableTotalsPlacement. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (TableTotalsPlacement) Values() []TableTotalsPlacement {
return []TableTotalsPlacement{
"START",
"END",
}
}
type TableTotalsScrollStatus string
// Enum values for TableTotalsScrollStatus
const (
TableTotalsScrollStatusPinned TableTotalsScrollStatus = "PINNED"
TableTotalsScrollStatusScrolled TableTotalsScrollStatus = "SCROLLED"
)
// Values returns all known values for TableTotalsScrollStatus. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (TableTotalsScrollStatus) Values() []TableTotalsScrollStatus {
return []TableTotalsScrollStatus{
"PINNED",
"SCROLLED",
}
}
type TargetVisualOptions string
// Enum values for TargetVisualOptions
const (
TargetVisualOptionsAllVisuals TargetVisualOptions = "ALL_VISUALS"
)
// Values returns all known values for TargetVisualOptions. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (TargetVisualOptions) Values() []TargetVisualOptions {
return []TargetVisualOptions{
"ALL_VISUALS",
}
}
type TemplateErrorType string
// Enum values for TemplateErrorType
const (
TemplateErrorTypeSourceNotFound TemplateErrorType = "SOURCE_NOT_FOUND"
TemplateErrorTypeDataSetNotFound TemplateErrorType = "DATA_SET_NOT_FOUND"
TemplateErrorTypeInternalFailure TemplateErrorType = "INTERNAL_FAILURE"
TemplateErrorTypeAccessDenied TemplateErrorType = "ACCESS_DENIED"
)
// Values returns all known values for TemplateErrorType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (TemplateErrorType) Values() []TemplateErrorType {
return []TemplateErrorType{
"SOURCE_NOT_FOUND",
"DATA_SET_NOT_FOUND",
"INTERNAL_FAILURE",
"ACCESS_DENIED",
}
}
type TextQualifier string
// Enum values for TextQualifier
const (
TextQualifierDoubleQuote TextQualifier = "DOUBLE_QUOTE"
TextQualifierSingleQuote TextQualifier = "SINGLE_QUOTE"
)
// Values returns all known values for TextQualifier. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (TextQualifier) Values() []TextQualifier {
return []TextQualifier{
"DOUBLE_QUOTE",
"SINGLE_QUOTE",
}
}
type TextWrap string
// Enum values for TextWrap
const (
TextWrapNone TextWrap = "NONE"
TextWrapWrap TextWrap = "WRAP"
)
// Values returns all known values for TextWrap. Note that this can be expanded in
// the future, and so it is only as up to date as the client. The ordering of this
// slice is not guaranteed to be stable across updates.
func (TextWrap) Values() []TextWrap {
return []TextWrap{
"NONE",
"WRAP",
}
}
type ThemeErrorType string
// Enum values for ThemeErrorType
const (
ThemeErrorTypeInternalFailure ThemeErrorType = "INTERNAL_FAILURE"
)
// Values returns all known values for ThemeErrorType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (ThemeErrorType) Values() []ThemeErrorType {
return []ThemeErrorType{
"INTERNAL_FAILURE",
}
}
type ThemeType string
// Enum values for ThemeType
const (
ThemeTypeQuicksight ThemeType = "QUICKSIGHT"
ThemeTypeCustom ThemeType = "CUSTOM"
ThemeTypeAll ThemeType = "ALL"
)
// Values returns all known values for ThemeType. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
func (ThemeType) Values() []ThemeType {
return []ThemeType{
"QUICKSIGHT",
"CUSTOM",
"ALL",
}
}
type TimeGranularity string
// Enum values for TimeGranularity
const (
TimeGranularityYear TimeGranularity = "YEAR"
TimeGranularityQuarter TimeGranularity = "QUARTER"
TimeGranularityMonth TimeGranularity = "MONTH"
TimeGranularityWeek TimeGranularity = "WEEK"
TimeGranularityDay TimeGranularity = "DAY"
TimeGranularityHour TimeGranularity = "HOUR"
TimeGranularityMinute TimeGranularity = "MINUTE"
TimeGranularitySecond TimeGranularity = "SECOND"
TimeGranularityMillisecond TimeGranularity = "MILLISECOND"
)
// Values returns all known values for TimeGranularity. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (TimeGranularity) Values() []TimeGranularity {
return []TimeGranularity{
"YEAR",
"QUARTER",
"MONTH",
"WEEK",
"DAY",
"HOUR",
"MINUTE",
"SECOND",
"MILLISECOND",
}
}
type TooltipTitleType string
// Enum values for TooltipTitleType
const (
TooltipTitleTypeNone TooltipTitleType = "NONE"
TooltipTitleTypePrimaryValue TooltipTitleType = "PRIMARY_VALUE"
)
// Values returns all known values for TooltipTitleType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (TooltipTitleType) Values() []TooltipTitleType {
return []TooltipTitleType{
"NONE",
"PRIMARY_VALUE",
}
}
type TopBottomComputationType string
// Enum values for TopBottomComputationType
const (
TopBottomComputationTypeTop TopBottomComputationType = "TOP"
TopBottomComputationTypeBottom TopBottomComputationType = "BOTTOM"
)
// Values returns all known values for TopBottomComputationType. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (TopBottomComputationType) Values() []TopBottomComputationType {
return []TopBottomComputationType{
"TOP",
"BOTTOM",
}
}
type TopBottomSortOrder string
// Enum values for TopBottomSortOrder
const (
TopBottomSortOrderPercentDifference TopBottomSortOrder = "PERCENT_DIFFERENCE"
TopBottomSortOrderAbsoluteDifference TopBottomSortOrder = "ABSOLUTE_DIFFERENCE"
)
// Values returns all known values for TopBottomSortOrder. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (TopBottomSortOrder) Values() []TopBottomSortOrder {
return []TopBottomSortOrder{
"PERCENT_DIFFERENCE",
"ABSOLUTE_DIFFERENCE",
}
}
type TopicNumericSeparatorSymbol string
// Enum values for TopicNumericSeparatorSymbol
const (
TopicNumericSeparatorSymbolComma TopicNumericSeparatorSymbol = "COMMA"
TopicNumericSeparatorSymbolDot TopicNumericSeparatorSymbol = "DOT"
)
// Values returns all known values for TopicNumericSeparatorSymbol. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (TopicNumericSeparatorSymbol) Values() []TopicNumericSeparatorSymbol {
return []TopicNumericSeparatorSymbol{
"COMMA",
"DOT",
}
}
type TopicRefreshStatus string
// Enum values for TopicRefreshStatus
const (
TopicRefreshStatusInitialized TopicRefreshStatus = "INITIALIZED"
TopicRefreshStatusRunning TopicRefreshStatus = "RUNNING"
TopicRefreshStatusFailed TopicRefreshStatus = "FAILED"
TopicRefreshStatusCompleted TopicRefreshStatus = "COMPLETED"
TopicRefreshStatusCancelled TopicRefreshStatus = "CANCELLED"
)
// Values returns all known values for TopicRefreshStatus. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (TopicRefreshStatus) Values() []TopicRefreshStatus {
return []TopicRefreshStatus{
"INITIALIZED",
"RUNNING",
"FAILED",
"COMPLETED",
"CANCELLED",
}
}
type TopicRelativeDateFilterFunction string
// Enum values for TopicRelativeDateFilterFunction
const (
TopicRelativeDateFilterFunctionPrevious TopicRelativeDateFilterFunction = "PREVIOUS"
TopicRelativeDateFilterFunctionThis TopicRelativeDateFilterFunction = "THIS"
TopicRelativeDateFilterFunctionLast TopicRelativeDateFilterFunction = "LAST"
TopicRelativeDateFilterFunctionNext TopicRelativeDateFilterFunction = "NEXT"
TopicRelativeDateFilterFunctionNow TopicRelativeDateFilterFunction = "NOW"
)
// Values returns all known values for TopicRelativeDateFilterFunction. Note that
// this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (TopicRelativeDateFilterFunction) Values() []TopicRelativeDateFilterFunction {
return []TopicRelativeDateFilterFunction{
"PREVIOUS",
"THIS",
"LAST",
"NEXT",
"NOW",
}
}
type TopicScheduleType string
// Enum values for TopicScheduleType
const (
TopicScheduleTypeHourly TopicScheduleType = "HOURLY"
TopicScheduleTypeDaily TopicScheduleType = "DAILY"
TopicScheduleTypeWeekly TopicScheduleType = "WEEKLY"
TopicScheduleTypeMonthly TopicScheduleType = "MONTHLY"
)
// Values returns all known values for TopicScheduleType. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (TopicScheduleType) Values() []TopicScheduleType {
return []TopicScheduleType{
"HOURLY",
"DAILY",
"WEEKLY",
"MONTHLY",
}
}
type TopicTimeGranularity string
// Enum values for TopicTimeGranularity
const (
TopicTimeGranularitySecond TopicTimeGranularity = "SECOND"
TopicTimeGranularityMinute TopicTimeGranularity = "MINUTE"
TopicTimeGranularityHour TopicTimeGranularity = "HOUR"
TopicTimeGranularityDay TopicTimeGranularity = "DAY"
TopicTimeGranularityWeek TopicTimeGranularity = "WEEK"
TopicTimeGranularityMonth TopicTimeGranularity = "MONTH"
TopicTimeGranularityQuarter TopicTimeGranularity = "QUARTER"
TopicTimeGranularityYear TopicTimeGranularity = "YEAR"
)
// Values returns all known values for TopicTimeGranularity. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (TopicTimeGranularity) Values() []TopicTimeGranularity {
return []TopicTimeGranularity{
"SECOND",
"MINUTE",
"HOUR",
"DAY",
"WEEK",
"MONTH",
"QUARTER",
"YEAR",
}
}
type UndefinedSpecifiedValueType string
// Enum values for UndefinedSpecifiedValueType
const (
UndefinedSpecifiedValueTypeLeast UndefinedSpecifiedValueType = "LEAST"
UndefinedSpecifiedValueTypeMost UndefinedSpecifiedValueType = "MOST"
)
// Values returns all known values for UndefinedSpecifiedValueType. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (UndefinedSpecifiedValueType) Values() []UndefinedSpecifiedValueType {
return []UndefinedSpecifiedValueType{
"LEAST",
"MOST",
}
}
type URLTargetConfiguration string
// Enum values for URLTargetConfiguration
const (
URLTargetConfigurationNewTab URLTargetConfiguration = "NEW_TAB"
URLTargetConfigurationNewWindow URLTargetConfiguration = "NEW_WINDOW"
URLTargetConfigurationSameTab URLTargetConfiguration = "SAME_TAB"
)
// Values returns all known values for URLTargetConfiguration. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (URLTargetConfiguration) Values() []URLTargetConfiguration {
return []URLTargetConfiguration{
"NEW_TAB",
"NEW_WINDOW",
"SAME_TAB",
}
}
type UserRole string
// Enum values for UserRole
const (
UserRoleAdmin UserRole = "ADMIN"
UserRoleAuthor UserRole = "AUTHOR"
UserRoleReader UserRole = "READER"
UserRoleRestrictedAuthor UserRole = "RESTRICTED_AUTHOR"
UserRoleRestrictedReader UserRole = "RESTRICTED_READER"
)
// Values returns all known values for UserRole. Note that this can be expanded in
// the future, and so it is only as up to date as the client. The ordering of this
// slice is not guaranteed to be stable across updates.
func (UserRole) Values() []UserRole {
return []UserRole{
"ADMIN",
"AUTHOR",
"READER",
"RESTRICTED_AUTHOR",
"RESTRICTED_READER",
}
}
type ValueWhenUnsetOption string
// Enum values for ValueWhenUnsetOption
const (
ValueWhenUnsetOptionRecommendedValue ValueWhenUnsetOption = "RECOMMENDED_VALUE"
ValueWhenUnsetOptionNull ValueWhenUnsetOption = "NULL"
)
// Values returns all known values for ValueWhenUnsetOption. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (ValueWhenUnsetOption) Values() []ValueWhenUnsetOption {
return []ValueWhenUnsetOption{
"RECOMMENDED_VALUE",
"NULL",
}
}
type VerticalTextAlignment string
// Enum values for VerticalTextAlignment
const (
VerticalTextAlignmentTop VerticalTextAlignment = "TOP"
VerticalTextAlignmentMiddle VerticalTextAlignment = "MIDDLE"
VerticalTextAlignmentBottom VerticalTextAlignment = "BOTTOM"
)
// Values returns all known values for VerticalTextAlignment. Note that this can
// be expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (VerticalTextAlignment) Values() []VerticalTextAlignment {
return []VerticalTextAlignment{
"TOP",
"MIDDLE",
"BOTTOM",
}
}
type Visibility string
// Enum values for Visibility
const (
VisibilityHidden Visibility = "HIDDEN"
VisibilityVisible Visibility = "VISIBLE"
)
// Values returns all known values for Visibility. Note that this can be expanded
// in the future, and so it is only as up to date as the client. The ordering of
// this slice is not guaranteed to be stable across updates.
func (Visibility) Values() []Visibility {
return []Visibility{
"HIDDEN",
"VISIBLE",
}
}
type VisualCustomActionTrigger string
// Enum values for VisualCustomActionTrigger
const (
VisualCustomActionTriggerDataPointClick VisualCustomActionTrigger = "DATA_POINT_CLICK"
VisualCustomActionTriggerDataPointMenu VisualCustomActionTrigger = "DATA_POINT_MENU"
)
// Values returns all known values for VisualCustomActionTrigger. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (VisualCustomActionTrigger) Values() []VisualCustomActionTrigger {
return []VisualCustomActionTrigger{
"DATA_POINT_CLICK",
"DATA_POINT_MENU",
}
}
type VPCConnectionAvailabilityStatus string
// Enum values for VPCConnectionAvailabilityStatus
const (
VPCConnectionAvailabilityStatusAvailable VPCConnectionAvailabilityStatus = "AVAILABLE"
VPCConnectionAvailabilityStatusUnavailable VPCConnectionAvailabilityStatus = "UNAVAILABLE"
VPCConnectionAvailabilityStatusPartiallyAvailable VPCConnectionAvailabilityStatus = "PARTIALLY_AVAILABLE"
)
// Values returns all known values for VPCConnectionAvailabilityStatus. Note that
// this can be expanded in the future, and so it is only as up to date as the
// client. The ordering of this slice is not guaranteed to be stable across
// updates.
func (VPCConnectionAvailabilityStatus) Values() []VPCConnectionAvailabilityStatus {
return []VPCConnectionAvailabilityStatus{
"AVAILABLE",
"UNAVAILABLE",
"PARTIALLY_AVAILABLE",
}
}
type VPCConnectionResourceStatus string
// Enum values for VPCConnectionResourceStatus
const (
VPCConnectionResourceStatusCreationInProgress VPCConnectionResourceStatus = "CREATION_IN_PROGRESS"
VPCConnectionResourceStatusCreationSuccessful VPCConnectionResourceStatus = "CREATION_SUCCESSFUL"
VPCConnectionResourceStatusCreationFailed VPCConnectionResourceStatus = "CREATION_FAILED"
VPCConnectionResourceStatusUpdateInProgress VPCConnectionResourceStatus = "UPDATE_IN_PROGRESS"
VPCConnectionResourceStatusUpdateSuccessful VPCConnectionResourceStatus = "UPDATE_SUCCESSFUL"
VPCConnectionResourceStatusUpdateFailed VPCConnectionResourceStatus = "UPDATE_FAILED"
VPCConnectionResourceStatusDeletionInProgress VPCConnectionResourceStatus = "DELETION_IN_PROGRESS"
VPCConnectionResourceStatusDeletionFailed VPCConnectionResourceStatus = "DELETION_FAILED"
VPCConnectionResourceStatusDeleted VPCConnectionResourceStatus = "DELETED"
)
// Values returns all known values for VPCConnectionResourceStatus. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (VPCConnectionResourceStatus) Values() []VPCConnectionResourceStatus {
return []VPCConnectionResourceStatus{
"CREATION_IN_PROGRESS",
"CREATION_SUCCESSFUL",
"CREATION_FAILED",
"UPDATE_IN_PROGRESS",
"UPDATE_SUCCESSFUL",
"UPDATE_FAILED",
"DELETION_IN_PROGRESS",
"DELETION_FAILED",
"DELETED",
}
}
type WidgetStatus string
// Enum values for WidgetStatus
const (
WidgetStatusEnabled WidgetStatus = "ENABLED"
WidgetStatusDisabled WidgetStatus = "DISABLED"
)
// Values returns all known values for WidgetStatus. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (WidgetStatus) Values() []WidgetStatus {
return []WidgetStatus{
"ENABLED",
"DISABLED",
}
}
type WordCloudCloudLayout string
// Enum values for WordCloudCloudLayout
const (
WordCloudCloudLayoutFluid WordCloudCloudLayout = "FLUID"
WordCloudCloudLayoutNormal WordCloudCloudLayout = "NORMAL"
)
// Values returns all known values for WordCloudCloudLayout. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (WordCloudCloudLayout) Values() []WordCloudCloudLayout {
return []WordCloudCloudLayout{
"FLUID",
"NORMAL",
}
}
type WordCloudWordCasing string
// Enum values for WordCloudWordCasing
const (
WordCloudWordCasingLowerCase WordCloudWordCasing = "LOWER_CASE"
WordCloudWordCasingExistingCase WordCloudWordCasing = "EXISTING_CASE"
)
// Values returns all known values for WordCloudWordCasing. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (WordCloudWordCasing) Values() []WordCloudWordCasing {
return []WordCloudWordCasing{
"LOWER_CASE",
"EXISTING_CASE",
}
}
type WordCloudWordOrientation string
// Enum values for WordCloudWordOrientation
const (
WordCloudWordOrientationHorizontal WordCloudWordOrientation = "HORIZONTAL"
WordCloudWordOrientationHorizontalAndVertical WordCloudWordOrientation = "HORIZONTAL_AND_VERTICAL"
)
// Values returns all known values for WordCloudWordOrientation. Note that this
// can be expanded in the future, and so it is only as up to date as the client.
// The ordering of this slice is not guaranteed to be stable across updates.
func (WordCloudWordOrientation) Values() []WordCloudWordOrientation {
return []WordCloudWordOrientation{
"HORIZONTAL",
"HORIZONTAL_AND_VERTICAL",
}
}
type WordCloudWordPadding string
// Enum values for WordCloudWordPadding
const (
WordCloudWordPaddingNone WordCloudWordPadding = "NONE"
WordCloudWordPaddingSmall WordCloudWordPadding = "SMALL"
WordCloudWordPaddingMedium WordCloudWordPadding = "MEDIUM"
WordCloudWordPaddingLarge WordCloudWordPadding = "LARGE"
)
// Values returns all known values for WordCloudWordPadding. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (WordCloudWordPadding) Values() []WordCloudWordPadding {
return []WordCloudWordPadding{
"NONE",
"SMALL",
"MEDIUM",
"LARGE",
}
}
type WordCloudWordScaling string
// Enum values for WordCloudWordScaling
const (
WordCloudWordScalingEmphasize WordCloudWordScaling = "EMPHASIZE"
WordCloudWordScalingNormal WordCloudWordScaling = "NORMAL"
)
// Values returns all known values for WordCloudWordScaling. Note that this can be
// expanded in the future, and so it is only as up to date as the client. The
// ordering of this slice is not guaranteed to be stable across updates.
func (WordCloudWordScaling) Values() []WordCloudWordScaling {
return []WordCloudWordScaling{
"EMPHASIZE",
"NORMAL",
}
}
| 4,104 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
"fmt"
smithy "github.com/aws/smithy-go"
)
// You don't have access to this item. The provided credentials couldn't be
// validated. You might not be authorized to carry out the request. Make sure that
// your account is authorized to use the Amazon QuickSight service, that your
// policies have the correct permissions, and that you are using the correct
// credentials.
type AccessDeniedException struct {
Message *string
ErrorCodeOverride *string
RequestId *string
noSmithyDocumentSerde
}
func (e *AccessDeniedException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *AccessDeniedException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *AccessDeniedException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "AccessDeniedException"
}
return *e.ErrorCodeOverride
}
func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// A resource is already in a state that indicates an operation is happening that
// must complete before a new update can be applied.
type ConcurrentUpdatingException struct {
Message *string
ErrorCodeOverride *string
RequestId *string
noSmithyDocumentSerde
}
func (e *ConcurrentUpdatingException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *ConcurrentUpdatingException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *ConcurrentUpdatingException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "ConcurrentUpdatingException"
}
return *e.ErrorCodeOverride
}
func (e *ConcurrentUpdatingException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer }
// Updating or deleting a resource can cause an inconsistent state.
type ConflictException struct {
Message *string
ErrorCodeOverride *string
RequestId *string
noSmithyDocumentSerde
}
func (e *ConflictException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *ConflictException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *ConflictException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "ConflictException"
}
return *e.ErrorCodeOverride
}
func (e *ConflictException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// The domain specified isn't on the allow list. All domains for embedded
// dashboards must be added to the approved list by an Amazon QuickSight admin.
type DomainNotWhitelistedException struct {
Message *string
ErrorCodeOverride *string
RequestId *string
noSmithyDocumentSerde
}
func (e *DomainNotWhitelistedException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *DomainNotWhitelistedException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *DomainNotWhitelistedException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "DomainNotWhitelistedException"
}
return *e.ErrorCodeOverride
}
func (e *DomainNotWhitelistedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// The identity type specified isn't supported. Supported identity types include
// IAM and QUICKSIGHT .
type IdentityTypeNotSupportedException struct {
Message *string
ErrorCodeOverride *string
RequestId *string
noSmithyDocumentSerde
}
func (e *IdentityTypeNotSupportedException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *IdentityTypeNotSupportedException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *IdentityTypeNotSupportedException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "IdentityTypeNotSupportedException"
}
return *e.ErrorCodeOverride
}
func (e *IdentityTypeNotSupportedException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// An internal failure occurred.
type InternalFailureException struct {
Message *string
ErrorCodeOverride *string
RequestId *string
noSmithyDocumentSerde
}
func (e *InternalFailureException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *InternalFailureException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *InternalFailureException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "InternalFailureException"
}
return *e.ErrorCodeOverride
}
func (e *InternalFailureException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer }
// The NextToken value isn't valid.
type InvalidNextTokenException struct {
Message *string
ErrorCodeOverride *string
RequestId *string
noSmithyDocumentSerde
}
func (e *InvalidNextTokenException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *InvalidNextTokenException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *InvalidNextTokenException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "InvalidNextTokenException"
}
return *e.ErrorCodeOverride
}
func (e *InvalidNextTokenException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// One or more parameters has a value that isn't valid.
type InvalidParameterValueException struct {
Message *string
ErrorCodeOverride *string
RequestId *string
noSmithyDocumentSerde
}
func (e *InvalidParameterValueException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *InvalidParameterValueException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *InvalidParameterValueException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "InvalidParameterValueException"
}
return *e.ErrorCodeOverride
}
func (e *InvalidParameterValueException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// You don't have this feature activated for your account. To fix this issue,
// contact Amazon Web Services support.
type InvalidRequestException struct {
Message *string
ErrorCodeOverride *string
RequestId *string
noSmithyDocumentSerde
}
func (e *InvalidRequestException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *InvalidRequestException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *InvalidRequestException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "InvalidRequestException"
}
return *e.ErrorCodeOverride
}
func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// A limit is exceeded.
type LimitExceededException struct {
Message *string
ErrorCodeOverride *string
ResourceType ExceptionResourceType
RequestId *string
noSmithyDocumentSerde
}
func (e *LimitExceededException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *LimitExceededException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *LimitExceededException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "LimitExceededException"
}
return *e.ErrorCodeOverride
}
func (e *LimitExceededException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// One or more preconditions aren't met.
type PreconditionNotMetException struct {
Message *string
ErrorCodeOverride *string
RequestId *string
noSmithyDocumentSerde
}
func (e *PreconditionNotMetException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *PreconditionNotMetException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *PreconditionNotMetException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "PreconditionNotMetException"
}
return *e.ErrorCodeOverride
}
func (e *PreconditionNotMetException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// The user with the provided name isn't found. This error can happen in any
// operation that requires finding a user based on a provided user name, such as
// DeleteUser , DescribeUser , and so on.
type QuickSightUserNotFoundException struct {
Message *string
ErrorCodeOverride *string
RequestId *string
noSmithyDocumentSerde
}
func (e *QuickSightUserNotFoundException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *QuickSightUserNotFoundException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *QuickSightUserNotFoundException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "QuickSightUserNotFoundException"
}
return *e.ErrorCodeOverride
}
func (e *QuickSightUserNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// The resource specified already exists.
type ResourceExistsException struct {
Message *string
ErrorCodeOverride *string
ResourceType ExceptionResourceType
RequestId *string
noSmithyDocumentSerde
}
func (e *ResourceExistsException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *ResourceExistsException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *ResourceExistsException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "ResourceExistsException"
}
return *e.ErrorCodeOverride
}
func (e *ResourceExistsException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// One or more resources can't be found.
type ResourceNotFoundException struct {
Message *string
ErrorCodeOverride *string
ResourceType ExceptionResourceType
RequestId *string
noSmithyDocumentSerde
}
func (e *ResourceNotFoundException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *ResourceNotFoundException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *ResourceNotFoundException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "ResourceNotFoundException"
}
return *e.ErrorCodeOverride
}
func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// This resource is currently unavailable.
type ResourceUnavailableException struct {
Message *string
ErrorCodeOverride *string
ResourceType ExceptionResourceType
RequestId *string
noSmithyDocumentSerde
}
func (e *ResourceUnavailableException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *ResourceUnavailableException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *ResourceUnavailableException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "ResourceUnavailableException"
}
return *e.ErrorCodeOverride
}
func (e *ResourceUnavailableException) ErrorFault() smithy.ErrorFault { return smithy.FaultServer }
// The number of minutes specified for the lifetime of a session isn't valid. The
// session lifetime must be 15-600 minutes.
type SessionLifetimeInMinutesInvalidException struct {
Message *string
ErrorCodeOverride *string
RequestId *string
noSmithyDocumentSerde
}
func (e *SessionLifetimeInMinutesInvalidException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *SessionLifetimeInMinutesInvalidException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *SessionLifetimeInMinutesInvalidException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "SessionLifetimeInMinutesInvalidException"
}
return *e.ErrorCodeOverride
}
func (e *SessionLifetimeInMinutesInvalidException) ErrorFault() smithy.ErrorFault {
return smithy.FaultClient
}
// Access is throttled.
type ThrottlingException struct {
Message *string
ErrorCodeOverride *string
RequestId *string
noSmithyDocumentSerde
}
func (e *ThrottlingException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *ThrottlingException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *ThrottlingException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "ThrottlingException"
}
return *e.ErrorCodeOverride
}
func (e *ThrottlingException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// This error indicates that you are calling an embedding operation in Amazon
// QuickSight without the required pricing plan on your Amazon Web Services
// account. Before you can use embedding for anonymous users, a QuickSight
// administrator needs to add capacity pricing to Amazon QuickSight. You can do
// this on the Manage Amazon QuickSight page. After capacity pricing is added, you
// can use the GetDashboardEmbedUrl (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html)
// API operation with the --identity-type ANONYMOUS option.
type UnsupportedPricingPlanException struct {
Message *string
ErrorCodeOverride *string
RequestId *string
noSmithyDocumentSerde
}
func (e *UnsupportedPricingPlanException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *UnsupportedPricingPlanException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *UnsupportedPricingPlanException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "UnsupportedPricingPlanException"
}
return *e.ErrorCodeOverride
}
func (e *UnsupportedPricingPlanException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
// This error indicates that you are calling an operation on an Amazon QuickSight
// subscription where the edition doesn't include support for that operation.
// Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition.
// Not every operation and capability is available in every edition.
type UnsupportedUserEditionException struct {
Message *string
ErrorCodeOverride *string
RequestId *string
noSmithyDocumentSerde
}
func (e *UnsupportedUserEditionException) Error() string {
return fmt.Sprintf("%s: %s", e.ErrorCode(), e.ErrorMessage())
}
func (e *UnsupportedUserEditionException) ErrorMessage() string {
if e.Message == nil {
return ""
}
return *e.Message
}
func (e *UnsupportedUserEditionException) ErrorCode() string {
if e == nil || e.ErrorCodeOverride == nil {
return "UnsupportedUserEditionException"
}
return *e.ErrorCodeOverride
}
func (e *UnsupportedUserEditionException) ErrorFault() smithy.ErrorFault { return smithy.FaultClient }
| 567 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// The Amazon QuickSight customizations associated with your Amazon Web Services
// account or a QuickSight namespace in a specific Amazon Web Services Region.
type AccountCustomization struct {
// The default email customization template.
DefaultEmailCustomizationTemplate *string
// The default theme for this Amazon QuickSight subscription.
DefaultTheme *string
noSmithyDocumentSerde
}
// A structure that contains the following account information elements:
// - Your Amazon QuickSight account name.
// - The edition of Amazon QuickSight that your account is using.
// - The notification email address that is associated with the Amazon
// QuickSight account.
// - The authentication type of the Amazon QuickSight account.
// - The status of the Amazon QuickSight account's subscription.
type AccountInfo struct {
// The account name that you provided for the Amazon QuickSight subscription in
// your Amazon Web Services account. You create this name when you sign up for
// Amazon QuickSight. It's unique over all of Amazon Web Services, and it appears
// only when users sign in.
AccountName *string
// The status of your account subscription.
AccountSubscriptionStatus *string
// The way that your Amazon QuickSight account is authenticated.
AuthenticationType *string
// The edition of your Amazon QuickSight account.
Edition Edition
// The email address that will be used for Amazon QuickSight to send notifications
// regarding your Amazon Web Services account or Amazon QuickSight subscription.
NotificationEmail *string
noSmithyDocumentSerde
}
// The Amazon QuickSight settings associated with your Amazon Web Services account.
type AccountSettings struct {
// The "account name" you provided for the Amazon QuickSight subscription in your
// Amazon Web Services account. You create this name when you sign up for Amazon
// QuickSight. It is unique in all of Amazon Web Services and it appears only when
// users sign in.
AccountName *string
// The default Amazon QuickSight namespace for your Amazon Web Services account.
DefaultNamespace *string
// The edition of Amazon QuickSight that you're currently subscribed to:
// Enterprise edition or Standard edition.
Edition Edition
// The main notification email for your Amazon QuickSight subscription.
NotificationEmail *string
// A Boolean value that indicates whether public sharing is turned on for an
// Amazon QuickSight account. For more information about turning on public sharing,
// see UpdatePublicSharingSettings (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdatePublicSharingSettings.html)
// .
PublicSharingEnabled bool
// A boolean value that determines whether or not an Amazon QuickSight account can
// be deleted. A True value doesn't allow the account to be deleted and results in
// an error message if a user tries to make a DeleteAccountSubsctiption request. A
// False value will allow the ccount to be deleted.
TerminationProtectionEnabled bool
noSmithyDocumentSerde
}
// The active Identity and Access Management (IAM) policy assignment.
type ActiveIAMPolicyAssignment struct {
// A name for the IAM policy assignment.
AssignmentName *string
// The Amazon Resource Name (ARN) of the resource.
PolicyArn *string
noSmithyDocumentSerde
}
// An ad hoc (one-time) filtering option.
type AdHocFilteringOption struct {
// Availability status.
AvailabilityStatus DashboardBehavior
noSmithyDocumentSerde
}
// An aggregation function aggregates values from a dimension or measure. This is
// a union type structure. For this structure to be valid, only one of the
// attributes can be defined.
type AggregationFunction struct {
// Aggregation for categorical values.
// - COUNT : Aggregate by the total number of values, including duplicates.
// - DISTINCT_COUNT : Aggregate by the total number of distinct values.
CategoricalAggregationFunction CategoricalAggregationFunction
// Aggregation for date values.
// - COUNT : Aggregate by the total number of values, including duplicates.
// - DISTINCT_COUNT : Aggregate by the total number of distinct values.
// - MIN : Select the smallest date value.
// - MAX : Select the largest date value.
DateAggregationFunction DateAggregationFunction
// Aggregation for numerical values.
NumericalAggregationFunction *NumericalAggregationFunction
noSmithyDocumentSerde
}
// The configuration options to sort aggregated values.
type AggregationSortConfiguration struct {
// The function that aggregates the values in Column .
//
// This member is required.
AggregationFunction *AggregationFunction
// The column that determines the sort order of aggregated values.
//
// This member is required.
Column *ColumnIdentifier
// The sort direction of values.
// - ASC : Sort in ascending order.
// - DESC : Sort in descending order.
//
// This member is required.
SortDirection SortDirection
noSmithyDocumentSerde
}
// The parameters for OpenSearch.
type AmazonElasticsearchParameters struct {
// The OpenSearch domain.
//
// This member is required.
Domain *string
noSmithyDocumentSerde
}
// The parameters for OpenSearch.
type AmazonOpenSearchParameters struct {
// The OpenSearch domain.
//
// This member is required.
Domain *string
noSmithyDocumentSerde
}
// Metadata structure for an analysis in Amazon QuickSight
type Analysis struct {
// The ID of the analysis.
AnalysisId *string
// The Amazon Resource Name (ARN) of the analysis.
Arn *string
// The time that the analysis was created.
CreatedTime *time.Time
// The ARNs of the datasets of the analysis.
DataSetArns []string
// Errors associated with the analysis.
Errors []AnalysisError
// The time that the analysis was last updated.
LastUpdatedTime *time.Time
// The descriptive name of the analysis.
Name *string
// A list of the associated sheets with the unique identifier and name of each
// sheet.
Sheets []Sheet
// Status associated with the analysis.
Status ResourceStatus
// The ARN of the theme of the analysis.
ThemeArn *string
noSmithyDocumentSerde
}
// The configuration for default analysis settings.
type AnalysisDefaults struct {
// The configuration for default new sheet settings.
//
// This member is required.
DefaultNewSheetConfiguration *DefaultNewSheetConfiguration
noSmithyDocumentSerde
}
// The definition of an analysis.
type AnalysisDefinition struct {
// An array of dataset identifier declarations. This mapping allows the usage of
// dataset identifiers instead of dataset ARNs throughout analysis sub-structures.
//
// This member is required.
DataSetIdentifierDeclarations []DataSetIdentifierDeclaration
// The configuration for default analysis settings.
AnalysisDefaults *AnalysisDefaults
// An array of calculated field definitions for the analysis.
CalculatedFields []CalculatedField
// An array of analysis-level column configurations. Column configurations can be
// used to set default formatting for a column to be used throughout an analysis.
ColumnConfigurations []ColumnConfiguration
// Filter definitions for an analysis. For more information, see Filtering Data in
// Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html)
// in the Amazon QuickSight User Guide.
FilterGroups []FilterGroup
// An array of parameter declarations for an analysis. Parameters are named
// variables that can transfer a value for use by an action or an object. For more
// information, see Parameters in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html)
// in the Amazon QuickSight User Guide.
ParameterDeclarations []ParameterDeclaration
// An array of sheet definitions for an analysis. Each SheetDefinition provides
// detailed information about a sheet within this analysis.
Sheets []SheetDefinition
noSmithyDocumentSerde
}
// Analysis error.
type AnalysisError struct {
// The message associated with the analysis error.
Message *string
// The type of the analysis error.
Type AnalysisErrorType
// Lists the violated entities that caused the analysis error
ViolatedEntities []Entity
noSmithyDocumentSerde
}
// A filter that you apply when searching for one or more analyses.
type AnalysisSearchFilter struct {
// The name of the value that you want to use as a filter, for example "Name":
// "QUICKSIGHT_OWNER" . Valid values are defined as follows:
// - QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any
// analyses with that ARN listed as one of the analysis' owners or viewers are
// returned. Implicit permissions from folders or groups are considered.
// - QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any analyses with
// that ARN listed as one of the owners of the analyses are returned. Implicit
// permissions from folders or groups are considered.
// - DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any
// analyses with that ARN listed as the only owner of the analysis are returned.
// Implicit permissions from folders or groups are not considered.
// - DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any
// analyses with that ARN listed as one of the owners of the analyses are returned.
// Implicit permissions from folders or groups are not considered.
// - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and
// any analyses with that ARN listed as one of the owners or viewers of the
// analyses are returned. Implicit permissions from folders or groups are not
// considered.
// - ANALYSIS_NAME : Any analyses whose names have a substring match to this
// value will be returned.
Name AnalysisFilterAttribute
// The comparison operator that you want to use as a filter, for example
// "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
// If you set the operator value to "StringEquals" , you need to provide an
// ownership related filter in the "NAME" field and the arn of the user or group
// whose folders you want to search in the "Value" field. For example,
// "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value":
// "arn:aws:quicksight:us-east-1:1:user/default/UserName1" . If you set the value
// to "StringLike" , you need to provide the name of the folders you are searching
// for. For example, "Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value":
// "Test" . The "StringLike" operator only supports the NAME value ANALYSIS_NAME .
Operator FilterOperator
// The value of the named item, in this case QUICKSIGHT_USER , that you want to use
// as a filter, for example "Value" . An example is
// "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
Value *string
noSmithyDocumentSerde
}
// The source entity of an analysis.
type AnalysisSourceEntity struct {
// The source template for the source entity of the analysis.
SourceTemplate *AnalysisSourceTemplate
noSmithyDocumentSerde
}
// The source template of an analysis.
type AnalysisSourceTemplate struct {
// The Amazon Resource Name (ARN) of the source template of an analysis.
//
// This member is required.
Arn *string
// The dataset references of the source template of an analysis.
//
// This member is required.
DataSetReferences []DataSetReference
noSmithyDocumentSerde
}
// The summary metadata that describes an analysis.
type AnalysisSummary struct {
// The ID of the analysis. This ID displays in the URL.
AnalysisId *string
// The Amazon Resource Name (ARN) for the analysis.
Arn *string
// The time that the analysis was created.
CreatedTime *time.Time
// The time that the analysis was last updated.
LastUpdatedTime *time.Time
// The name of the analysis. This name is displayed in the Amazon QuickSight
// console.
Name *string
// The last known status for the analysis.
Status ResourceStatus
noSmithyDocumentSerde
}
// The date configuration of the filter.
type AnchorDateConfiguration struct {
// The options for the date configuration. Choose one of the options below:
// - NOW
AnchorOption AnchorOption
// The name of the parameter that is used for the anchor date configuration.
ParameterName *string
noSmithyDocumentSerde
}
// Information about the dashboard that you want to embed.
type AnonymousUserDashboardEmbeddingConfiguration struct {
// The dashboard ID for the dashboard that you want the user to see first. This ID
// is included in the output URL. When the URL in response is accessed, Amazon
// QuickSight renders this dashboard. The Amazon Resource Name (ARN) of this
// dashboard must be included in the AuthorizedResourceArns parameter. Otherwise,
// the request will fail with InvalidParameterValueException .
//
// This member is required.
InitialDashboardId *string
noSmithyDocumentSerde
}
// The experience that you are embedding. You can use this object to generate a
// url that embeds a visual into your application.
type AnonymousUserDashboardVisualEmbeddingConfiguration struct {
// The visual ID for the visual that you want the user to see. This ID is included
// in the output URL. When the URL in response is accessed, Amazon QuickSight
// renders this visual. The Amazon Resource Name (ARN) of the dashboard that the
// visual belongs to must be included in the AuthorizedResourceArns parameter.
// Otherwise, the request will fail with InvalidParameterValueException .
//
// This member is required.
InitialDashboardVisualId *DashboardVisualId
noSmithyDocumentSerde
}
// The type of experience you want to embed. For anonymous users, you can embed
// Amazon QuickSight dashboards.
type AnonymousUserEmbeddingExperienceConfiguration struct {
// The type of embedding experience. In this case, Amazon QuickSight dashboards.
Dashboard *AnonymousUserDashboardEmbeddingConfiguration
// The type of embedding experience. In this case, Amazon QuickSight visuals.
DashboardVisual *AnonymousUserDashboardVisualEmbeddingConfiguration
// The Q search bar that you want to use for anonymous user embedding.
QSearchBar *AnonymousUserQSearchBarEmbeddingConfiguration
noSmithyDocumentSerde
}
// The settings that you want to use with the Q search bar.
type AnonymousUserQSearchBarEmbeddingConfiguration struct {
// The QuickSight Q topic ID of the topic that you want the anonymous user to see
// first. This ID is included in the output URL. When the URL in response is
// accessed, Amazon QuickSight renders the Q search bar with this topic
// pre-selected. The Amazon Resource Name (ARN) of this Q topic must be included in
// the AuthorizedResourceArns parameter. Otherwise, the request will fail with
// InvalidParameterValueException .
//
// This member is required.
InitialTopicId *string
noSmithyDocumentSerde
}
// The arc axis configuration of a GaugeChartVisual .
type ArcAxisConfiguration struct {
// The arc axis range of a GaugeChartVisual .
Range *ArcAxisDisplayRange
// The reserved range of the arc axis.
ReserveRange int32
noSmithyDocumentSerde
}
// The arc axis range of a GaugeChartVisual .
type ArcAxisDisplayRange struct {
// The maximum value of the arc axis range.
Max *float64
// The minimum value of the arc axis range.
Min *float64
noSmithyDocumentSerde
}
// The arc configuration of a GaugeChartVisual .
type ArcConfiguration struct {
// The option that determines the arc angle of a GaugeChartVisual .
ArcAngle *float64
// The options that determine the arc thickness of a GaugeChartVisual .
ArcThickness ArcThicknessOptions
noSmithyDocumentSerde
}
// The options that determine the arc thickness of a GaugeChartVisual .
type ArcOptions struct {
// The arc thickness of a GaugeChartVisual .
ArcThickness ArcThickness
noSmithyDocumentSerde
}
// An optional collection of CloudFormation property configurations that control
// how the export job is generated.
type AssetBundleCloudFormationOverridePropertyConfiguration struct {
// An optional list of structures that control how Analysis resources are
// parameterized in the returned CloudFormation template.
Analyses []AssetBundleExportJobAnalysisOverrideProperties
// An optional list of structures that control how Dashboard resources are
// parameterized in the returned CloudFormation template.
Dashboards []AssetBundleExportJobDashboardOverrideProperties
// An optional list of structures that control how DataSet resources are
// parameterized in the returned CloudFormation template.
DataSets []AssetBundleExportJobDataSetOverrideProperties
// An optional list of structures that control how DataSource resources are
// parameterized in the returned CloudFormation template.
DataSources []AssetBundleExportJobDataSourceOverrideProperties
// An optional list of structures that control how RefreshSchedule resources are
// parameterized in the returned CloudFormation template.
RefreshSchedules []AssetBundleExportJobRefreshScheduleOverrideProperties
// An optional list of structures that control how resource IDs are parameterized
// in the returned CloudFormation template.
ResourceIdOverrideConfiguration *AssetBundleExportJobResourceIdOverrideConfiguration
// An optional list of structures that control how Theme resources are
// parameterized in the returned CloudFormation template.
Themes []AssetBundleExportJobThemeOverrideProperties
// An optional list of structures that control how VPCConnection resources are
// parameterized in the returned CloudFormation template.
VPCConnections []AssetBundleExportJobVPCConnectionOverrideProperties
noSmithyDocumentSerde
}
// Controls how a specific Analysis resource is parameterized in the returned
// CloudFormation template.
type AssetBundleExportJobAnalysisOverrideProperties struct {
// A list of Analysis resource properties to generate variables for in the
// returned CloudFormation template.
//
// This member is required.
Properties []AssetBundleExportJobAnalysisPropertyToOverride
// The ARN of the specific Analysis resource whose override properties are
// configured in this structure.
Arn *string
noSmithyDocumentSerde
}
// Controls how a specific Dashboard resource is parameterized in the returned
// CloudFormation template.
type AssetBundleExportJobDashboardOverrideProperties struct {
// A list of Dashboard resource properties to generate variables for in the
// returned CloudFormation template.
//
// This member is required.
Properties []AssetBundleExportJobDashboardPropertyToOverride
// The ARN of the specific Dashboard resource whose override properties are
// configured in this structure.
Arn *string
noSmithyDocumentSerde
}
// Controls how a specific DataSet resource is parameterized in the returned
// CloudFormation template.
type AssetBundleExportJobDataSetOverrideProperties struct {
// A list of DataSet resource properties to generate variables for in the returned
// CloudFormation template.
//
// This member is required.
Properties []AssetBundleExportJobDataSetPropertyToOverride
// The ARN of the specific DataSet resource whose override properties are
// configured in this structure.
Arn *string
noSmithyDocumentSerde
}
// Controls how a specific DataSource resource is parameterized in the returned
// CloudFormation template.
type AssetBundleExportJobDataSourceOverrideProperties struct {
// A list of DataSource resource properties to generate variables for in the
// returned CloudFormation template.
//
// This member is required.
Properties []AssetBundleExportJobDataSourcePropertyToOverride
// The ARN of the specific DataSource resource whose override properties are
// configured in this structure.
Arn *string
noSmithyDocumentSerde
}
// Describes an error that occurred during an Asset Bundle export job.
type AssetBundleExportJobError struct {
// The ARN of the resource whose processing caused an error.
Arn *string
// A description of the error.
Message *string
// The specific error type of the error that occurred.
Type *string
noSmithyDocumentSerde
}
// Controls how a specific RefreshSchedule resource is parameterized in the
// returned CloudFormation template.
type AssetBundleExportJobRefreshScheduleOverrideProperties struct {
// A list of RefreshSchedule resource properties to generate variables for in the
// returned CloudFormation template.
//
// This member is required.
Properties []AssetBundleExportJobRefreshSchedulePropertyToOverride
// The ARN of the specific RefreshSchedule resource whose override properties are
// configured in this structure.
Arn *string
noSmithyDocumentSerde
}
// An optional structure that configures resource ID overrides for the export job.
type AssetBundleExportJobResourceIdOverrideConfiguration struct {
// An option to request a CloudFormation variable for a prefix to be prepended to
// each resource's ID before import. The prefix is only added to the asset IDs and
// does not change the name of the asset.
PrefixForAllResources bool
noSmithyDocumentSerde
}
// A summary of the export job that includes details of the job's configuration
// and its current status.
type AssetBundleExportJobSummary struct {
// The ARN of the export job.
Arn *string
// The ID of the export job.
AssetBundleExportJobId *string
// The time that the export job was created.
CreatedTime *time.Time
// The format for the export job.
ExportFormat AssetBundleExportFormat
// The flag that determines the inclusion of resource dependencies in the returned
// asset bundle.
IncludeAllDependencies bool
// The current status of the export job.
JobStatus AssetBundleExportJobStatus
noSmithyDocumentSerde
}
// Controls how a specific Theme resource is parameterized in the returned
// CloudFormation template.
type AssetBundleExportJobThemeOverrideProperties struct {
// A list of Theme resource properties to generate variables for in the returned
// CloudFormation template.
//
// This member is required.
Properties []AssetBundleExportJobThemePropertyToOverride
// The ARN of the specific Theme resource whose override properties are configured
// in this structure.
Arn *string
noSmithyDocumentSerde
}
// Controls how a specific VPCConnection resource is parameterized in the
// outputted CloudFormation template.
type AssetBundleExportJobVPCConnectionOverrideProperties struct {
// A list of VPCConnection resource properties to generate variables for in the
// returned CloudFormation template.
//
// This member is required.
Properties []AssetBundleExportJobVPCConnectionPropertyToOverride
// The ARN of the specific VPCConnection resource whose override properties are
// configured in this structure.
Arn *string
noSmithyDocumentSerde
}
// The override parameters for a single analysis that is being imported.
type AssetBundleImportJobAnalysisOverrideParameters struct {
// The ID of the analysis that you ant to apply overrides to.
//
// This member is required.
AnalysisId *string
// A new name for the analysis.
Name *string
noSmithyDocumentSerde
}
// The override parameters for a single dashboard that is being imported.
type AssetBundleImportJobDashboardOverrideParameters struct {
// The ID of the dashboard that you want to apply overrides to.
//
// This member is required.
DashboardId *string
// A new name for the dashboard.
Name *string
noSmithyDocumentSerde
}
// The override parameters for a single dataset that is being imported.
type AssetBundleImportJobDataSetOverrideParameters struct {
// The ID of the dataset to apply overrides to.
//
// This member is required.
DataSetId *string
// A new name for the dataset.
Name *string
noSmithyDocumentSerde
}
// A username and password credential pair to use to import a data source resource.
type AssetBundleImportJobDataSourceCredentialPair struct {
// The password for the data source connection.
//
// This member is required.
Password *string
// The username for the data source connection.
//
// This member is required.
Username *string
noSmithyDocumentSerde
}
// The login credentials to use to import a data source resource.
type AssetBundleImportJobDataSourceCredentials struct {
// A username and password credential pair to be used to create the imported data
// source. Keep this field blank if you are using a Secrets Manager secret to
// provide credentials.
CredentialPair *AssetBundleImportJobDataSourceCredentialPair
// The ARN of the Secrets Manager secret that's used to create the imported data
// source. Keep this field blank, unless you are using a secret in place of a
// credential pair.
SecretArn *string
noSmithyDocumentSerde
}
// The override parameters for a single data source that is being imported.
type AssetBundleImportJobDataSourceOverrideParameters struct {
// The ID of the data source to apply overrides to.
//
// This member is required.
DataSourceId *string
// An optional structure that provides the credentials to be used to create the
// imported data source.
Credentials *AssetBundleImportJobDataSourceCredentials
// The parameters that Amazon QuickSight uses to connect to your underlying data
// source. This is a variant type structure. For this structure to be valid, only
// one of the attributes can be non-null.
DataSourceParameters DataSourceParameters
// A new name for the data source.
Name *string
// Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects
// to your underlying data source.
SslProperties *SslProperties
// VPC connection properties.
VpcConnectionProperties *VpcConnectionProperties
noSmithyDocumentSerde
}
// Describes an error that occurred within an Asset Bundle import execution.
type AssetBundleImportJobError struct {
// The ARN of the resource whose processing caused an error.
Arn *string
// A description of the error.
Message *string
// The specific error type or the error that occurred.
Type *string
noSmithyDocumentSerde
}
// A list of overrides that modify the asset bundle resource configuration before
// the resource is imported.
type AssetBundleImportJobOverrideParameters struct {
// A list of overrides for any Analysis resources that are present in the asset
// bundle that is imported.
Analyses []AssetBundleImportJobAnalysisOverrideParameters
// A list of overrides for any Dashboard resources that are present in the asset
// bundle that is imported.
Dashboards []AssetBundleImportJobDashboardOverrideParameters
// A list of overrides for any DataSet resources that are present in the asset
// bundle that is imported.
DataSets []AssetBundleImportJobDataSetOverrideParameters
// A list of overrides for any DataSource resources that are present in the asset
// bundle that is imported.
DataSources []AssetBundleImportJobDataSourceOverrideParameters
// A list of overrides for any RefreshSchedule resources that are present in the
// asset bundle that is imported.
RefreshSchedules []AssetBundleImportJobRefreshScheduleOverrideParameters
// An optional structure that configures resource ID overrides to be applied
// within the import job.
ResourceIdOverrideConfiguration *AssetBundleImportJobResourceIdOverrideConfiguration
// A list of overrides for any Theme resources that are present in the asset
// bundle that is imported.
Themes []AssetBundleImportJobThemeOverrideParameters
// A list of overrides for any VPCConnection resources that are present in the
// asset bundle that is imported.
VPCConnections []AssetBundleImportJobVPCConnectionOverrideParameters
noSmithyDocumentSerde
}
// A list of overrides for a specific RefreshsSchedule resource that is present in
// the asset bundle that is imported.
type AssetBundleImportJobRefreshScheduleOverrideParameters struct {
// A partial identifier for the specific RefreshSchedule resource that is being
// overridden. This structure is used together with the ScheduleID structure.
//
// This member is required.
DataSetId *string
// A partial identifier for the specific RefreshSchedule resource being
// overridden. This structure is used together with the DataSetId structure.
//
// This member is required.
ScheduleId *string
// An override for the StartAfterDateTime of a RefreshSchedule . Make sure that the
// StartAfterDateTime is set to a time that takes place in the future.
StartAfterDateTime *time.Time
noSmithyDocumentSerde
}
// An optional structure that configures resource ID overrides for the import job.
type AssetBundleImportJobResourceIdOverrideConfiguration struct {
// An option to request a CloudFormation variable for a prefix to be prepended to
// each resource's ID before import. The prefix is only added to the asset IDs and
// does not change the name of the asset.
PrefixForAllResources *string
noSmithyDocumentSerde
}
// A summary of the import job that includes details of the requested job's
// configuration and its current status.
type AssetBundleImportJobSummary struct {
// The ARN of the import job.
Arn *string
// The ID of the job. This ID is unique while the job is running. After the job is
// completed, you can reuse this ID for another job.
AssetBundleImportJobId *string
// The time that the import job was created.
CreatedTime *time.Time
// The failure action for the import job.
FailureAction AssetBundleImportFailureAction
// The current status of the import job.
JobStatus AssetBundleImportJobStatus
noSmithyDocumentSerde
}
// The override parameters for a single theme that is imported.
type AssetBundleImportJobThemeOverrideParameters struct {
// The ID of the theme to apply overrides to.
//
// This member is required.
ThemeId *string
// A new name for the theme.
Name *string
noSmithyDocumentSerde
}
// The override parameters for a single VPC connection that is imported.
type AssetBundleImportJobVPCConnectionOverrideParameters struct {
// The ID of the VPC Connection to apply overrides to.
//
// This member is required.
VPCConnectionId *string
// An optional override of DNS resolvers to be used by the VPC connection.
DnsResolvers []string
// A new name for the VPC connection.
Name *string
// An optional override of the role ARN to be used by the VPC connection.
RoleArn *string
// A new security group ID for the VPC connection you are importing. This field is
// required if you are importing the VPC connection from another Amazon Web
// Services account or Region.
SecurityGroupIds []string
// A list of new subnet IDs for the VPC connection you are importing. This field
// is required if you are importing the VPC connection from another Amazon Web
// Services account or Region.
SubnetIds []string
noSmithyDocumentSerde
}
// The source of the asset bundle zip file that contains the data that you want to
// import.
type AssetBundleImportSource struct {
// The bytes of the base64 encoded asset bundle import zip file. This file can't
// exceed 20 MB. If you are calling the API operations from the Amazon Web Services
// SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically
// to allow the direct setting of the zip file's bytes. If you are using an SDK for
// a different language or receiving related errors, try to base64 encode your
// data.
Body []byte
// The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3
// bucket that the caller has read access to. The file must be a zip format file
// and can't exceed 20 MB.
S3Uri *string
noSmithyDocumentSerde
}
// A description of the import source that you provide at the start of an import
// job. This value is set to either Body or S3Uri , depending on how the
// StartAssetBundleImportJobRequest is configured.
type AssetBundleImportSourceDescription struct {
// An HTTPS download URL for the provided asset bundle that you optionally
// provided at the start of the import job. This URL is valid for five minutes
// after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if
// needed. The downloaded asset bundle is a .qs zip file.
Body *string
// The Amazon S3 URI that you provided at the start of the import job.
S3Uri *string
noSmithyDocumentSerde
}
// Parameters for Amazon Athena.
type AthenaParameters struct {
// Use the RoleArn structure to override an account-wide role for a specific
// Athena data source. For example, say an account administrator has turned off all
// Athena access with an account-wide role. The administrator can then use RoleArn
// to bypass the account-wide role and allow Athena access for the single Athena
// data source that is specified in the structure, even if the account-wide role
// forbidding Athena access is still active.
RoleArn *string
// The workgroup that Amazon Athena uses.
WorkGroup *string
noSmithyDocumentSerde
}
// Parameters for Amazon Aurora.
type AuroraParameters struct {
// Database.
//
// This member is required.
Database *string
// Host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// Parameters for Amazon Aurora PostgreSQL-Compatible Edition.
type AuroraPostgreSqlParameters struct {
// The Amazon Aurora PostgreSQL database to connect to.
//
// This member is required.
Database *string
// The Amazon Aurora PostgreSQL-Compatible host to connect to.
//
// This member is required.
Host *string
// The port that Amazon Aurora PostgreSQL is listening on.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// The parameters for IoT Analytics.
type AwsIotAnalyticsParameters struct {
// Dataset name.
//
// This member is required.
DataSetName *string
noSmithyDocumentSerde
}
// The data options for an axis. This is a union type structure. For this
// structure to be valid, only one of the attributes can be defined.
type AxisDataOptions struct {
// The options for an axis with a date field.
DateAxisOptions *DateAxisOptions
// The options for an axis with a numeric field.
NumericAxisOptions *NumericAxisOptions
noSmithyDocumentSerde
}
// The options that are saved for future extension.
type AxisDisplayDataDrivenRange struct {
noSmithyDocumentSerde
}
// The minimum and maximum setup for an axis display range.
type AxisDisplayMinMaxRange struct {
// The maximum setup for an axis display range.
Maximum *float64
// The minimum setup for an axis display range.
Minimum *float64
noSmithyDocumentSerde
}
// The display options for the axis label.
type AxisDisplayOptions struct {
// Determines whether or not the axis line is visible.
AxisLineVisibility Visibility
// The offset value that determines the starting placement of the axis within a
// visual's bounds.
AxisOffset *string
// The data options for an axis.
DataOptions *AxisDataOptions
// Determines whether or not the grid line is visible.
GridLineVisibility Visibility
// The scroll bar options for an axis.
ScrollbarOptions *ScrollBarOptions
// The tick label options of an axis.
TickLabelOptions *AxisTickLabelOptions
noSmithyDocumentSerde
}
// The range setup of a numeric axis display range. This is a union type
// structure. For this structure to be valid, only one of the attributes can be
// defined.
type AxisDisplayRange struct {
// The data-driven setup of an axis display range.
DataDriven *AxisDisplayDataDrivenRange
// The minimum and maximum setup of an axis display range.
MinMax *AxisDisplayMinMaxRange
noSmithyDocumentSerde
}
// The label options for a chart axis. You must specify the field that the label
// is targeted to.
type AxisLabelOptions struct {
// The options that indicate which field the label belongs to.
ApplyTo *AxisLabelReferenceOptions
// The text for the axis label.
CustomLabel *string
// The font configuration of the axis label.
FontConfiguration *FontConfiguration
noSmithyDocumentSerde
}
// The reference that specifies where the axis label is applied to.
type AxisLabelReferenceOptions struct {
// The column that the axis label is targeted to.
//
// This member is required.
Column *ColumnIdentifier
// The field that the axis label is targeted to.
//
// This member is required.
FieldId *string
noSmithyDocumentSerde
}
// The liner axis scale setup. This is a union type structure. For this structure
// to be valid, only one of the attributes can be defined.
type AxisLinearScale struct {
// The step count setup of a linear axis.
StepCount *int32
// The step size setup of a linear axis.
StepSize *float64
noSmithyDocumentSerde
}
// The logarithmic axis scale setup.
type AxisLogarithmicScale struct {
// The base setup of a logarithmic axis scale.
Base *float64
noSmithyDocumentSerde
}
// The scale setup options for a numeric axis display. This is a union type
// structure. For this structure to be valid, only one of the attributes can be
// defined.
type AxisScale struct {
// The linear axis scale setup.
Linear *AxisLinearScale
// The logarithmic axis scale setup.
Logarithmic *AxisLogarithmicScale
noSmithyDocumentSerde
}
// The tick label options of an axis.
type AxisTickLabelOptions struct {
// Determines whether or not the axis ticks are visible.
LabelOptions *LabelOptions
// The rotation angle of the axis tick labels.
RotationAngle *float64
noSmithyDocumentSerde
}
// The aggregated field wells of a bar chart.
type BarChartAggregatedFieldWells struct {
// The category (y-axis) field well of a bar chart.
Category []DimensionField
// The color (group/color) field well of a bar chart.
Colors []DimensionField
// The small multiples field well of a bar chart.
SmallMultiples []DimensionField
// The value field wells of a bar chart. Values are aggregated by category.
Values []MeasureField
noSmithyDocumentSerde
}
// The configuration of a BarChartVisual .
type BarChartConfiguration struct {
// Determines the arrangement of the bars. The orientation and arrangement of bars
// determine the type of bar that is used in the visual.
BarsArrangement BarsArrangement
// The label display options (grid line, range, scale, axis step) for bar chart
// category.
CategoryAxis *AxisDisplayOptions
// The label options (label text, label visibility and sort icon visibility) for a
// bar chart.
CategoryLabelOptions *ChartAxisLabelOptions
// The label options (label text, label visibility and sort icon visibility) for a
// color that is used in a bar chart.
ColorLabelOptions *ChartAxisLabelOptions
// The contribution analysis (anomaly configuration) setup of the visual.
ContributionAnalysisDefaults []ContributionAnalysisDefault
// The options that determine if visual data labels are displayed.
DataLabels *DataLabelOptions
// The field wells of the visual.
FieldWells *BarChartFieldWells
// The legend display setup of the visual.
Legend *LegendOptions
// The orientation of the bars in a bar chart visual. There are two valid values
// in this structure:
// - HORIZONTAL : Used for charts that have horizontal bars. Visuals that use
// this value are horizontal bar charts, horizontal stacked bar charts, and
// horizontal stacked 100% bar charts.
// - VERTICAL : Used for charts that have vertical bars. Visuals that use this
// value are vertical bar charts, vertical stacked bar charts, and vertical stacked
// 100% bar charts.
Orientation BarChartOrientation
// The reference line setup of the visual.
ReferenceLines []ReferenceLine
// The small multiples setup for the visual.
SmallMultiplesOptions *SmallMultiplesOptions
// The sort configuration of a BarChartVisual .
SortConfiguration *BarChartSortConfiguration
// The tooltip display setup of the visual.
Tooltip *TooltipOptions
// The label display options (grid line, range, scale, axis step) for a bar chart
// value.
ValueAxis *AxisDisplayOptions
// The label options (label text, label visibility and sort icon visibility) for a
// bar chart value.
ValueLabelOptions *ChartAxisLabelOptions
// The palette (chart color) display setup of the visual.
VisualPalette *VisualPalette
noSmithyDocumentSerde
}
// The field wells of a BarChartVisual . This is a union type structure. For this
// structure to be valid, only one of the attributes can be defined.
type BarChartFieldWells struct {
// The aggregated field wells of a bar chart.
BarChartAggregatedFieldWells *BarChartAggregatedFieldWells
noSmithyDocumentSerde
}
// sort-configuration-description
type BarChartSortConfiguration struct {
// The limit on the number of categories displayed in a bar chart.
CategoryItemsLimit *ItemsLimitConfiguration
// The sort configuration of category fields.
CategorySort []FieldSortOptions
// The limit on the number of values displayed in a bar chart.
ColorItemsLimit *ItemsLimitConfiguration
// The sort configuration of color fields in a bar chart.
ColorSort []FieldSortOptions
// The limit on the number of small multiples panels that are displayed.
SmallMultiplesLimitConfiguration *ItemsLimitConfiguration
// The sort configuration of the small multiples field.
SmallMultiplesSort []FieldSortOptions
noSmithyDocumentSerde
}
// A bar chart. The BarChartVisual structure describes a visual that is a member
// of the bar chart family. The following charts can be described using this
// structure:
// - Horizontal bar chart
// - Vertical bar chart
// - Horizontal stacked bar chart
// - Vertical stacked bar chart
// - Horizontal stacked 100% bar chart
// - Vertical stacked 100% bar chart
//
// For more information, see Using bar charts (https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html)
// in the Amazon QuickSight User Guide.
type BarChartVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers.
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration settings of the visual.
ChartConfiguration *BarChartConfiguration
// The column hierarchy that is used during drill-downs and drill-ups.
ColumnHierarchies []ColumnHierarchy
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// The options that determine the bin count of a histogram.
type BinCountOptions struct {
// The options that determine the bin count value.
Value *int32
noSmithyDocumentSerde
}
// The options that determine the bin width of a histogram.
type BinWidthOptions struct {
// The options that determine the bin count limit.
BinCountLimit *int64
// The options that determine the bin width value.
Value *float64
noSmithyDocumentSerde
}
// The configuration of a body section.
type BodySectionConfiguration struct {
// The configuration of content in a body section.
//
// This member is required.
Content *BodySectionContent
// The unique identifier of a body section.
//
// This member is required.
SectionId *string
// The configuration of a page break for a section.
PageBreakConfiguration *SectionPageBreakConfiguration
// The style options of a body section.
Style *SectionStyle
noSmithyDocumentSerde
}
// The configuration of content in a body section.
type BodySectionContent struct {
// The layout configuration of a body section.
Layout *SectionLayoutConfiguration
noSmithyDocumentSerde
}
// The bookmarks configuration of an embedded dashboard.
type BookmarksConfigurations struct {
// A Boolean value that determines whether a user can bookmark an embedded
// dashboard.
//
// This member is required.
Enabled bool
noSmithyDocumentSerde
}
// The display options for tile borders for visuals.
type BorderStyle struct {
// The option to enable display of borders for visuals.
Show *bool
noSmithyDocumentSerde
}
// The aggregated field well for a box plot.
type BoxPlotAggregatedFieldWells struct {
// The group by field well of a box plot chart. Values are grouped based on group
// by fields.
GroupBy []DimensionField
// The value field well of a box plot chart. Values are aggregated based on group
// by fields.
Values []MeasureField
noSmithyDocumentSerde
}
// The configuration of a BoxPlotVisual .
type BoxPlotChartConfiguration struct {
// The box plot chart options for a box plot visual
BoxPlotOptions *BoxPlotOptions
// The label display options (grid line, range, scale, axis step) of a box plot
// category.
CategoryAxis *AxisDisplayOptions
// The label options (label text, label visibility and sort Icon visibility) of a
// box plot category.
CategoryLabelOptions *ChartAxisLabelOptions
// The field wells of the visual.
FieldWells *BoxPlotFieldWells
// The options for the legend setup of a visual.
Legend *LegendOptions
// The label display options (grid line, range, scale, axis step) of a box plot
// category.
PrimaryYAxisDisplayOptions *AxisDisplayOptions
// The label options (label text, label visibility and sort icon visibility) of a
// box plot value.
PrimaryYAxisLabelOptions *ChartAxisLabelOptions
// The reference line setup of the visual.
ReferenceLines []ReferenceLine
// The sort configuration of a BoxPlotVisual .
SortConfiguration *BoxPlotSortConfiguration
// The tooltip display setup of the visual.
Tooltip *TooltipOptions
// The palette (chart color) display setup of the visual.
VisualPalette *VisualPalette
noSmithyDocumentSerde
}
// The field wells of a BoxPlotVisual . This is a union type structure. For this
// structure to be valid, only one of the attributes can be defined.
type BoxPlotFieldWells struct {
// The aggregated field wells of a box plot.
BoxPlotAggregatedFieldWells *BoxPlotAggregatedFieldWells
noSmithyDocumentSerde
}
// The options of a box plot visual.
type BoxPlotOptions struct {
// Determines the visibility of all data points of the box plot.
AllDataPointsVisibility Visibility
// Determines the visibility of the outlier in a box plot.
OutlierVisibility Visibility
// The style options of the box plot.
StyleOptions *BoxPlotStyleOptions
noSmithyDocumentSerde
}
// The sort configuration of a BoxPlotVisual .
type BoxPlotSortConfiguration struct {
// The sort configuration of a group by fields.
CategorySort []FieldSortOptions
// The pagination configuration of a table visual or box plot.
PaginationConfiguration *PaginationConfiguration
noSmithyDocumentSerde
}
// The style options of the box plot.
type BoxPlotStyleOptions struct {
// The fill styles (solid, transparent) of the box plot.
FillStyle BoxPlotFillStyle
noSmithyDocumentSerde
}
// A box plot. For more information, see Using box plots (https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html)
// in the Amazon QuickSight User Guide.
type BoxPlotVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers..
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration settings of the visual.
ChartConfiguration *BoxPlotChartConfiguration
// The column hierarchy that is used during drill-downs and drill-ups.
ColumnHierarchies []ColumnHierarchy
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// A calculated column for a dataset.
type CalculatedColumn struct {
// A unique ID to identify a calculated column. During a dataset update, if the
// column ID of a calculated column matches that of an existing calculated column,
// Amazon QuickSight preserves the existing calculated column.
//
// This member is required.
ColumnId *string
// Column name.
//
// This member is required.
ColumnName *string
// An expression that defines the calculated column.
//
// This member is required.
Expression *string
noSmithyDocumentSerde
}
// The calculated field of an analysis.
type CalculatedField struct {
// The data set that is used in this calculated field.
//
// This member is required.
DataSetIdentifier *string
// The expression of the calculated field.
//
// This member is required.
Expression *string
// The name of the calculated field.
//
// This member is required.
Name *string
noSmithyDocumentSerde
}
// The table calculation measure field for pivot tables.
type CalculatedMeasureField struct {
// The expression in the table calculation.
//
// This member is required.
Expression *string
// The custom field ID.
//
// This member is required.
FieldId *string
noSmithyDocumentSerde
}
// The values that are displayed in a control can be configured to only show
// values that are valid based on what's selected in other controls.
type CascadingControlConfiguration struct {
// A list of source controls that determine the values that are used in the
// current control.
SourceControls []CascadingControlSource
noSmithyDocumentSerde
}
// The source controls that are used in a CascadingControlConfiguration .
type CascadingControlSource struct {
// The column identifier that determines which column to look up for the source
// sheet control.
ColumnToMatch *ColumnIdentifier
// The source sheet control ID of a CascadingControlSource .
SourceSheetControlId *string
noSmithyDocumentSerde
}
// A transform operation that casts a column to a different type.
type CastColumnTypeOperation struct {
// Column name.
//
// This member is required.
ColumnName *string
// New column data type.
//
// This member is required.
NewColumnType ColumnDataType
// When casting a column from string to datetime type, you can supply a string in
// a format supported by Amazon QuickSight to denote the source data format.
Format *string
noSmithyDocumentSerde
}
// The dimension type field with categorical type columns..
type CategoricalDimensionField struct {
// The column that is used in the CategoricalDimensionField .
//
// This member is required.
Column *ColumnIdentifier
// The custom field ID.
//
// This member is required.
FieldId *string
// The format configuration of the field.
FormatConfiguration *StringFormatConfiguration
// The custom hierarchy ID.
HierarchyId *string
noSmithyDocumentSerde
}
// The measure type field with categorical type columns.
type CategoricalMeasureField struct {
// The column that is used in the CategoricalMeasureField .
//
// This member is required.
Column *ColumnIdentifier
// The custom field ID.
//
// This member is required.
FieldId *string
// The aggregation function of the measure field.
AggregationFunction CategoricalAggregationFunction
// The format configuration of the field.
FormatConfiguration *StringFormatConfiguration
noSmithyDocumentSerde
}
// The numeric equality type drill down filter.
type CategoryDrillDownFilter struct {
// A list of the string inputs that are the values of the category drill down
// filter.
//
// This member is required.
CategoryValues []string
// The column that the filter is applied to.
//
// This member is required.
Column *ColumnIdentifier
noSmithyDocumentSerde
}
// A CategoryFilter filters text values. For more information, see Adding text
// filters (https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html)
// in the Amazon QuickSight User Guide.
type CategoryFilter struct {
// The column that the filter is applied to.
//
// This member is required.
Column *ColumnIdentifier
// The configuration for a CategoryFilter .
//
// This member is required.
Configuration *CategoryFilterConfiguration
// An identifier that uniquely identifies a filter within a dashboard, analysis,
// or template.
//
// This member is required.
FilterId *string
noSmithyDocumentSerde
}
// The configuration for a CategoryFilter . This is a union type structure. For
// this structure to be valid, only one of the attributes can be defined.
type CategoryFilterConfiguration struct {
// A custom filter that filters based on a single value. This filter can be
// partially matched.
CustomFilterConfiguration *CustomFilterConfiguration
// A list of custom filter values. In the Amazon QuickSight console, this filter
// type is called a custom filter list.
CustomFilterListConfiguration *CustomFilterListConfiguration
// A list of filter configurations. In the Amazon QuickSight console, this filter
// type is called a filter list.
FilterListConfiguration *FilterListConfiguration
noSmithyDocumentSerde
}
// A structure that represents the cell value synonym.
type CellValueSynonym struct {
// The cell value.
CellValue *string
// Other names or aliases for the cell value.
Synonyms []string
noSmithyDocumentSerde
}
// The label options for an axis on a chart.
type ChartAxisLabelOptions struct {
// The label options for a chart axis.
AxisLabelOptions []AxisLabelOptions
// The visibility configuration of the sort icon on a chart's axis label.
SortIconVisibility Visibility
// The visibility of an axis label on a chart. Choose one of the following
// options:
// - VISIBLE : Shows the axis.
// - HIDDEN : Hides the axis.
Visibility Visibility
noSmithyDocumentSerde
}
// The cluster marker that is a part of the cluster marker configuration.
type ClusterMarker struct {
// The simple cluster marker of the cluster marker.
SimpleClusterMarker *SimpleClusterMarker
noSmithyDocumentSerde
}
// The cluster marker configuration of the geospatial map selected point style.
type ClusterMarkerConfiguration struct {
// The cluster marker that is a part of the cluster marker configuration.
ClusterMarker *ClusterMarker
noSmithyDocumentSerde
}
// A structure that represents a collective constant.
type CollectiveConstant struct {
// A list of values for the collective constant.
ValueList []string
noSmithyDocumentSerde
}
// Determines the color scale that is applied to the visual.
type ColorScale struct {
// Determines the color fill type.
//
// This member is required.
ColorFillType ColorFillType
// Determines the list of colors that are applied to the visual.
//
// This member is required.
Colors []DataColor
// Determines the color that is applied to null values.
NullValueColor *DataColor
noSmithyDocumentSerde
}
// The general configuration of a column.
type ColumnConfiguration struct {
// The column.
//
// This member is required.
Column *ColumnIdentifier
// The format configuration of a column.
FormatConfiguration *FormatConfiguration
// The role of the column.
Role ColumnRole
noSmithyDocumentSerde
}
// Metadata that contains a description for a column.
type ColumnDescription struct {
// The text of a description for a column.
Text *string
noSmithyDocumentSerde
}
// Groupings of columns that work together in certain Amazon QuickSight features.
// This is a variant type structure. For this structure to be valid, only one of
// the attributes can be non-null.
type ColumnGroup struct {
// Geospatial column group that denotes a hierarchy.
GeoSpatialColumnGroup *GeoSpatialColumnGroup
noSmithyDocumentSerde
}
// A structure describing the name, data type, and geographic role of the columns.
type ColumnGroupColumnSchema struct {
// The name of the column group's column schema.
Name *string
noSmithyDocumentSerde
}
// The column group schema.
type ColumnGroupSchema struct {
// A structure containing the list of schemas for column group columns.
ColumnGroupColumnSchemaList []ColumnGroupColumnSchema
// The name of the column group schema.
Name *string
noSmithyDocumentSerde
}
// The option that determines the hierarchy of the fields for a visual element.
type ColumnHierarchy struct {
// The option that determines the hierarchy of any DateTime fields.
DateTimeHierarchy *DateTimeHierarchy
// The option that determines the hierarchy of the fields that are built within a
// visual's field wells. These fields can't be duplicated to other visuals.
ExplicitHierarchy *ExplicitHierarchy
// The option that determines the hierarchy of the fields that are defined during
// data preparation. These fields are available to use in any analysis that uses
// the data source.
PredefinedHierarchy *PredefinedHierarchy
noSmithyDocumentSerde
}
// A column of a data set.
type ColumnIdentifier struct {
// The name of the column.
//
// This member is required.
ColumnName *string
// The data set that the column belongs to.
//
// This member is required.
DataSetIdentifier *string
noSmithyDocumentSerde
}
// A rule defined to grant access on one or more restricted columns. Each dataset
// can have multiple rules. To create a restricted column, you add it to one or
// more rules. Each rule must contain at least one column and at least one user or
// group. To be able to see a restricted column, a user or group needs to be added
// to a rule for that column.
type ColumnLevelPermissionRule struct {
// An array of column names.
ColumnNames []string
// An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.
Principals []string
noSmithyDocumentSerde
}
// The column schema.
type ColumnSchema struct {
// The data type of the column schema.
DataType *string
// The geographic role of the column schema.
GeographicRole *string
// The name of the column schema.
Name *string
noSmithyDocumentSerde
}
// The sort configuration for a column that is not used in a field well.
type ColumnSort struct {
// The sort direction.
//
// This member is required.
Direction SortDirection
// A column of a data set.
//
// This member is required.
SortBy *ColumnIdentifier
// The aggregation function that is defined in the column sort.
AggregationFunction *AggregationFunction
noSmithyDocumentSerde
}
// A tag for a column in a TagColumnOperation (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html)
// structure. This is a variant type structure. For this structure to be valid,
// only one of the attributes can be non-null.
type ColumnTag struct {
// A description for a column.
ColumnDescription *ColumnDescription
// A geospatial role for a column.
ColumnGeographicRole GeoSpatialDataRole
noSmithyDocumentSerde
}
// The tooltip item for the columns that are not part of a field well.
type ColumnTooltipItem struct {
// The target column of the tooltip item.
//
// This member is required.
Column *ColumnIdentifier
// The aggregation function of the column tooltip item.
Aggregation *AggregationFunction
// The label of the tooltip item.
Label *string
// The visibility of the tooltip item.
Visibility Visibility
noSmithyDocumentSerde
}
// The aggregated field wells of a combo chart.
type ComboChartAggregatedFieldWells struct {
// The aggregated BarValues field well of a combo chart.
BarValues []MeasureField
// The aggregated category field wells of a combo chart.
Category []DimensionField
// The aggregated colors field well of a combo chart.
Colors []DimensionField
// The aggregated LineValues field well of a combo chart.
LineValues []MeasureField
noSmithyDocumentSerde
}
// The configuration of a ComboChartVisual .
type ComboChartConfiguration struct {
// The options that determine if visual data labels are displayed. The data label
// options for a bar in a combo chart.
BarDataLabels *DataLabelOptions
// Determines the bar arrangement in a combo chart. The following are valid values
// in this structure:
// - CLUSTERED : For clustered bar combo charts.
// - STACKED : For stacked bar combo charts.
// - STACKED_PERCENT : Do not use. If you use this value, the operation returns a
// validation error.
BarsArrangement BarsArrangement
// The category axis of a combo chart.
CategoryAxis *AxisDisplayOptions
// The label options (label text, label visibility, and sort icon visibility) of a
// combo chart category (group/color) field well.
CategoryLabelOptions *ChartAxisLabelOptions
// The label options (label text, label visibility, and sort icon visibility) of a
// combo chart's color field well.
ColorLabelOptions *ChartAxisLabelOptions
// The field wells of the visual.
FieldWells *ComboChartFieldWells
// The legend display setup of the visual.
Legend *LegendOptions
// The options that determine if visual data labels are displayed. The data label
// options for a line in a combo chart.
LineDataLabels *DataLabelOptions
// The label display options (grid line, range, scale, and axis step) of a combo
// chart's primary y-axis (bar) field well.
PrimaryYAxisDisplayOptions *AxisDisplayOptions
// The label options (label text, label visibility, and sort icon visibility) of a
// combo chart's primary y-axis (bar) field well.
PrimaryYAxisLabelOptions *ChartAxisLabelOptions
// The reference line setup of the visual.
ReferenceLines []ReferenceLine
// The label display options (grid line, range, scale, axis step) of a combo
// chart's secondary y-axis (line) field well.
SecondaryYAxisDisplayOptions *AxisDisplayOptions
// The label options (label text, label visibility, and sort icon visibility) of a
// combo chart's secondary y-axis(line) field well.
SecondaryYAxisLabelOptions *ChartAxisLabelOptions
// The sort configuration of a ComboChartVisual .
SortConfiguration *ComboChartSortConfiguration
// The legend display setup of the visual.
Tooltip *TooltipOptions
// The palette (chart color) display setup of the visual.
VisualPalette *VisualPalette
noSmithyDocumentSerde
}
// The field wells of the visual. This is a union type structure. For this
// structure to be valid, only one of the attributes can be defined.
type ComboChartFieldWells struct {
// The aggregated field wells of a combo chart. Combo charts only have aggregated
// field wells. Columns in a combo chart are aggregated by category.
ComboChartAggregatedFieldWells *ComboChartAggregatedFieldWells
noSmithyDocumentSerde
}
// The sort configuration of a ComboChartVisual .
type ComboChartSortConfiguration struct {
// The item limit configuration for the category field well of a combo chart.
CategoryItemsLimit *ItemsLimitConfiguration
// The sort configuration of the category field well in a combo chart.
CategorySort []FieldSortOptions
// The item limit configuration of the color field well in a combo chart.
ColorItemsLimit *ItemsLimitConfiguration
// The sort configuration of the color field well in a combo chart.
ColorSort []FieldSortOptions
noSmithyDocumentSerde
}
// A combo chart. The ComboChartVisual includes stacked bar combo charts and
// clustered bar combo charts For more information, see Using combo charts (https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html)
// in the Amazon QuickSight User Guide.
type ComboChartVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers.
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration settings of the visual.
ChartConfiguration *ComboChartConfiguration
// The column hierarchy that is used during drill-downs and drill-ups.
ColumnHierarchies []ColumnHierarchy
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// A structure that represents a comparative order.
type ComparativeOrder struct {
// The list of columns to be used in the ordering.
SpecifedOrder []string
// The treat of undefined specified values. Valid values for this structure are
// LEAST and MOST .
TreatUndefinedSpecifiedValues UndefinedSpecifiedValueType
// The ordering type for a column. Valid values for this structure are
// GREATER_IS_BETTER , LESSER_IS_BETTER and SPECIFIED .
UseOrdering ColumnOrderingType
noSmithyDocumentSerde
}
// The comparison display configuration of a KPI or gauge chart.
type ComparisonConfiguration struct {
// The format of the comparison.
ComparisonFormat *ComparisonFormatConfiguration
// The method of the comparison. Choose from the following options:
// - DIFFERENCE
// - PERCENT_DIFFERENCE
// - PERCENT
ComparisonMethod ComparisonMethod
noSmithyDocumentSerde
}
// The format of the comparison. This is a union type structure. For this
// structure to be valid, only one of the attributes can be defined.
type ComparisonFormatConfiguration struct {
// The number display format.
NumberDisplayFormatConfiguration *NumberDisplayFormatConfiguration
// The percentage display format.
PercentageDisplayFormatConfiguration *PercentageDisplayFormatConfiguration
noSmithyDocumentSerde
}
// The computation union that is used in an insight visual. This is a union type
// structure. For this structure to be valid, only one of the attributes can be
// defined.
type Computation struct {
// The forecast computation configuration.
Forecast *ForecastComputation
// The growth rate computation configuration.
GrowthRate *GrowthRateComputation
// The maximum and minimum computation configuration.
MaximumMinimum *MaximumMinimumComputation
// The metric comparison computation configuration.
MetricComparison *MetricComparisonComputation
// The period over period computation configuration.
PeriodOverPeriod *PeriodOverPeriodComputation
// The period to DataSetIdentifier computation configuration.
PeriodToDate *PeriodToDateComputation
// The top movers and bottom movers computation configuration.
TopBottomMovers *TopBottomMoversComputation
// The top ranked and bottom ranked computation configuration.
TopBottomRanked *TopBottomRankedComputation
// The total aggregation computation configuration.
TotalAggregation *TotalAggregationComputation
// The unique values computation configuration.
UniqueValues *UniqueValuesComputation
noSmithyDocumentSerde
}
// The formatting configuration for the color.
type ConditionalFormattingColor struct {
// Formatting configuration for gradient color.
Gradient *ConditionalFormattingGradientColor
// Formatting configuration for solid color.
Solid *ConditionalFormattingSolidColor
noSmithyDocumentSerde
}
// Determines the custom condition for an icon set.
type ConditionalFormattingCustomIconCondition struct {
// The expression that determines the condition of the icon set.
//
// This member is required.
Expression *string
// Custom icon options for an icon set.
//
// This member is required.
IconOptions *ConditionalFormattingCustomIconOptions
// Determines the color of the icon.
Color *string
// Determines the icon display configuration.
DisplayConfiguration *ConditionalFormattingIconDisplayConfiguration
noSmithyDocumentSerde
}
// Custom icon options for an icon set.
type ConditionalFormattingCustomIconOptions struct {
// Determines the type of icon.
Icon Icon
// Determines the Unicode icon type.
UnicodeIcon *string
noSmithyDocumentSerde
}
// Formatting configuration for gradient color.
type ConditionalFormattingGradientColor struct {
// Determines the color.
//
// This member is required.
Color *GradientColor
// The expression that determines the formatting configuration for gradient color.
//
// This member is required.
Expression *string
noSmithyDocumentSerde
}
// The formatting configuration for the icon.
type ConditionalFormattingIcon struct {
// Determines the custom condition for an icon set.
CustomCondition *ConditionalFormattingCustomIconCondition
// Formatting configuration for icon set.
IconSet *ConditionalFormattingIconSet
noSmithyDocumentSerde
}
// Determines the icon display configuration.
type ConditionalFormattingIconDisplayConfiguration struct {
// Determines the icon display configuration.
IconDisplayOption ConditionalFormattingIconDisplayOption
noSmithyDocumentSerde
}
// Formatting configuration for icon set.
type ConditionalFormattingIconSet struct {
// The expression that determines the formatting configuration for the icon set.
//
// This member is required.
Expression *string
// Determines the icon set type.
IconSetType ConditionalFormattingIconSetType
noSmithyDocumentSerde
}
// Formatting configuration for solid color.
type ConditionalFormattingSolidColor struct {
// The expression that determines the formatting configuration for solid color.
//
// This member is required.
Expression *string
// Determines the color.
Color *string
noSmithyDocumentSerde
}
// The contribution analysis visual display for a line, pie, or bar chart.
type ContributionAnalysisDefault struct {
// The dimensions columns that are used in the contribution analysis, usually a
// list of ColumnIdentifiers .
//
// This member is required.
ContributorDimensions []ColumnIdentifier
// The measure field that is used in the contribution analysis.
//
// This member is required.
MeasureFieldId *string
noSmithyDocumentSerde
}
// A transform operation that creates calculated columns. Columns created in one
// such operation form a lexical closure.
type CreateColumnsOperation struct {
// Calculated columns to create.
//
// This member is required.
Columns []CalculatedColumn
noSmithyDocumentSerde
}
// The combination of user name and password that are used as credentials.
type CredentialPair struct {
// Password.
//
// This member is required.
Password *string
// User name.
//
// This member is required.
Username *string
// A set of alternate data source parameters that you want to share for these
// credentials. The credentials are applied in tandem with the data source
// parameters when you copy a data source by using a create or update request. The
// API operation compares the DataSourceParameters structure that's in the request
// with the structures in the AlternateDataSourceParameters allow list. If the
// structures are an exact match, the request is allowed to use the new data source
// with the existing credentials. If the AlternateDataSourceParameters list is
// null, the DataSourceParameters originally used with these Credentials is
// automatically allowed.
AlternateDataSourceParameters []DataSourceParameters
noSmithyDocumentSerde
}
// The options that determine the currency display format configuration.
type CurrencyDisplayFormatConfiguration struct {
// The option that determines the decimal places configuration.
DecimalPlacesConfiguration *DecimalPlacesConfiguration
// The options that determine the negative value configuration.
NegativeValueConfiguration *NegativeValueConfiguration
// The options that determine the null value format configuration.
NullValueFormatConfiguration *NullValueFormatConfiguration
// Determines the number scale value for the currency format.
NumberScale NumberScale
// Determines the prefix value of the currency format.
Prefix *string
// The options that determine the numeric separator configuration.
SeparatorConfiguration *NumericSeparatorConfiguration
// Determines the suffix value of the currency format.
Suffix *string
// Determines the symbol for the currency format.
Symbol *string
noSmithyDocumentSerde
}
// The filter operation that filters data included in a visual or in an entire
// sheet.
type CustomActionFilterOperation struct {
// The configuration that chooses the fields to be filtered.
//
// This member is required.
SelectedFieldsConfiguration *FilterOperationSelectedFieldsConfiguration
// The configuration that chooses the target visuals to be filtered.
//
// This member is required.
TargetVisualsConfiguration *FilterOperationTargetVisualsConfiguration
noSmithyDocumentSerde
}
// The navigation operation that navigates between different sheets in the same
// analysis. This is a union type structure. For this structure to be valid, only
// one of the attributes can be defined.
type CustomActionNavigationOperation struct {
// The configuration that chooses the navigation target.
LocalNavigationConfiguration *LocalNavigationConfiguration
noSmithyDocumentSerde
}
// The set parameter operation that sets parameters in custom action.
type CustomActionSetParametersOperation struct {
// The parameter that determines the value configuration.
//
// This member is required.
ParameterValueConfigurations []SetParameterValueConfiguration
noSmithyDocumentSerde
}
// The URL operation that opens a link to another webpage.
type CustomActionURLOperation struct {
// The target of the CustomActionURLOperation . Valid values are defined as
// follows:
// - NEW_TAB : Opens the target URL in a new browser tab.
// - NEW_WINDOW : Opens the target URL in a new browser window.
// - SAME_TAB : Opens the target URL in the same browser tab.
//
// This member is required.
URLTarget URLTargetConfiguration
// THe URL link of the CustomActionURLOperation .
//
// This member is required.
URLTemplate *string
noSmithyDocumentSerde
}
// The configuration of a CustomContentVisual .
type CustomContentConfiguration struct {
// The content type of the custom content visual. You can use this to have the
// visual render as an image.
ContentType CustomContentType
// The input URL that links to the custom content that you want in the custom
// visual.
ContentUrl *string
// The sizing options for the size of the custom content visual. This structure is
// required when the ContentType of the visual is 'IMAGE' .
ImageScaling CustomContentImageScalingConfiguration
noSmithyDocumentSerde
}
// A visual that contains custom content. For more information, see Using custom
// visual content (https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html)
// in the Amazon QuickSight User Guide.
type CustomContentVisual struct {
// The dataset that is used to create the custom content visual. You can't create
// a visual without a dataset.
//
// This member is required.
DataSetIdentifier *string
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers.
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration of a CustomContentVisual .
ChartConfiguration *CustomContentConfiguration
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// A custom filter that filters based on a single value. This filter can be
// partially matched.
type CustomFilterConfiguration struct {
// The match operator that is used to determine if a filter should be applied.
//
// This member is required.
MatchOperator CategoryFilterMatchOperator
// This option determines how null values should be treated when filtering data.
// - ALL_VALUES : Include null values in filtered results.
// - NULLS_ONLY : Only include null values in filtered results.
// - NON_NULLS_ONLY : Exclude null values from filtered results.
//
// This member is required.
NullOption FilterNullOption
// The category value for the filter. This field is mutually exclusive to
// ParameterName .
CategoryValue *string
// The parameter whose value should be used for the filter value. This field is
// mutually exclusive to CategoryValue .
ParameterName *string
// Select all of the values. Null is not the assigned value of select all.
// - FILTER_ALL_VALUES
SelectAllOptions CategoryFilterSelectAllOptions
noSmithyDocumentSerde
}
// A list of custom filter values.
type CustomFilterListConfiguration struct {
// The match operator that is used to determine if a filter should be applied.
//
// This member is required.
MatchOperator CategoryFilterMatchOperator
// This option determines how null values should be treated when filtering data.
// - ALL_VALUES : Include null values in filtered results.
// - NULLS_ONLY : Only include null values in filtered results.
// - NON_NULLS_ONLY : Exclude null values from filtered results.
//
// This member is required.
NullOption FilterNullOption
// The list of category values for the filter.
CategoryValues []string
// Select all of the values. Null is not the assigned value of select all.
// - FILTER_ALL_VALUES
SelectAllOptions CategoryFilterSelectAllOptions
noSmithyDocumentSerde
}
// The custom narrative options.
type CustomNarrativeOptions struct {
// The string input of custom narrative.
//
// This member is required.
Narrative *string
noSmithyDocumentSerde
}
// The customized parameter values. This is a union type structure. For this
// structure to be valid, only one of the attributes can be defined.
type CustomParameterValues struct {
// A list of datetime-type parameter values.
DateTimeValues []time.Time
// A list of decimal-type parameter values.
DecimalValues []float64
// A list of integer-type parameter values.
IntegerValues []int64
// A list of string-type parameter values.
StringValues []string
noSmithyDocumentSerde
}
// A physical table type built from the results of the custom SQL query.
type CustomSql struct {
// The Amazon Resource Name (ARN) of the data source.
//
// This member is required.
DataSourceArn *string
// A display name for the SQL query result.
//
// This member is required.
Name *string
// The SQL query.
//
// This member is required.
SqlQuery *string
// The column schema from the SQL query result set.
Columns []InputColumn
noSmithyDocumentSerde
}
// The configuration of custom values for the destination parameter in
// DestinationParameterValueConfiguration .
type CustomValuesConfiguration struct {
// The customized parameter values. This is a union type structure. For this
// structure to be valid, only one of the attributes can be defined.
//
// This member is required.
CustomValues *CustomParameterValues
// Includes the null value in custom action parameter values.
IncludeNullValue *bool
noSmithyDocumentSerde
}
// Dashboard.
type Dashboard struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// The time that this dashboard was created.
CreatedTime *time.Time
// Dashboard ID.
DashboardId *string
// The last time that this dashboard was published.
LastPublishedTime *time.Time
// The last time that this dashboard was updated.
LastUpdatedTime *time.Time
// A display name for the dashboard.
Name *string
// Version.
Version *DashboardVersion
noSmithyDocumentSerde
}
// Dashboard error.
type DashboardError struct {
// Message.
Message *string
// Type.
Type DashboardErrorType
// Lists the violated entities that caused the dashboard error.
ViolatedEntities []Entity
noSmithyDocumentSerde
}
// Dashboard publish options.
type DashboardPublishOptions struct {
// Ad hoc (one-time) filtering option.
AdHocFilteringOption *AdHocFilteringOption
// The drill-down options of data points in a dashboard.
DataPointDrillUpDownOption *DataPointDrillUpDownOption
// The data point menu label options of a dashboard.
DataPointMenuLabelOption *DataPointMenuLabelOption
// The data point tool tip options of a dashboard.
DataPointTooltipOption *DataPointTooltipOption
// Export to .csv option.
ExportToCSVOption *ExportToCSVOption
// Determines if hidden fields are exported with a dashboard.
ExportWithHiddenFieldsOption *ExportWithHiddenFieldsOption
// Sheet controls option.
SheetControlsOption *SheetControlsOption
// The sheet layout maximization options of a dashbaord.
SheetLayoutElementMaximizationOption *SheetLayoutElementMaximizationOption
// The axis sort options of a dashboard.
VisualAxisSortOption *VisualAxisSortOption
// The menu options of a visual in a dashboard.
VisualMenuOption *VisualMenuOption
// The visual publish options of a visual in a dashboard.
//
// Deprecated: VisualPublishOptions property will reach its end of standard
// support in a future release. To perform this action, use ExportWithHiddenFields.
VisualPublishOptions *DashboardVisualPublishOptions
noSmithyDocumentSerde
}
// A filter that you apply when searching for dashboards.
type DashboardSearchFilter struct {
// The comparison operator that you want to use as a filter, for example
// "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
// If you set the operator value to "StringEquals" , you need to provide an
// ownership related filter in the "NAME" field and the arn of the user or group
// whose folders you want to search in the "Value" field. For example,
// "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value":
// "arn:aws:quicksight:us-east-1:1:user/default/UserName1" . If you set the value
// to "StringLike" , you need to provide the name of the folders you are searching
// for. For example, "Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value":
// "Test" . The "StringLike" operator only supports the NAME value DASHBOARD_NAME .
//
// This member is required.
Operator FilterOperator
// The name of the value that you want to use as a filter, for example, "Name":
// "QUICKSIGHT_OWNER" . Valid values are defined as follows:
// - QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any
// dashboards with that ARN listed as one of the dashboards's owners or viewers are
// returned. Implicit permissions from folders or groups are considered.
// - QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any dashboards
// with that ARN listed as one of the owners of the dashboards are returned.
// Implicit permissions from folders or groups are considered.
// - DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any
// dashboards with that ARN listed as the only owner of the dashboard are returned.
// Implicit permissions from folders or groups are not considered.
// - DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any
// dashboards with that ARN listed as one of the owners of the dashboards are
// returned. Implicit permissions from folders or groups are not considered.
// - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and
// any dashboards with that ARN listed as one of the owners or viewers of the
// dashboards are returned. Implicit permissions from folders or groups are not
// considered.
// - DASHBOARD_NAME : Any dashboards whose names have a substring match to this
// value will be returned.
Name DashboardFilterAttribute
// The value of the named item, in this case QUICKSIGHT_USER , that you want to use
// as a filter, for example, "Value":
// "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
Value *string
noSmithyDocumentSerde
}
// Dashboard source entity.
type DashboardSourceEntity struct {
// Source template.
SourceTemplate *DashboardSourceTemplate
noSmithyDocumentSerde
}
// Dashboard source template.
type DashboardSourceTemplate struct {
// The Amazon Resource Name (ARN) of the resource.
//
// This member is required.
Arn *string
// Dataset references.
//
// This member is required.
DataSetReferences []DataSetReference
noSmithyDocumentSerde
}
// Dashboard summary.
type DashboardSummary struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// The time that this dashboard was created.
CreatedTime *time.Time
// Dashboard ID.
DashboardId *string
// The last time that this dashboard was published.
LastPublishedTime *time.Time
// The last time that this dashboard was updated.
LastUpdatedTime *time.Time
// A display name for the dashboard.
Name *string
// Published version number.
PublishedVersionNumber *int64
noSmithyDocumentSerde
}
// Dashboard version.
type DashboardVersion struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// The time that this dashboard version was created.
CreatedTime *time.Time
// The Amazon Resource Numbers (ARNs) for the datasets that are associated with
// this version of the dashboard.
DataSetArns []string
// Description.
Description *string
// Errors associated with this dashboard version.
Errors []DashboardError
// A list of the associated sheets with the unique identifier and name of each
// sheet.
Sheets []Sheet
// Source entity ARN.
SourceEntityArn *string
// The HTTP status of the request.
Status ResourceStatus
// The ARN of the theme associated with a version of the dashboard.
ThemeArn *string
// Version number for this version of the dashboard.
VersionNumber *int64
noSmithyDocumentSerde
}
// The contents of a dashboard.
type DashboardVersionDefinition struct {
// An array of dataset identifier declarations. With this mapping,you can use
// dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout
// the dashboard's sub-structures.
//
// This member is required.
DataSetIdentifierDeclarations []DataSetIdentifierDeclaration
// The configuration for default analysis settings.
AnalysisDefaults *AnalysisDefaults
// An array of calculated field definitions for the dashboard.
CalculatedFields []CalculatedField
// An array of dashboard-level column configurations. Column configurations are
// used to set the default formatting for a column that is used throughout a
// dashboard.
ColumnConfigurations []ColumnConfiguration
// The filter definitions for a dashboard. For more information, see Filtering
// Data in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html)
// in the Amazon QuickSight User Guide.
FilterGroups []FilterGroup
// The parameter declarations for a dashboard. Parameters are named variables that
// can transfer a value for use by an action or an object. For more information,
// see Parameters in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html)
// in the Amazon QuickSight User Guide.
ParameterDeclarations []ParameterDeclaration
// An array of sheet definitions for a dashboard.
Sheets []SheetDefinition
noSmithyDocumentSerde
}
// Dashboard version summary.
type DashboardVersionSummary struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// The time that this dashboard version was created.
CreatedTime *time.Time
// Description.
Description *string
// Source entity ARN.
SourceEntityArn *string
// The HTTP status of the request.
Status ResourceStatus
// Version number.
VersionNumber *int64
noSmithyDocumentSerde
}
// A structure that contains the following elements:
// - The DashboardId of the dashboard that has the visual that you want to embed.
// - The SheetId of the sheet that has the visual that you want to embed.
// - The VisualId of the visual that you want to embed.
//
// The DashboardId , SheetId , and VisualId can be found in the IDs for developers
// section of the Embed visual pane of the visual's on-visual menu of the Amazon
// QuickSight console. You can also get the DashboardId with a ListDashboards API
// operation.
type DashboardVisualId struct {
// The ID of the dashboard that has the visual that you want to embed. The
// DashboardId can be found in the IDs for developers section of the Embed visual
// pane of the visual's on-visual menu of the Amazon QuickSight console. You can
// also get the DashboardId with a ListDashboards API operation.
//
// This member is required.
DashboardId *string
// The ID of the sheet that the has visual that you want to embed. The SheetId can
// be found in the IDs for developers section of the Embed visual pane of the
// visual's on-visual menu of the Amazon QuickSight console.
//
// This member is required.
SheetId *string
// The ID of the visual that you want to embed. The VisualID can be found in the
// IDs for developers section of the Embed visual pane of the visual's on-visual
// menu of the Amazon QuickSight console.
//
// This member is required.
VisualId *string
noSmithyDocumentSerde
}
// The visual publish options of a visual in a dashboard
type DashboardVisualPublishOptions struct {
// Determines if hidden fields are included in an exported dashboard.
ExportHiddenFieldsOption *ExportHiddenFieldsOption
noSmithyDocumentSerde
}
// A structure that represents a data aggregation.
type DataAggregation struct {
// The level of time precision that is used to aggregate DateTime values.
DatasetRowDateGranularity TopicTimeGranularity
// The column name for the default date.
DefaultDateColumnName *string
noSmithyDocumentSerde
}
// The options for data bars.
type DataBarsOptions struct {
// The field ID for the data bars options.
//
// This member is required.
FieldId *string
// The color of the negative data bar.
NegativeColor *string
// The color of the positive data bar.
PositiveColor *string
noSmithyDocumentSerde
}
// The required parameters that are needed to connect to a Databricks data source.
type DatabricksParameters struct {
// The host name of the Databricks data source.
//
// This member is required.
Host *string
// The port for the Databricks data source.
//
// This member is required.
Port int32
// The HTTP path of the Databricks data source.
//
// This member is required.
SqlEndpointPath *string
noSmithyDocumentSerde
}
// Determines the color that is applied to a particular data value.
type DataColor struct {
// The color that is applied to the data value.
Color *string
// The data value that the color is applied to.
DataValue *float64
noSmithyDocumentSerde
}
// The theme colors that are used for data colors in charts. The colors
// description is a hexadecimal color code that consists of six alphanumerical
// characters, prefixed with # , for example #37BFF5.
type DataColorPalette struct {
// The hexadecimal codes for the colors.
Colors []string
// The hexadecimal code of a color that applies to charts where a lack of data is
// highlighted.
EmptyFillColor *string
// The minimum and maximum hexadecimal codes that describe a color gradient.
MinMaxGradient []string
noSmithyDocumentSerde
}
// The data field series item configuration of a line chart.
type DataFieldSeriesItem struct {
// The axis that you are binding the field to.
//
// This member is required.
AxisBinding AxisBinding
// The field ID of the field that you are setting the axis binding to.
//
// This member is required.
FieldId *string
// The field value of the field that you are setting the axis binding to.
FieldValue *string
// The options that determine the presentation of line series associated to the
// field.
Settings *LineChartSeriesSettings
noSmithyDocumentSerde
}
// The options that determine the presentation of the data labels.
type DataLabelOptions struct {
// Determines the visibility of the category field labels.
CategoryLabelVisibility Visibility
// The option that determines the data label type.
DataLabelTypes []DataLabelType
// Determines the color of the data labels.
LabelColor *string
// Determines the content of the data labels.
LabelContent DataLabelContent
// Determines the font configuration of the data labels.
LabelFontConfiguration *FontConfiguration
// Determines the visibility of the measure field labels.
MeasureLabelVisibility Visibility
// Determines whether overlap is enabled or disabled for the data labels.
Overlap DataLabelOverlap
// Determines the position of the data labels.
Position DataLabelPosition
// Determines the visibility of the total.
TotalsVisibility Visibility
// Determines the visibility of the data labels.
Visibility Visibility
noSmithyDocumentSerde
}
// The option that determines the data label type. This is a union type structure.
// For this structure to be valid, only one of the attributes can be defined.
type DataLabelType struct {
// The option that specifies individual data values for labels.
DataPathLabelType *DataPathLabelType
// Determines the label configuration for the entire field.
FieldLabelType *FieldLabelType
// Determines the label configuration for the maximum value in a visual.
MaximumLabelType *MaximumLabelType
// Determines the label configuration for the minimum value in a visual.
MinimumLabelType *MinimumLabelType
// Determines the label configuration for range end value in a visual.
RangeEndsLabelType *RangeEndsLabelType
noSmithyDocumentSerde
}
// The color map that determines the color options for a particular element.
type DataPathColor struct {
// The color that needs to be applied to the element.
//
// This member is required.
Color *string
// The element that the color needs to be applied to.
//
// This member is required.
Element *DataPathValue
// The time granularity of the field that the color needs to be applied to.
TimeGranularity TimeGranularity
noSmithyDocumentSerde
}
// The option that specifies individual data values for labels.
type DataPathLabelType struct {
// The field ID of the field that the data label needs to be applied to.
FieldId *string
// The actual value of the field that is labeled.
FieldValue *string
// The visibility of the data label.
Visibility Visibility
noSmithyDocumentSerde
}
// Allows data paths to be sorted by a specific data value.
type DataPathSort struct {
// Determines the sort direction.
//
// This member is required.
Direction SortDirection
// The list of data paths that need to be sorted.
//
// This member is required.
SortPaths []DataPathValue
noSmithyDocumentSerde
}
// The data path that needs to be sorted.
type DataPathValue struct {
// The field ID of the field that needs to be sorted.
//
// This member is required.
FieldId *string
// The actual value of the field that needs to be sorted.
//
// This member is required.
FieldValue *string
noSmithyDocumentSerde
}
// The drill down options for data points in a dashbaord.
type DataPointDrillUpDownOption struct {
// The status of the drill down options of data points.
AvailabilityStatus DashboardBehavior
noSmithyDocumentSerde
}
// The data point menu options of a dashboard.
type DataPointMenuLabelOption struct {
// The status of the data point menu options.
AvailabilityStatus DashboardBehavior
noSmithyDocumentSerde
}
// The data point tooltip options.
type DataPointTooltipOption struct {
// The status of the data point tool tip options.
AvailabilityStatus DashboardBehavior
noSmithyDocumentSerde
}
// Dataset.
type DataSet struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// Groupings of columns that work together in certain Amazon QuickSight features.
// Currently, only geospatial hierarchy is supported.
ColumnGroups []ColumnGroup
// A set of one or more definitions of a ColumnLevelPermissionRule (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html)
// .
ColumnLevelPermissionRules []ColumnLevelPermissionRule
// The amount of SPICE capacity used by this dataset. This is 0 if the dataset
// isn't imported into SPICE.
ConsumedSpiceCapacityInBytes int64
// The time that this dataset was created.
CreatedTime *time.Time
// The ID of the dataset.
DataSetId *string
// The usage configuration to apply to child datasets that reference this dataset
// as a source.
DataSetUsageConfiguration *DataSetUsageConfiguration
// The parameters that are declared in a dataset.
DatasetParameters []DatasetParameter
// The folder that contains fields and nested subfolders for your dataset.
FieldFolders map[string]FieldFolder
// A value that indicates whether you want to import the data into SPICE.
ImportMode DataSetImportMode
// The last time that this dataset was updated.
LastUpdatedTime *time.Time
// Configures the combination and transformation of the data from the physical
// tables.
LogicalTableMap map[string]LogicalTable
// A display name for the dataset.
Name *string
// The list of columns after all transforms. These columns are available in
// templates, analyses, and dashboards.
OutputColumns []OutputColumn
// Declares the physical tables that are available in the underlying data sources.
PhysicalTableMap map[string]PhysicalTable
// The row-level security configuration for the dataset.
RowLevelPermissionDataSet *RowLevelPermissionDataSet
// The element you can use to define tags for row-level security.
RowLevelPermissionTagConfiguration *RowLevelPermissionTagConfiguration
noSmithyDocumentSerde
}
// Dataset configuration.
type DataSetConfiguration struct {
// A structure containing the list of column group schemas.
ColumnGroupSchemaList []ColumnGroupSchema
// Dataset schema.
DataSetSchema *DataSetSchema
// Placeholder.
Placeholder *string
noSmithyDocumentSerde
}
// A data set.
type DataSetIdentifierDeclaration struct {
// The Amazon Resource Name (ARN) of the data set.
//
// This member is required.
DataSetArn *string
// The identifier of the data set, typically the data set's name.
//
// This member is required.
Identifier *string
noSmithyDocumentSerde
}
// A structure that represents a dataset.
type DatasetMetadata struct {
// The Amazon Resource Name (ARN) of the dataset.
//
// This member is required.
DatasetArn *string
// The list of calculated field definitions.
CalculatedFields []TopicCalculatedField
// The list of column definitions.
Columns []TopicColumn
// The definition of a data aggregation.
DataAggregation *DataAggregation
// The description of the dataset.
DatasetDescription *string
// The name of the dataset.
DatasetName *string
// The list of filter definitions.
Filters []TopicFilter
// The list of named entities definitions.
NamedEntities []TopicNamedEntity
noSmithyDocumentSerde
}
// A dataset parameter.
type DatasetParameter struct {
// A date time parameter that is created in the dataset.
DateTimeDatasetParameter *DateTimeDatasetParameter
// A decimal parameter that is created in the dataset.
DecimalDatasetParameter *DecimalDatasetParameter
// An integer parameter that is created in the dataset.
IntegerDatasetParameter *IntegerDatasetParameter
// A string parameter that is created in the dataset.
StringDatasetParameter *StringDatasetParameter
noSmithyDocumentSerde
}
// Dataset reference.
type DataSetReference struct {
// Dataset Amazon Resource Name (ARN).
//
// This member is required.
DataSetArn *string
// Dataset placeholder.
//
// This member is required.
DataSetPlaceholder *string
noSmithyDocumentSerde
}
// The refresh properties of a dataset.
type DataSetRefreshProperties struct {
// The refresh configuration for a dataset.
//
// This member is required.
RefreshConfiguration *RefreshConfiguration
noSmithyDocumentSerde
}
// Dataset schema.
type DataSetSchema struct {
// A structure containing the list of column schemas.
ColumnSchemaList []ColumnSchema
noSmithyDocumentSerde
}
// A filter that you apply when searching for datasets.
type DataSetSearchFilter struct {
// The name of the value that you want to use as a filter, for example, "Name":
// "QUICKSIGHT_OWNER" . Valid values are defined as follows:
// - QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any
// datasets with that ARN listed as one of the dataset owners or viewers are
// returned. Implicit permissions from folders or groups are considered.
// - QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any datasets with
// that ARN listed as one of the owners of the dataset are returned. Implicit
// permissions from folders or groups are considered.
// - DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any
// datasets with that ARN listed as the only owner of the dataset are returned.
// Implicit permissions from folders or groups are not considered.
// - DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any
// datasets with that ARN listed as one of the owners if the dataset are returned.
// Implicit permissions from folders or groups are not considered.
// - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and
// any datasets with that ARN listed as one of the owners or viewers of the dataset
// are returned. Implicit permissions from folders or groups are not considered.
// - DATASET_NAME : Any datasets whose names have a substring match to this value
// will be returned.
//
// This member is required.
Name DataSetFilterAttribute
// The comparison operator that you want to use as a filter, for example
// "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
// If you set the operator value to "StringEquals" , you need to provide an
// ownership related filter in the "NAME" field and the arn of the user or group
// whose datasets you want to search in the "Value" field. For example,
// "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value":
// "arn:aws:quicksight:us-east- 1:1:user/default/UserName1" . If you set the value
// to "StringLike" , you need to provide the name of the datasets you are searching
// for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value":
// "Test" . The "StringLike" operator only supports the NAME value DATASET_NAME .
//
// This member is required.
Operator FilterOperator
// The value of the named item, in this case QUICKSIGHT_OWNER , that you want to
// use as a filter, for example, "Value":
// "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// Dataset summary.
type DataSetSummary struct {
// The Amazon Resource Name (ARN) of the dataset.
Arn *string
// A value that indicates if the dataset has column level permission configured.
ColumnLevelPermissionRulesApplied bool
// The time that this dataset was created.
CreatedTime *time.Time
// The ID of the dataset.
DataSetId *string
// A value that indicates whether you want to import the data into SPICE.
ImportMode DataSetImportMode
// The last time that this dataset was updated.
LastUpdatedTime *time.Time
// A display name for the dataset.
Name *string
// The row-level security configuration for the dataset.
RowLevelPermissionDataSet *RowLevelPermissionDataSet
// Whether or not the row level permission tags are applied.
RowLevelPermissionTagConfigurationApplied bool
noSmithyDocumentSerde
}
// The usage configuration to apply to child datasets that reference this dataset
// as a source.
type DataSetUsageConfiguration struct {
// An option that controls whether a child dataset of a direct query can use this
// dataset as a source.
DisableUseAsDirectQuerySource bool
// An option that controls whether a child dataset that's stored in QuickSight can
// use this dataset as a source.
DisableUseAsImportedSource bool
noSmithyDocumentSerde
}
// The structure of a data source.
type DataSource struct {
// A set of alternate data source parameters that you want to share for the
// credentials stored with this data source. The credentials are applied in tandem
// with the data source parameters when you copy a data source by using a create or
// update request. The API operation compares the DataSourceParameters structure
// that's in the request with the structures in the AlternateDataSourceParameters
// allow list. If the structures are an exact match, the request is allowed to use
// the credentials from this existing data source. If the
// AlternateDataSourceParameters list is null, the Credentials originally used
// with this DataSourceParameters are automatically allowed.
AlternateDataSourceParameters []DataSourceParameters
// The Amazon Resource Name (ARN) of the data source.
Arn *string
// The time that this data source was created.
CreatedTime *time.Time
// The ID of the data source. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
DataSourceId *string
// The parameters that Amazon QuickSight uses to connect to your underlying
// source. This is a variant type structure. For this structure to be valid, only
// one of the attributes can be non-null.
DataSourceParameters DataSourceParameters
// Error information from the last update or the creation of the data source.
ErrorInfo *DataSourceErrorInfo
// The last time that this data source was updated.
LastUpdatedTime *time.Time
// A display name for the data source.
Name *string
// The Amazon Resource Name (ARN) of the secret associated with the data source in
// Amazon Secrets Manager.
SecretArn *string
// Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects
// to your underlying source.
SslProperties *SslProperties
// The HTTP status of the request.
Status ResourceStatus
// The type of the data source. This type indicates which database engine the data
// source connects to.
Type DataSourceType
// The VPC connection information. You need to use this parameter only when you
// want Amazon QuickSight to use a VPC connection when connecting to your
// underlying source.
VpcConnectionProperties *VpcConnectionProperties
noSmithyDocumentSerde
}
// Data source credentials. This is a variant type structure. For this structure
// to be valid, only one of the attributes can be non-null.
type DataSourceCredentials struct {
// The Amazon Resource Name (ARN) of a data source that has the credential pair
// that you want to use. When CopySourceArn is not null, the credential pair from
// the data source in the ARN is used as the credentials for the
// DataSourceCredentials structure.
CopySourceArn *string
// Credential pair. For more information, see CredentialPair (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html)
// .
CredentialPair *CredentialPair
// The Amazon Resource Name (ARN) of the secret associated with the data source in
// Amazon Secrets Manager.
SecretArn *string
noSmithyDocumentSerde
}
// Error information for the data source creation or update.
type DataSourceErrorInfo struct {
// Error message.
Message *string
// Error type.
Type DataSourceErrorInfoType
noSmithyDocumentSerde
}
// The parameters that Amazon QuickSight uses to connect to your underlying data
// source. This is a variant type structure. For this structure to be valid, only
// one of the attributes can be non-null.
//
// The following types satisfy this interface:
//
// DataSourceParametersMemberAmazonElasticsearchParameters
// DataSourceParametersMemberAmazonOpenSearchParameters
// DataSourceParametersMemberAthenaParameters
// DataSourceParametersMemberAuroraParameters
// DataSourceParametersMemberAuroraPostgreSqlParameters
// DataSourceParametersMemberAwsIotAnalyticsParameters
// DataSourceParametersMemberDatabricksParameters
// DataSourceParametersMemberExasolParameters
// DataSourceParametersMemberJiraParameters
// DataSourceParametersMemberMariaDbParameters
// DataSourceParametersMemberMySqlParameters
// DataSourceParametersMemberOracleParameters
// DataSourceParametersMemberPostgreSqlParameters
// DataSourceParametersMemberPrestoParameters
// DataSourceParametersMemberRdsParameters
// DataSourceParametersMemberRedshiftParameters
// DataSourceParametersMemberS3Parameters
// DataSourceParametersMemberServiceNowParameters
// DataSourceParametersMemberSnowflakeParameters
// DataSourceParametersMemberSparkParameters
// DataSourceParametersMemberSqlServerParameters
// DataSourceParametersMemberTeradataParameters
// DataSourceParametersMemberTwitterParameters
type DataSourceParameters interface {
isDataSourceParameters()
}
// The parameters for OpenSearch.
type DataSourceParametersMemberAmazonElasticsearchParameters struct {
Value AmazonElasticsearchParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberAmazonElasticsearchParameters) isDataSourceParameters() {}
// The parameters for OpenSearch.
type DataSourceParametersMemberAmazonOpenSearchParameters struct {
Value AmazonOpenSearchParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberAmazonOpenSearchParameters) isDataSourceParameters() {}
// The parameters for Amazon Athena.
type DataSourceParametersMemberAthenaParameters struct {
Value AthenaParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberAthenaParameters) isDataSourceParameters() {}
// The parameters for Amazon Aurora MySQL.
type DataSourceParametersMemberAuroraParameters struct {
Value AuroraParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberAuroraParameters) isDataSourceParameters() {}
// The parameters for Amazon Aurora.
type DataSourceParametersMemberAuroraPostgreSqlParameters struct {
Value AuroraPostgreSqlParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberAuroraPostgreSqlParameters) isDataSourceParameters() {}
// The parameters for IoT Analytics.
type DataSourceParametersMemberAwsIotAnalyticsParameters struct {
Value AwsIotAnalyticsParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberAwsIotAnalyticsParameters) isDataSourceParameters() {}
// The required parameters that are needed to connect to a Databricks data source.
type DataSourceParametersMemberDatabricksParameters struct {
Value DatabricksParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberDatabricksParameters) isDataSourceParameters() {}
// The parameters for Exasol.
type DataSourceParametersMemberExasolParameters struct {
Value ExasolParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberExasolParameters) isDataSourceParameters() {}
// The parameters for Jira.
type DataSourceParametersMemberJiraParameters struct {
Value JiraParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberJiraParameters) isDataSourceParameters() {}
// The parameters for MariaDB.
type DataSourceParametersMemberMariaDbParameters struct {
Value MariaDbParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberMariaDbParameters) isDataSourceParameters() {}
// The parameters for MySQL.
type DataSourceParametersMemberMySqlParameters struct {
Value MySqlParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberMySqlParameters) isDataSourceParameters() {}
// The parameters for Oracle.
type DataSourceParametersMemberOracleParameters struct {
Value OracleParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberOracleParameters) isDataSourceParameters() {}
// The parameters for PostgreSQL.
type DataSourceParametersMemberPostgreSqlParameters struct {
Value PostgreSqlParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberPostgreSqlParameters) isDataSourceParameters() {}
// The parameters for Presto.
type DataSourceParametersMemberPrestoParameters struct {
Value PrestoParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberPrestoParameters) isDataSourceParameters() {}
// The parameters for Amazon RDS.
type DataSourceParametersMemberRdsParameters struct {
Value RdsParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberRdsParameters) isDataSourceParameters() {}
// The parameters for Amazon Redshift.
type DataSourceParametersMemberRedshiftParameters struct {
Value RedshiftParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberRedshiftParameters) isDataSourceParameters() {}
// The parameters for S3.
type DataSourceParametersMemberS3Parameters struct {
Value S3Parameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberS3Parameters) isDataSourceParameters() {}
// The parameters for ServiceNow.
type DataSourceParametersMemberServiceNowParameters struct {
Value ServiceNowParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberServiceNowParameters) isDataSourceParameters() {}
// The parameters for Snowflake.
type DataSourceParametersMemberSnowflakeParameters struct {
Value SnowflakeParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberSnowflakeParameters) isDataSourceParameters() {}
// The parameters for Spark.
type DataSourceParametersMemberSparkParameters struct {
Value SparkParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberSparkParameters) isDataSourceParameters() {}
// The parameters for SQL Server.
type DataSourceParametersMemberSqlServerParameters struct {
Value SqlServerParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberSqlServerParameters) isDataSourceParameters() {}
// The parameters for Teradata.
type DataSourceParametersMemberTeradataParameters struct {
Value TeradataParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberTeradataParameters) isDataSourceParameters() {}
// The parameters for Twitter.
type DataSourceParametersMemberTwitterParameters struct {
Value TwitterParameters
noSmithyDocumentSerde
}
func (*DataSourceParametersMemberTwitterParameters) isDataSourceParameters() {}
// A filter that you apply when searching for data sources.
type DataSourceSearchFilter struct {
// The name of the value that you want to use as a filter, for example, "Name":
// "DIRECT_QUICKSIGHT_OWNER" . Valid values are defined as follows:
// - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and
// any data sources with that ARN listed as one of the owners or viewers of the
// data sources are returned. Implicit permissions from folders or groups are not
// considered.
// - DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any data
// sources with that ARN listed as one of the owners if the data source are
// returned. Implicit permissions from folders or groups are not considered.
// - DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any
// data sources with that ARN listed as the only owner of the data source are
// returned. Implicit permissions from folders or groups are not considered.
// - DATASOURCE_NAME : Any data sources whose names have a substring match to the
// provided value are returned.
//
// This member is required.
Name DataSourceFilterAttribute
// The comparison operator that you want to use as a filter, for example
// "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
// If you set the operator value to "StringEquals" , you need to provide an
// ownership related filter in the "NAME" field and the arn of the user or group
// whose data sources you want to search in the "Value" field. For example,
// "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value":
// "arn:aws:quicksight:us-east-1:1:user/default/UserName1" . If you set the value
// to "StringLike" , you need to provide the name of the data sources you are
// searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike",
// "Value": "Test" . The "StringLike" operator only supports the NAME value
// DATASOURCE_NAME .
//
// This member is required.
Operator FilterOperator
// The value of the named item, for example DIRECT_QUICKSIGHT_OWNER , that you want
// to use as a filter, for example, "Value":
// "arn:aws:quicksight:us-east-1:1:user/default/UserName1" .
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// A DataSourceSummary object that returns a summary of a data source.
type DataSourceSummary struct {
// The arn of the datasource.
Arn *string
// The date and time that the data source was created. This value is expressed in
// MM-DD-YYYY HH:MM:SS format.
CreatedTime *time.Time
// The unique ID of the data source.
DataSourceId *string
// The date and time the data source was last updated. This value is expressed in
// MM-DD-YYYY HH:MM:SS format.
LastUpdatedTime *time.Time
// The name of the data source.
Name *string
// The type of the data source.
Type DataSourceType
noSmithyDocumentSerde
}
// The options that determine how a date axis is displayed.
type DateAxisOptions struct {
// Determines whether or not missing dates are displayed.
MissingDateVisibility Visibility
noSmithyDocumentSerde
}
// The dimension type field with date type columns.
type DateDimensionField struct {
// The column that is used in the DateDimensionField .
//
// This member is required.
Column *ColumnIdentifier
// The custom field ID.
//
// This member is required.
FieldId *string
// The date granularity of the DateDimensionField . Choose one of the following
// options:
// - YEAR
// - QUARTER
// - MONTH
// - WEEK
// - DAY
// - HOUR
// - MINUTE
// - SECOND
// - MILLISECOND
DateGranularity TimeGranularity
// The format configuration of the field.
FormatConfiguration *DateTimeFormatConfiguration
// The custom hierarchy ID.
HierarchyId *string
noSmithyDocumentSerde
}
// The measure type field with date type columns.
type DateMeasureField struct {
// The column that is used in the DateMeasureField .
//
// This member is required.
Column *ColumnIdentifier
// The custom field ID.
//
// This member is required.
FieldId *string
// The aggregation function of the measure field.
AggregationFunction DateAggregationFunction
// The format configuration of the field.
FormatConfiguration *DateTimeFormatConfiguration
noSmithyDocumentSerde
}
// A date time parameter for a dataset.
type DateTimeDatasetParameter struct {
// An identifier for the parameter that is created in the dataset.
//
// This member is required.
Id *string
// The name of the date time parameter that is created in the dataset.
//
// This member is required.
Name *string
// The value type of the dataset parameter. Valid values are single value or multi
// value .
//
// This member is required.
ValueType DatasetParameterValueType
// A list of default values for a given date time parameter. This structure only
// accepts static values.
DefaultValues *DateTimeDatasetParameterDefaultValues
// The time granularity of the date time parameter.
TimeGranularity TimeGranularity
noSmithyDocumentSerde
}
// The default values of a date time parameter.
type DateTimeDatasetParameterDefaultValues struct {
// A list of static default values for a given date time parameter.
StaticValues []time.Time
noSmithyDocumentSerde
}
// The default values of the DateTimeParameterDeclaration .
type DateTimeDefaultValues struct {
// The dynamic value of the DataTimeDefaultValues . Different defaults are
// displayed according to users, groups, and values mapping.
DynamicValue *DynamicDefaultValue
// The rolling date of the DataTimeDefaultValues . The date is determined from the
// dataset based on input expression.
RollingDate *RollingDateConfiguration
// The static values of the DataTimeDefaultValues .
StaticValues []time.Time
noSmithyDocumentSerde
}
// Formatting configuration for DateTime fields.
type DateTimeFormatConfiguration struct {
// Determines the DateTime format.
DateTimeFormat *string
// The options that determine the null value format configuration.
NullValueFormatConfiguration *NullValueFormatConfiguration
// The formatting configuration for numeric DateTime fields.
NumericFormatConfiguration *NumericFormatConfiguration
noSmithyDocumentSerde
}
// The option that determines the hierarchy of any DateTime fields.
type DateTimeHierarchy struct {
// The hierarchy ID of the DateTime hierarchy.
//
// This member is required.
HierarchyId *string
// The option that determines the drill down filters for the DateTime hierarchy.
DrillDownFilters []DrillDownFilter
noSmithyDocumentSerde
}
// A date-time parameter.
type DateTimeParameter struct {
// A display name for the date-time parameter.
//
// This member is required.
Name *string
// The values for the date-time parameter.
//
// This member is required.
Values []time.Time
noSmithyDocumentSerde
}
// A parameter declaration for the DateTime data type.
type DateTimeParameterDeclaration struct {
// The name of the parameter that is being declared.
//
// This member is required.
Name *string
// The default values of a parameter. If the parameter is a single-value
// parameter, a maximum of one default value can be provided.
DefaultValues *DateTimeDefaultValues
// A list of dataset parameters that are mapped to an analysis parameter.
MappedDataSetParameters []MappedDataSetParameter
// The level of time precision that is used to aggregate DateTime values.
TimeGranularity TimeGranularity
// The configuration that defines the default value of a DateTime parameter when a
// value has not been set.
ValueWhenUnset *DateTimeValueWhenUnsetConfiguration
noSmithyDocumentSerde
}
// The display options of a control.
type DateTimePickerControlDisplayOptions struct {
// Customize how dates are formatted in controls.
DateTimeFormat *string
// The options to configure the title visibility, name, and font size.
TitleOptions *LabelOptions
noSmithyDocumentSerde
}
// The configuration that defines the default value of a DateTime parameter when a
// value has not been set.
type DateTimeValueWhenUnsetConfiguration struct {
// A custom value that's used when the value of a parameter isn't set.
CustomValue *time.Time
// The built-in options for default values. The value can be one of the following:
// - RECOMMENDED : The recommended value.
// - NULL : The NULL value.
ValueWhenUnsetOption ValueWhenUnsetOption
noSmithyDocumentSerde
}
// A decimal parameter for a dataset.
type DecimalDatasetParameter struct {
// An identifier for the decimal parameter created in the dataset.
//
// This member is required.
Id *string
// The name of the decimal parameter that is created in the dataset.
//
// This member is required.
Name *string
// The value type of the dataset parameter. Valid values are single value or multi
// value .
//
// This member is required.
ValueType DatasetParameterValueType
// A list of default values for a given decimal parameter. This structure only
// accepts static values.
DefaultValues *DecimalDatasetParameterDefaultValues
noSmithyDocumentSerde
}
// The default values of a decimal parameter.
type DecimalDatasetParameterDefaultValues struct {
// A list of static default values for a given decimal parameter.
StaticValues []float64
noSmithyDocumentSerde
}
// The default values of the DecimalParameterDeclaration .
type DecimalDefaultValues struct {
// The dynamic value of the DecimalDefaultValues . Different defaults are displayed
// according to users, groups, and values mapping.
DynamicValue *DynamicDefaultValue
// The static values of the DecimalDefaultValues .
StaticValues []float64
noSmithyDocumentSerde
}
// A decimal parameter.
type DecimalParameter struct {
// A display name for the decimal parameter.
//
// This member is required.
Name *string
// The values for the decimal parameter.
//
// This member is required.
Values []float64
noSmithyDocumentSerde
}
// A parameter declaration for the Decimal data type.
type DecimalParameterDeclaration struct {
// The name of the parameter that is being declared.
//
// This member is required.
Name *string
// The value type determines whether the parameter is a single-value or
// multi-value parameter.
//
// This member is required.
ParameterValueType ParameterValueType
// The default values of a parameter. If the parameter is a single-value
// parameter, a maximum of one default value can be provided.
DefaultValues *DecimalDefaultValues
// A list of dataset parameters that are mapped to an analysis parameter.
MappedDataSetParameters []MappedDataSetParameter
// The configuration that defines the default value of a Decimal parameter when a
// value has not been set.
ValueWhenUnset *DecimalValueWhenUnsetConfiguration
noSmithyDocumentSerde
}
// The option that determines the decimal places configuration.
type DecimalPlacesConfiguration struct {
// The values of the decimal places.
//
// This member is required.
DecimalPlaces *int64
noSmithyDocumentSerde
}
// The configuration that defines the default value of a Decimal parameter when a
// value has not been set.
type DecimalValueWhenUnsetConfiguration struct {
// A custom value that's used when the value of a parameter isn't set.
CustomValue *float64
// The built-in options for default values. The value can be one of the following:
// - RECOMMENDED : The recommended value.
// - NULL : The NULL value.
ValueWhenUnsetOption ValueWhenUnsetOption
noSmithyDocumentSerde
}
// A structure that represents a default formatting definition.
type DefaultFormatting struct {
// The display format. Valid values for this structure are AUTO , PERCENT ,
// CURRENCY , NUMBER , DATE , and STRING .
DisplayFormat DisplayFormat
// The additional options for display formatting.
DisplayFormatOptions *DisplayFormatOptions
noSmithyDocumentSerde
}
// The options that determine the default settings of a free-form layout
// configuration.
type DefaultFreeFormLayoutConfiguration struct {
// Determines the screen canvas size options for a free-form layout.
//
// This member is required.
CanvasSizeOptions *FreeFormLayoutCanvasSizeOptions
noSmithyDocumentSerde
}
// The options that determine the default settings for a grid layout configuration.
type DefaultGridLayoutConfiguration struct {
// Determines the screen canvas size options for a grid layout.
//
// This member is required.
CanvasSizeOptions *GridLayoutCanvasSizeOptions
noSmithyDocumentSerde
}
// The options that determine the default settings for interactive layout
// configuration.
type DefaultInteractiveLayoutConfiguration struct {
// The options that determine the default settings of a free-form layout
// configuration.
FreeForm *DefaultFreeFormLayoutConfiguration
// The options that determine the default settings for a grid layout configuration.
Grid *DefaultGridLayoutConfiguration
noSmithyDocumentSerde
}
// The configuration for default new sheet settings.
type DefaultNewSheetConfiguration struct {
// The options that determine the default settings for interactive layout
// configuration.
InteractiveLayoutConfiguration *DefaultInteractiveLayoutConfiguration
// The options that determine the default settings for a paginated layout
// configuration.
PaginatedLayoutConfiguration *DefaultPaginatedLayoutConfiguration
// The option that determines the sheet content type.
SheetContentType SheetContentType
noSmithyDocumentSerde
}
// The options that determine the default settings for a paginated layout
// configuration.
type DefaultPaginatedLayoutConfiguration struct {
// The options that determine the default settings for a section-based layout
// configuration.
SectionBased *DefaultSectionBasedLayoutConfiguration
noSmithyDocumentSerde
}
// The options that determine the default settings for a section-based layout
// configuration.
type DefaultSectionBasedLayoutConfiguration struct {
// Determines the screen canvas size options for a section-based layout.
//
// This member is required.
CanvasSizeOptions *SectionBasedLayoutCanvasSizeOptions
noSmithyDocumentSerde
}
// The configuration of destination parameter values. This is a union type
// structure. For this structure to be valid, only one of the attributes can be
// defined.
type DestinationParameterValueConfiguration struct {
// The configuration of custom values for destination parameter in
// DestinationParameterValueConfiguration .
CustomValuesConfiguration *CustomValuesConfiguration
// The configuration that selects all options.
SelectAllValueOptions SelectAllValueOptions
// A column of a data set.
SourceColumn *ColumnIdentifier
// The source field ID of the destination parameter.
SourceField *string
// The source parameter name of the destination parameter.
SourceParameterName *string
noSmithyDocumentSerde
}
// The dimension type field.
type DimensionField struct {
// The dimension type field with categorical type columns.
CategoricalDimensionField *CategoricalDimensionField
// The dimension type field with date type columns.
DateDimensionField *DateDimensionField
// The dimension type field with numerical type columns.
NumericalDimensionField *NumericalDimensionField
noSmithyDocumentSerde
}
// A structure that represents additional options for display formatting.
type DisplayFormatOptions struct {
// Determines the blank cell format.
BlankCellFormat *string
// The currency symbol, such as USD .
CurrencySymbol *string
// Determines the DateTime format.
DateFormat *string
// Determines the decimal separator.
DecimalSeparator TopicNumericSeparatorSymbol
// Determines the number of fraction digits.
FractionDigits int32
// Determines the grouping separator.
GroupingSeparator *string
// The negative format.
NegativeFormat *NegativeFormat
// The prefix value for a display format.
Prefix *string
// The suffix value for a display format.
Suffix *string
// The unit scaler. Valid values for this structure are: NONE , AUTO , THOUSANDS ,
// MILLIONS , BILLIONS , and TRILLIONS .
UnitScaler NumberScale
// A Boolean value that indicates whether to use blank cell format.
UseBlankCellFormat bool
// A Boolean value that indicates whether to use grouping.
UseGrouping bool
noSmithyDocumentSerde
}
// The label options of the label that is displayed in the center of a donut
// chart. This option isn't available for pie charts.
type DonutCenterOptions struct {
// Determines the visibility of the label in a donut chart. In the Amazon
// QuickSight console, this option is called 'Show total' .
LabelVisibility Visibility
noSmithyDocumentSerde
}
// The options for configuring a donut chart or pie chart.
type DonutOptions struct {
// The option for define the arc of the chart shape. Valid values are as follows:
// - WHOLE - A pie chart
// - SMALL - A small-sized donut chart
// - MEDIUM - A medium-sized donut chart
// - LARGE - A large-sized donut chart
ArcOptions *ArcOptions
// The label options of the label that is displayed in the center of a donut
// chart. This option isn't available for pie charts.
DonutCenterOptions *DonutCenterOptions
noSmithyDocumentSerde
}
// The drill down filter for the column hierarchies. This is a union type
// structure. For this structure to be valid, only one of the attributes can be
// defined.
type DrillDownFilter struct {
// The category type drill down filter. This filter is used for string type
// columns.
CategoryFilter *CategoryDrillDownFilter
// The numeric equality type drill down filter. This filter is used for number
// type columns.
NumericEqualityFilter *NumericEqualityDrillDownFilter
// The time range drill down filter. This filter is used for date time columns.
TimeRangeFilter *TimeRangeDrillDownFilter
noSmithyDocumentSerde
}
// The display options of a control.
type DropDownControlDisplayOptions struct {
// The configuration of the Select all options in a dropdown control.
SelectAllOptions *ListControlSelectAllOptions
// The options to configure the title visibility, name, and font size.
TitleOptions *LabelOptions
noSmithyDocumentSerde
}
// Defines different defaults to the users or groups based on mapping.
type DynamicDefaultValue struct {
// The column that contains the default value of each user or group.
//
// This member is required.
DefaultValueColumn *ColumnIdentifier
// The column that contains the group name.
GroupNameColumn *ColumnIdentifier
// The column that contains the username.
UserNameColumn *ColumnIdentifier
noSmithyDocumentSerde
}
// An empty visual. Empty visuals are used in layouts but have not been configured
// to show any data. A new visual created in the Amazon QuickSight console is
// considered an EmptyVisual until a visual type is selected.
type EmptyVisual struct {
// The data set that is used in the empty visual. Every visual requires a dataset
// to render.
//
// This member is required.
DataSetIdentifier *string
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers.
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
noSmithyDocumentSerde
}
// An object, structure, or sub-structure of an analysis, template, or dashboard.
type Entity struct {
// The hierarchical path of the entity within the analysis, template, or dashboard
// definition tree.
Path *string
noSmithyDocumentSerde
}
// Error information for the SPICE ingestion of a dataset.
type ErrorInfo struct {
// Error message.
Message *string
// Error type.
Type IngestionErrorType
noSmithyDocumentSerde
}
// The required parameters for connecting to an Exasol data source.
type ExasolParameters struct {
// The hostname or IP address of the Exasol data source.
//
// This member is required.
Host *string
// The port for the Exasol data source.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// The exclude period of TimeRangeFilter or RelativeDatesFilter .
type ExcludePeriodConfiguration struct {
// The amount or number of the exclude period.
//
// This member is required.
Amount *int32
// The granularity or unit (day, month, year) of the exclude period.
//
// This member is required.
Granularity TimeGranularity
// The status of the exclude period. Choose from the following options:
// - ENABLED
// - DISABLED
Status WidgetStatus
noSmithyDocumentSerde
}
// The option that determines the hierarchy of the fields that are built within a
// visual's field wells. These fields can't be duplicated to other visuals.
type ExplicitHierarchy struct {
// The list of columns that define the explicit hierarchy.
//
// This member is required.
Columns []ColumnIdentifier
// The hierarchy ID of the explicit hierarchy.
//
// This member is required.
HierarchyId *string
// The option that determines the drill down filters for the explicit hierarchy.
DrillDownFilters []DrillDownFilter
noSmithyDocumentSerde
}
// Determines if hidden fields are included in an exported dashboard.
type ExportHiddenFieldsOption struct {
// The status of the export hidden fields options of a dashbaord.
AvailabilityStatus DashboardBehavior
noSmithyDocumentSerde
}
// Export to .csv option.
type ExportToCSVOption struct {
// Availability status.
AvailabilityStatus DashboardBehavior
noSmithyDocumentSerde
}
// Determines whether or not hidden fields are visible on exported dashbaords.
type ExportWithHiddenFieldsOption struct {
// The status of the export with hidden fields options.
AvailabilityStatus DashboardBehavior
noSmithyDocumentSerde
}
// The setup for the detailed tooltip.
type FieldBasedTooltip struct {
// The visibility of Show aggregations .
AggregationVisibility Visibility
// The fields configuration in the tooltip.
TooltipFields []TooltipItem
// The type for the >tooltip title. Choose one of the following options:
// - NONE : Doesn't use the primary value as the title.
// - PRIMARY_VALUE : Uses primary value as the title.
TooltipTitleType TooltipTitleType
noSmithyDocumentSerde
}
// A FieldFolder element is a folder that contains fields and nested subfolders.
type FieldFolder struct {
// A folder has a list of columns. A column can only be in one folder.
Columns []string
// The description for a field folder.
Description *string
noSmithyDocumentSerde
}
// The field label type.
type FieldLabelType struct {
// Indicates the field that is targeted by the field label.
FieldId *string
// The visibility of the field label.
Visibility Visibility
noSmithyDocumentSerde
}
// The field series item configuration of a line chart.
type FieldSeriesItem struct {
// The axis that you are binding the field to.
//
// This member is required.
AxisBinding AxisBinding
// The field ID of the field for which you are setting the axis binding.
//
// This member is required.
FieldId *string
// The options that determine the presentation of line series associated to the
// field.
Settings *LineChartSeriesSettings
noSmithyDocumentSerde
}
// The sort configuration for a field in a field well.
type FieldSort struct {
// The sort direction. Choose one of the following options:
// - ASC : Ascending
// - DESC : Descending
//
// This member is required.
Direction SortDirection
// The sort configuration target field.
//
// This member is required.
FieldId *string
noSmithyDocumentSerde
}
// The field sort options in a chart configuration.
type FieldSortOptions struct {
// The sort configuration for a column that is not used in a field well.
ColumnSort *ColumnSort
// The sort configuration for a field in a field well.
FieldSort *FieldSort
noSmithyDocumentSerde
}
// The tooltip item for the fields.
type FieldTooltipItem struct {
// The unique ID of the field that is targeted by the tooltip.
//
// This member is required.
FieldId *string
// The label of the tooltip item.
Label *string
// The visibility of the tooltip item.
Visibility Visibility
noSmithyDocumentSerde
}
// The aggregated field well of the filled map.
type FilledMapAggregatedFieldWells struct {
// The aggregated location field well of the filled map. Values are grouped by
// location fields.
Geospatial []DimensionField
// The aggregated color field well of a filled map. Values are aggregated based on
// location fields.
Values []MeasureField
noSmithyDocumentSerde
}
// The conditional formatting of a FilledMapVisual .
type FilledMapConditionalFormatting struct {
// Conditional formatting options of a FilledMapVisual .
//
// This member is required.
ConditionalFormattingOptions []FilledMapConditionalFormattingOption
noSmithyDocumentSerde
}
// Conditional formatting options of a FilledMapVisual .
type FilledMapConditionalFormattingOption struct {
// The conditional formatting that determines the shape of the filled map.
//
// This member is required.
Shape *FilledMapShapeConditionalFormatting
noSmithyDocumentSerde
}
// The configuration for a FilledMapVisual .
type FilledMapConfiguration struct {
// The field wells of the visual.
FieldWells *FilledMapFieldWells
// The legend display setup of the visual.
Legend *LegendOptions
// The map style options of the filled map visual.
MapStyleOptions *GeospatialMapStyleOptions
// The sort configuration of a FilledMapVisual .
SortConfiguration *FilledMapSortConfiguration
// The tooltip display setup of the visual.
Tooltip *TooltipOptions
// The window options of the filled map visual.
WindowOptions *GeospatialWindowOptions
noSmithyDocumentSerde
}
// The field wells of a FilledMapVisual . This is a union type structure. For this
// structure to be valid, only one of the attributes can be defined.
type FilledMapFieldWells struct {
// The aggregated field well of the filled map.
FilledMapAggregatedFieldWells *FilledMapAggregatedFieldWells
noSmithyDocumentSerde
}
// The conditional formatting that determines the shape of the filled map.
type FilledMapShapeConditionalFormatting struct {
// The field ID of the filled map shape.
//
// This member is required.
FieldId *string
// The conditional formatting that determines the background color of a filled
// map's shape.
Format *ShapeConditionalFormat
noSmithyDocumentSerde
}
// The sort configuration of a FilledMapVisual .
type FilledMapSortConfiguration struct {
// The sort configuration of the location fields.
CategorySort []FieldSortOptions
noSmithyDocumentSerde
}
// A filled map. For more information, see Creating filled maps (https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html)
// in the Amazon QuickSight User Guide.
type FilledMapVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers..
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration settings of the visual.
ChartConfiguration *FilledMapConfiguration
// The column hierarchy that is used during drill-downs and drill-ups.
ColumnHierarchies []ColumnHierarchy
// The conditional formatting of a FilledMapVisual .
ConditionalFormatting *FilledMapConditionalFormatting
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// With a Filter , you can remove portions of data from a particular visual or
// view. This is a union type structure. For this structure to be valid, only one
// of the attributes can be defined.
type Filter struct {
// A CategoryFilter filters text values. For more information, see Adding text
// filters (https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html)
// in the Amazon QuickSight User Guide.
CategoryFilter *CategoryFilter
// A NumericEqualityFilter filters numeric values that equal or do not equal a
// given numeric value.
NumericEqualityFilter *NumericEqualityFilter
// A NumericRangeFilter filters numeric values that are either inside or outside a
// given numeric range.
NumericRangeFilter *NumericRangeFilter
// A RelativeDatesFilter filters date values that are relative to a given date.
RelativeDatesFilter *RelativeDatesFilter
// A TimeEqualityFilter filters date-time values that equal or do not equal a
// given date/time value.
TimeEqualityFilter *TimeEqualityFilter
// A TimeRangeFilter filters date-time values that are either inside or outside a
// given date/time range.
TimeRangeFilter *TimeRangeFilter
// A TopBottomFilter filters data to the top or bottom values for a given column.
TopBottomFilter *TopBottomFilter
noSmithyDocumentSerde
}
// The control of a filter that is used to interact with a dashboard or an
// analysis. This is a union type structure. For this structure to be valid, only
// one of the attributes can be defined.
type FilterControl struct {
// A control from a date filter that is used to specify date and time.
DateTimePicker *FilterDateTimePickerControl
// A control to display a dropdown list with buttons that are used to select a
// single value.
Dropdown *FilterDropDownControl
// A control to display a list of buttons or boxes. This is used to select either
// a single value or multiple values.
List *FilterListControl
// A control from a date filter that is used to specify the relative date.
RelativeDateTime *FilterRelativeDateTimeControl
// A control to display a horizontal toggle bar. This is used to change a value by
// sliding the toggle.
Slider *FilterSliderControl
// A control to display a text box that is used to enter multiple entries.
TextArea *FilterTextAreaControl
// A control to display a text box that is used to enter a single entry.
TextField *FilterTextFieldControl
noSmithyDocumentSerde
}
// A control from a date filter that is used to specify date and time.
type FilterDateTimePickerControl struct {
// The ID of the FilterDateTimePickerControl .
//
// This member is required.
FilterControlId *string
// The source filter ID of the FilterDateTimePickerControl .
//
// This member is required.
SourceFilterId *string
// The title of the FilterDateTimePickerControl .
//
// This member is required.
Title *string
// The display options of a control.
DisplayOptions *DateTimePickerControlDisplayOptions
// The date time picker type of a FilterDateTimePickerControl . Choose one of the
// following options:
// - SINGLE_VALUED : The filter condition is a fixed date.
// - DATE_RANGE : The filter condition is a date time range.
Type SheetControlDateTimePickerType
noSmithyDocumentSerde
}
// A control to display a dropdown list with buttons that are used to select a
// single value.
type FilterDropDownControl struct {
// The ID of the FilterDropDownControl .
//
// This member is required.
FilterControlId *string
// The source filter ID of the FilterDropDownControl .
//
// This member is required.
SourceFilterId *string
// The title of the FilterDropDownControl .
//
// This member is required.
Title *string
// The values that are displayed in a control can be configured to only show
// values that are valid based on what's selected in other controls.
CascadingControlConfiguration *CascadingControlConfiguration
// The display options of the FilterDropDownControl .
DisplayOptions *DropDownControlDisplayOptions
// A list of selectable values that are used in a control.
SelectableValues *FilterSelectableValues
// The type of the FilterDropDownControl . Choose one of the following options:
// - MULTI_SELECT : The user can select multiple entries from a dropdown menu.
// - SINGLE_SELECT : The user can select a single entry from a dropdown menu.
Type SheetControlListType
noSmithyDocumentSerde
}
// A grouping of individual filters. Filter groups are applied to the same group
// of visuals. For more information, see Adding filter conditions (group filters)
// with AND and OR operators (https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html)
// in the Amazon QuickSight User Guide.
type FilterGroup struct {
// The filter new feature which can apply filter group to all data sets. Choose
// one of the following options:
// - ALL_DATASETS
// - SINGLE_DATASET
//
// This member is required.
CrossDataset CrossDatasetTypes
// The value that uniquely identifies a FilterGroup within a dashboard, template,
// or analysis.
//
// This member is required.
FilterGroupId *string
// The list of filters that are present in a FilterGroup .
//
// This member is required.
Filters []Filter
// The configuration that specifies what scope to apply to a FilterGroup . This is
// a union type structure. For this structure to be valid, only one of the
// attributes can be defined.
//
// This member is required.
ScopeConfiguration *FilterScopeConfiguration
// The status of the FilterGroup .
Status WidgetStatus
noSmithyDocumentSerde
}
// A list of filter configurations.
type FilterListConfiguration struct {
// The match operator that is used to determine if a filter should be applied.
//
// This member is required.
MatchOperator CategoryFilterMatchOperator
// The list of category values for the filter.
CategoryValues []string
// Select all of the values. Null is not the assigned value of select all.
// - FILTER_ALL_VALUES
SelectAllOptions CategoryFilterSelectAllOptions
noSmithyDocumentSerde
}
// A control to display a list of buttons or boxes. This is used to select either
// a single value or multiple values.
type FilterListControl struct {
// The ID of the FilterListControl .
//
// This member is required.
FilterControlId *string
// The source filter ID of the FilterListControl .
//
// This member is required.
SourceFilterId *string
// The title of the FilterListControl .
//
// This member is required.
Title *string
// The values that are displayed in a control can be configured to only show
// values that are valid based on what's selected in other controls.
CascadingControlConfiguration *CascadingControlConfiguration
// The display options of a control.
DisplayOptions *ListControlDisplayOptions
// A list of selectable values that are used in a control.
SelectableValues *FilterSelectableValues
// The type of FilterListControl . Choose one of the following options:
// - MULTI_SELECT : The user can select multiple entries from the list.
// - SINGLE_SELECT : The user can select a single entry from the list.
Type SheetControlListType
noSmithyDocumentSerde
}
// A transform operation that filters rows based on a condition.
type FilterOperation struct {
// An expression that must evaluate to a Boolean value. Rows for which the
// expression evaluates to true are kept in the dataset.
//
// This member is required.
ConditionExpression *string
noSmithyDocumentSerde
}
// The configuration of selected fields in the CustomActionFilterOperation . This
// is a union type structure. For this structure to be valid, only one of the
// attributes can be defined.
type FilterOperationSelectedFieldsConfiguration struct {
// The selected columns of a dataset.
SelectedColumns []ColumnIdentifier
// A structure that contains the options that choose which fields are filtered in
// the CustomActionFilterOperation . Valid values are defined as follows:
// - ALL_FIELDS : Applies the filter operation to all fields.
SelectedFieldOptions SelectedFieldOptions
// Chooses the fields that are filtered in CustomActionFilterOperation .
SelectedFields []string
noSmithyDocumentSerde
}
// The configuration of target visuals that you want to be filtered. This is a
// union type structure. For this structure to be valid, only one of the attributes
// can be defined.
type FilterOperationTargetVisualsConfiguration struct {
// The configuration of the same-sheet target visuals that you want to be filtered.
SameSheetTargetVisualConfiguration *SameSheetTargetVisualConfiguration
noSmithyDocumentSerde
}
// A control from a date filter that is used to specify the relative date.
type FilterRelativeDateTimeControl struct {
// The ID of the FilterTextAreaControl .
//
// This member is required.
FilterControlId *string
// The source filter ID of the FilterTextAreaControl .
//
// This member is required.
SourceFilterId *string
// The title of the FilterTextAreaControl .
//
// This member is required.
Title *string
// The display options of a control.
DisplayOptions *RelativeDateTimeControlDisplayOptions
noSmithyDocumentSerde
}
// The scope configuration for a FilterGroup . This is a union type structure. For
// this structure to be valid, only one of the attributes can be defined.
type FilterScopeConfiguration struct {
// The configuration for applying a filter to specific sheets.
SelectedSheets *SelectedSheetsFilterScopeConfiguration
noSmithyDocumentSerde
}
// A list of selectable values that are used in a control.
type FilterSelectableValues struct {
// The values that are used in the FilterSelectableValues .
Values []string
noSmithyDocumentSerde
}
// A control to display a horizontal toggle bar. This is used to change a value by
// sliding the toggle.
type FilterSliderControl struct {
// The ID of the FilterSliderControl .
//
// This member is required.
FilterControlId *string
// The smaller value that is displayed at the left of the slider.
//
// This member is required.
MaximumValue float64
// The larger value that is displayed at the right of the slider.
//
// This member is required.
MinimumValue float64
// The source filter ID of the FilterSliderControl .
//
// This member is required.
SourceFilterId *string
// The number of increments that the slider bar is divided into.
//
// This member is required.
StepSize float64
// The title of the FilterSliderControl .
//
// This member is required.
Title *string
// The display options of a control.
DisplayOptions *SliderControlDisplayOptions
// The type of FilterSliderControl . Choose one of the following options:
// - SINGLE_POINT : Filter against(equals) a single data point.
// - RANGE : Filter data that is in a specified range.
Type SheetControlSliderType
noSmithyDocumentSerde
}
// A control to display a text box that is used to enter multiple entries.
type FilterTextAreaControl struct {
// The ID of the FilterTextAreaControl .
//
// This member is required.
FilterControlId *string
// The source filter ID of the FilterTextAreaControl .
//
// This member is required.
SourceFilterId *string
// The title of the FilterTextAreaControl .
//
// This member is required.
Title *string
// The delimiter that is used to separate the lines in text.
Delimiter *string
// The display options of a control.
DisplayOptions *TextAreaControlDisplayOptions
noSmithyDocumentSerde
}
// A control to display a text box that is used to enter a single entry.
type FilterTextFieldControl struct {
// The ID of the FilterTextFieldControl .
//
// This member is required.
FilterControlId *string
// The source filter ID of the FilterTextFieldControl .
//
// This member is required.
SourceFilterId *string
// The title of the FilterTextFieldControl .
//
// This member is required.
Title *string
// The display options of a control.
DisplayOptions *TextFieldControlDisplayOptions
noSmithyDocumentSerde
}
// A folder in Amazon QuickSight.
type Folder struct {
// The Amazon Resource Name (ARN) for the folder.
Arn *string
// The time that the folder was created.
CreatedTime *time.Time
// The ID of the folder.
FolderId *string
// An array of ancestor ARN strings for the folder.
FolderPath []string
// The type of folder it is.
FolderType FolderType
// The time that the folder was last updated.
LastUpdatedTime *time.Time
// A display name for the folder.
Name *string
noSmithyDocumentSerde
}
// An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or
// dataset.
type FolderMember struct {
// The ID of an asset in the folder.
MemberId *string
// The type of asset that it is.
MemberType MemberType
noSmithyDocumentSerde
}
// A filter to use to search an Amazon QuickSight folder.
type FolderSearchFilter struct {
// The name of a value that you want to use in the filter. For example, "Name":
// "QUICKSIGHT_OWNER" . Valid values are defined as follows:
// - QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and any
// folders with that ARN listed as one of the folder's owners or viewers are
// returned. Implicit permissions from folders or groups are considered.
// - QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any folders with
// that ARN listed as one of the owners of the folders are returned. Implicit
// permissions from folders or groups are considered.
// - DIRECT_QUICKSIGHT_SOLE_OWNER : Provide an ARN of a user or group, and any
// folders with that ARN listed as the only owner of the folder are returned.
// Implicit permissions from folders or groups are not considered.
// - DIRECT_QUICKSIGHT_OWNER : Provide an ARN of a user or group, and any folders
// with that ARN listed as one of the owners of the folders are returned. Implicit
// permissions from folders or groups are not considered.
// - DIRECT_QUICKSIGHT_VIEWER_OR_OWNER : Provide an ARN of a user or group, and
// any folders with that ARN listed as one of the owners or viewers of the folders
// are returned. Implicit permissions from folders or groups are not considered.
// - FOLDER_NAME : Any folders whose names have a substring match to this value
// will be returned.
// - PARENT_FOLDER_ARN : Provide an ARN of a folder, and any folders that are
// directly under that parent folder are returned. If you choose to use this option
// and leave the value blank, all root-level folders in the account are returned.
Name FolderFilterAttribute
// The comparison operator that you want to use as a filter, for example
// "Operator": "StringEquals" . Valid values are "StringEquals" and "StringLike" .
// If you set the operator value to "StringEquals" , you need to provide an
// ownership related filter in the "NAME" field and the arn of the user or group
// whose folders you want to search in the "Value" field. For example,
// "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value":
// "arn:aws:quicksight:us-east-1:1:user/default/UserName1" . If you set the value
// to "StringLike" , you need to provide the name of the folders you are searching
// for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value":
// "Test" . The "StringLike" operator only supports the NAME value FOLDER_NAME .
Operator FilterOperator
// The value of the named item (in this example, PARENT_FOLDER_ARN ), that you want
// to use as a filter. For example, "Value":
// "arn:aws:quicksight:us-east-1:1:folder/folderId" .
Value *string
noSmithyDocumentSerde
}
// A summary of information about an existing Amazon QuickSight folder.
type FolderSummary struct {
// The Amazon Resource Name (ARN) of the folder.
Arn *string
// The time that the folder was created.
CreatedTime *time.Time
// The ID of the folder.
FolderId *string
// The type of folder.
FolderType FolderType
// The time that the folder was last updated.
LastUpdatedTime *time.Time
// The display name of the folder.
Name *string
noSmithyDocumentSerde
}
// Determines the font settings.
type Font struct {
// Determines the font family settings.
FontFamily *string
noSmithyDocumentSerde
}
// Configures the display properties of the given text.
type FontConfiguration struct {
// Determines the color of the text.
FontColor *string
// Determines the appearance of decorative lines on the text.
FontDecoration FontDecoration
// The option that determines the text display size.
FontSize *FontSize
// Determines the text display face that is inherited by the given font family.
FontStyle FontStyle
// The option that determines the text display weight, or boldness.
FontWeight *FontWeight
noSmithyDocumentSerde
}
// The option that determines the text display size.
type FontSize struct {
// The lexical name for the text size, proportional to its surrounding context.
Relative RelativeFontSize
noSmithyDocumentSerde
}
// The option that determines the text display weight, or boldness.
type FontWeight struct {
// The lexical name for the level of boldness of the text display.
Name FontWeightName
noSmithyDocumentSerde
}
// The forecast computation configuration.
type ForecastComputation struct {
// The ID for a computation.
//
// This member is required.
ComputationId *string
// The time field that is used in a computation.
//
// This member is required.
Time *DimensionField
// The custom seasonality value setup of a forecast computation.
CustomSeasonalityValue *int32
// The lower boundary setup of a forecast computation.
LowerBoundary *float64
// The name of a computation.
Name *string
// The periods backward setup of a forecast computation.
PeriodsBackward *int32
// The periods forward setup of a forecast computation.
PeriodsForward *int32
// The prediction interval setup of a forecast computation.
PredictionInterval *int32
// The seasonality setup of a forecast computation. Choose one of the following
// options:
// - AUTOMATIC
// - CUSTOM : Checks the custom seasonality value.
Seasonality ForecastComputationSeasonality
// The upper boundary setup of a forecast computation.
UpperBoundary *float64
// The value field that is used in a computation.
Value *MeasureField
noSmithyDocumentSerde
}
// The forecast configuration that is used in a line chart's display properties.
type ForecastConfiguration struct {
// The forecast properties setup of a forecast in the line chart.
ForecastProperties *TimeBasedForecastProperties
// The forecast scenario of a forecast in the line chart.
Scenario *ForecastScenario
noSmithyDocumentSerde
}
// The forecast scenario of a forecast in the line chart.
type ForecastScenario struct {
// The what-if analysis forecast setup with the target date.
WhatIfPointScenario *WhatIfPointScenario
// The what-if analysis forecast setup with the date range.
WhatIfRangeScenario *WhatIfRangeScenario
noSmithyDocumentSerde
}
// The formatting configuration for all types of field.
type FormatConfiguration struct {
// Formatting configuration for DateTime fields.
DateTimeFormatConfiguration *DateTimeFormatConfiguration
// Formatting configuration for number fields.
NumberFormatConfiguration *NumberFormatConfiguration
// Formatting configuration for string fields.
StringFormatConfiguration *StringFormatConfiguration
noSmithyDocumentSerde
}
// Configuration options for the canvas of a free-form layout.
type FreeFormLayoutCanvasSizeOptions struct {
// The options that determine the sizing of the canvas used in a free-form layout.
ScreenCanvasSizeOptions *FreeFormLayoutScreenCanvasSizeOptions
noSmithyDocumentSerde
}
// The configuration of a free-form layout.
type FreeFormLayoutConfiguration struct {
// The elements that are included in a free-form layout.
//
// This member is required.
Elements []FreeFormLayoutElement
// Configuration options for the canvas of a free-form layout.
CanvasSizeOptions *FreeFormLayoutCanvasSizeOptions
noSmithyDocumentSerde
}
// An element within a free-form layout.
type FreeFormLayoutElement struct {
// A unique identifier for an element within a free-form layout.
//
// This member is required.
ElementId *string
// The type of element.
//
// This member is required.
ElementType LayoutElementType
// The height of an element within a free-form layout.
//
// This member is required.
Height *string
// The width of an element within a free-form layout.
//
// This member is required.
Width *string
// The x-axis coordinate of the element.
//
// This member is required.
XAxisLocation *string
// The y-axis coordinate of the element.
//
// This member is required.
YAxisLocation *string
// The background style configuration of a free-form layout element.
BackgroundStyle *FreeFormLayoutElementBackgroundStyle
// The border style configuration of a free-form layout element.
BorderStyle *FreeFormLayoutElementBorderStyle
// The loading animation configuration of a free-form layout element.
LoadingAnimation *LoadingAnimation
// The rendering rules that determine when an element should be displayed within a
// free-form layout.
RenderingRules []SheetElementRenderingRule
// The border style configuration of a free-form layout element. This border style
// is used when the element is selected.
SelectedBorderStyle *FreeFormLayoutElementBorderStyle
// The visibility of an element within a free-form layout.
Visibility Visibility
noSmithyDocumentSerde
}
// The background style configuration of a free-form layout element.
type FreeFormLayoutElementBackgroundStyle struct {
// The background color of a free-form layout element.
Color *string
// The background visibility of a free-form layout element.
Visibility Visibility
noSmithyDocumentSerde
}
// The background style configuration of a free-form layout element.
type FreeFormLayoutElementBorderStyle struct {
// The border color of a free-form layout element.
Color *string
// The border visibility of a free-form layout element.
Visibility Visibility
noSmithyDocumentSerde
}
// The options that determine the sizing of the canvas used in a free-form layout.
type FreeFormLayoutScreenCanvasSizeOptions struct {
// The width that the view port will be optimized for when the layout renders.
//
// This member is required.
OptimizedViewPortWidth *string
noSmithyDocumentSerde
}
// The free-form layout configuration of a section.
type FreeFormSectionLayoutConfiguration struct {
// The elements that are included in the free-form layout.
//
// This member is required.
Elements []FreeFormLayoutElement
noSmithyDocumentSerde
}
// The field well configuration of a FunnelChartVisual .
type FunnelChartAggregatedFieldWells struct {
// The category field wells of a funnel chart. Values are grouped by category
// fields.
Category []DimensionField
// The value field wells of a funnel chart. Values are aggregated based on
// categories.
Values []MeasureField
noSmithyDocumentSerde
}
// The configuration of a FunnelChartVisual .
type FunnelChartConfiguration struct {
// The label options of the categories that are displayed in a FunnelChartVisual .
CategoryLabelOptions *ChartAxisLabelOptions
// The options that determine the presentation of the data labels.
DataLabelOptions *FunnelChartDataLabelOptions
// The field well configuration of a FunnelChartVisual .
FieldWells *FunnelChartFieldWells
// The sort configuration of a FunnelChartVisual .
SortConfiguration *FunnelChartSortConfiguration
// The tooltip configuration of a FunnelChartVisual .
Tooltip *TooltipOptions
// The label options for the values that are displayed in a FunnelChartVisual .
ValueLabelOptions *ChartAxisLabelOptions
// The visual palette configuration of a FunnelChartVisual .
VisualPalette *VisualPalette
noSmithyDocumentSerde
}
// The options that determine the presentation of the data labels.
type FunnelChartDataLabelOptions struct {
// The visibility of the category labels within the data labels.
CategoryLabelVisibility Visibility
// The color of the data label text.
LabelColor *string
// The font configuration for the data labels. Only the FontSize attribute of the
// font configuration is used for data labels.
LabelFontConfiguration *FontConfiguration
// Determines the style of the metric labels.
MeasureDataLabelStyle FunnelChartMeasureDataLabelStyle
// The visibility of the measure labels within the data labels.
MeasureLabelVisibility Visibility
// Determines the positioning of the data label relative to a section of the
// funnel.
Position DataLabelPosition
// The visibility option that determines if data labels are displayed.
Visibility Visibility
noSmithyDocumentSerde
}
// The field well configuration of a FunnelChartVisual . This is a union type
// structure. For this structure to be valid, only one of the attributes can be
// defined.
type FunnelChartFieldWells struct {
// The field well configuration of a FunnelChartVisual .
FunnelChartAggregatedFieldWells *FunnelChartAggregatedFieldWells
noSmithyDocumentSerde
}
// The sort configuration of a FunnelChartVisual .
type FunnelChartSortConfiguration struct {
// The limit on the number of categories displayed.
CategoryItemsLimit *ItemsLimitConfiguration
// The sort configuration of the category fields.
CategorySort []FieldSortOptions
noSmithyDocumentSerde
}
// A funnel chart. For more information, see Using funnel charts (https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html)
// in the Amazon QuickSight User Guide.
type FunnelChartVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers..
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration of a FunnelChartVisual .
ChartConfiguration *FunnelChartConfiguration
// The column hierarchy that is used during drill-downs and drill-ups.
ColumnHierarchies []ColumnHierarchy
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// The options that determine the presentation of the arc of a GaugeChartVisual .
type GaugeChartArcConditionalFormatting struct {
// The conditional formatting of the arc foreground color.
ForegroundColor *ConditionalFormattingColor
noSmithyDocumentSerde
}
// The conditional formatting of a GaugeChartVisual .
type GaugeChartConditionalFormatting struct {
// Conditional formatting options of a GaugeChartVisual .
ConditionalFormattingOptions []GaugeChartConditionalFormattingOption
noSmithyDocumentSerde
}
// Conditional formatting options of a GaugeChartVisual .
type GaugeChartConditionalFormattingOption struct {
// The options that determine the presentation of the arc of a GaugeChartVisual .
Arc *GaugeChartArcConditionalFormatting
// The conditional formatting for the primary value of a GaugeChartVisual .
PrimaryValue *GaugeChartPrimaryValueConditionalFormatting
noSmithyDocumentSerde
}
// The configuration of a GaugeChartVisual .
type GaugeChartConfiguration struct {
// The data label configuration of a GaugeChartVisual .
DataLabels *DataLabelOptions
// The field well configuration of a GaugeChartVisual .
FieldWells *GaugeChartFieldWells
// The options that determine the presentation of the GaugeChartVisual .
GaugeChartOptions *GaugeChartOptions
// The tooltip configuration of a GaugeChartVisual .
TooltipOptions *TooltipOptions
// The visual palette configuration of a GaugeChartVisual .
VisualPalette *VisualPalette
noSmithyDocumentSerde
}
// The field well configuration of a GaugeChartVisual .
type GaugeChartFieldWells struct {
// The target value field wells of a GaugeChartVisual .
TargetValues []MeasureField
// The value field wells of a GaugeChartVisual .
Values []MeasureField
noSmithyDocumentSerde
}
// The options that determine the presentation of the GaugeChartVisual .
type GaugeChartOptions struct {
// The arc configuration of a GaugeChartVisual .
Arc *ArcConfiguration
// The arc axis configuration of a GaugeChartVisual .
ArcAxis *ArcAxisConfiguration
// The comparison configuration of a GaugeChartVisual .
Comparison *ComparisonConfiguration
// The options that determine the primary value display type.
PrimaryValueDisplayType PrimaryValueDisplayType
// The options that determine the primary value font configuration.
PrimaryValueFontConfiguration *FontConfiguration
noSmithyDocumentSerde
}
// The conditional formatting for the primary value of a GaugeChartVisual .
type GaugeChartPrimaryValueConditionalFormatting struct {
// The conditional formatting of the primary value icon.
Icon *ConditionalFormattingIcon
// The conditional formatting of the primary value text color.
TextColor *ConditionalFormattingColor
noSmithyDocumentSerde
}
// A gauge chart. For more information, see Using gauge charts (https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html)
// in the Amazon QuickSight User Guide.
type GaugeChartVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers.
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration of a GaugeChartVisual .
ChartConfiguration *GaugeChartConfiguration
// The conditional formatting of a GaugeChartVisual .
ConditionalFormatting *GaugeChartConditionalFormatting
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// Geospatial column group that denotes a hierarchy.
type GeoSpatialColumnGroup struct {
// Columns in this hierarchy.
//
// This member is required.
Columns []string
// A display name for the hierarchy.
//
// This member is required.
Name *string
// Country code.
CountryCode GeoSpatialCountryCode
noSmithyDocumentSerde
}
// The bound options (north, south, west, east) of the geospatial window options.
type GeospatialCoordinateBounds struct {
// The longitude of the east bound of the geospatial coordinate bounds.
//
// This member is required.
East *float64
// The latitude of the north bound of the geospatial coordinate bounds.
//
// This member is required.
North *float64
// The latitude of the south bound of the geospatial coordinate bounds.
//
// This member is required.
South *float64
// The longitude of the west bound of the geospatial coordinate bounds.
//
// This member is required.
West *float64
noSmithyDocumentSerde
}
// The color scale specification for the heatmap point style.
type GeospatialHeatmapColorScale struct {
// The list of colors to be used in heatmap point style.
Colors []GeospatialHeatmapDataColor
noSmithyDocumentSerde
}
// The heatmap configuration of the geospatial point style.
type GeospatialHeatmapConfiguration struct {
// The color scale specification for the heatmap point style.
HeatmapColor *GeospatialHeatmapColorScale
noSmithyDocumentSerde
}
// The color to be used in the heatmap point style.
type GeospatialHeatmapDataColor struct {
// The hex color to be used in the heatmap point style.
//
// This member is required.
Color *string
noSmithyDocumentSerde
}
// The aggregated field wells for a geospatial map.
type GeospatialMapAggregatedFieldWells struct {
// The color field wells of a geospatial map.
Colors []DimensionField
// The geospatial field wells of a geospatial map. Values are grouped by
// geospatial fields.
Geospatial []DimensionField
// The size field wells of a geospatial map. Values are aggregated based on
// geospatial fields.
Values []MeasureField
noSmithyDocumentSerde
}
// The configuration of a GeospatialMapVisual .
type GeospatialMapConfiguration struct {
// The field wells of the visual.
FieldWells *GeospatialMapFieldWells
// The legend display setup of the visual.
Legend *LegendOptions
// The map style options of the geospatial map.
MapStyleOptions *GeospatialMapStyleOptions
// The point style options of the geospatial map.
PointStyleOptions *GeospatialPointStyleOptions
// The tooltip display setup of the visual.
Tooltip *TooltipOptions
// The visual display options for the visual palette.
VisualPalette *VisualPalette
// The window options of the geospatial map.
WindowOptions *GeospatialWindowOptions
noSmithyDocumentSerde
}
// The field wells of a GeospatialMapVisual . This is a union type structure. For
// this structure to be valid, only one of the attributes can be defined.
type GeospatialMapFieldWells struct {
// The aggregated field well for a geospatial map.
GeospatialMapAggregatedFieldWells *GeospatialMapAggregatedFieldWells
noSmithyDocumentSerde
}
// The map style options of the geospatial map.
type GeospatialMapStyleOptions struct {
// The base map style of the geospatial map.
BaseMapStyle BaseMapStyleType
noSmithyDocumentSerde
}
// A geospatial map or a points on map visual. For more information, see Creating
// point maps (https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html)
// in the Amazon QuickSight User Guide.
type GeospatialMapVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers..
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration settings of the visual.
ChartConfiguration *GeospatialMapConfiguration
// The column hierarchy that is used during drill-downs and drill-ups.
ColumnHierarchies []ColumnHierarchy
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// The point style of the geospatial map.
type GeospatialPointStyleOptions struct {
// The cluster marker configuration of the geospatial point style.
ClusterMarkerConfiguration *ClusterMarkerConfiguration
// The heatmap configuration of the geospatial point style.
HeatmapConfiguration *GeospatialHeatmapConfiguration
// The selected point styles (point, cluster) of the geospatial map.
SelectedPointStyle GeospatialSelectedPointStyle
noSmithyDocumentSerde
}
// The window options of the geospatial map visual.
type GeospatialWindowOptions struct {
// The bounds options (north, south, west, east) of the geospatial window options.
Bounds *GeospatialCoordinateBounds
// The map zoom modes (manual, auto) of the geospatial window options.
MapZoomMode MapZoomMode
noSmithyDocumentSerde
}
// Determines the border options for a table visual.
type GlobalTableBorderOptions struct {
// Determines the options for side specific border.
SideSpecificBorder *TableSideBorderOptions
// Determines the options for uniform border.
UniformBorder *TableBorderOptions
noSmithyDocumentSerde
}
// Determines the gradient color settings.
type GradientColor struct {
// The list of gradient color stops.
Stops []GradientStop
noSmithyDocumentSerde
}
// Determines the gradient stop configuration.
type GradientStop struct {
// Determines gradient offset value.
//
// This member is required.
GradientOffset float64
// Determines the color.
Color *string
// Determines the data value.
DataValue *float64
noSmithyDocumentSerde
}
// Configuration options for the canvas of a grid layout.
type GridLayoutCanvasSizeOptions struct {
// The options that determine the sizing of the canvas used in a grid layout.
ScreenCanvasSizeOptions *GridLayoutScreenCanvasSizeOptions
noSmithyDocumentSerde
}
// The configuration for a grid layout. Also called a tiled layout. Visuals snap
// to a grid with standard spacing and alignment. Dashboards are displayed as
// designed, with options to fit to screen or view at actual size.
type GridLayoutConfiguration struct {
// The elements that are included in a grid layout.
//
// This member is required.
Elements []GridLayoutElement
// Configuration options for the canvas of a grid layout.
CanvasSizeOptions *GridLayoutCanvasSizeOptions
noSmithyDocumentSerde
}
// An element within a grid layout.
type GridLayoutElement struct {
// The width of a grid element expressed as a number of grid columns.
//
// This member is required.
ColumnSpan *int32
// A unique identifier for an element within a grid layout.
//
// This member is required.
ElementId *string
// The type of element.
//
// This member is required.
ElementType LayoutElementType
// The height of a grid element expressed as a number of grid rows.
//
// This member is required.
RowSpan *int32
// The column index for the upper left corner of an element.
ColumnIndex *int32
// The row index for the upper left corner of an element.
RowIndex *int32
noSmithyDocumentSerde
}
// The options that determine the sizing of the canvas used in a grid layout.
type GridLayoutScreenCanvasSizeOptions struct {
// This value determines the layout behavior when the viewport is resized.
// - FIXED : A fixed width will be used when optimizing the layout. In the Amazon
// QuickSight console, this option is called Classic .
// - RESPONSIVE : The width of the canvas will be responsive and optimized to the
// view port. In the Amazon QuickSight console, this option is called Tiled .
//
// This member is required.
ResizeOption ResizeOption
// The width that the view port will be optimized for when the layout renders.
OptimizedViewPortWidth *string
noSmithyDocumentSerde
}
// A group in Amazon QuickSight consists of a set of users. You can use groups to
// make it easier to manage access and security.
type Group struct {
// The Amazon Resource Name (ARN) for the group.
Arn *string
// The group description.
Description *string
// The name of the group.
GroupName *string
// The principal ID of the group.
PrincipalId *string
noSmithyDocumentSerde
}
// A member of an Amazon QuickSight group. Currently, group members must be users.
// Groups can't be members of another group. .
type GroupMember struct {
// The Amazon Resource Name (ARN) for the group member (user).
Arn *string
// The name of the group member (user).
MemberName *string
noSmithyDocumentSerde
}
// A GroupSearchFilter object that you want to apply to your search.
type GroupSearchFilter struct {
// The name of the value that you want to use as a filter, for example "Name":
// "GROUP_NAME" . Currently, the only supported name is GROUP_NAME .
//
// This member is required.
Name GroupFilterAttribute
// The comparison operator that you want to use as a filter, for example
// "Operator": "StartsWith" . Currently, the only supported operator is StartsWith .
//
// This member is required.
Operator GroupFilterOperator
// The value of the named item, in this case GROUP_NAME , that you want to use as a
// filter.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// The growth rate computation configuration.
type GrowthRateComputation struct {
// The ID for a computation.
//
// This member is required.
ComputationId *string
// The time field that is used in a computation.
//
// This member is required.
Time *DimensionField
// The name of a computation.
Name *string
// The period size setup of a growth rate computation.
PeriodSize int32
// The value field that is used in a computation.
Value *MeasureField
noSmithyDocumentSerde
}
// The display options for gutter spacing between tiles on a sheet.
type GutterStyle struct {
// This Boolean value controls whether to display a gutter space between sheet
// tiles.
Show *bool
noSmithyDocumentSerde
}
// The configuration of a header or footer section.
type HeaderFooterSectionConfiguration struct {
// The layout configuration of the header or footer section.
//
// This member is required.
Layout *SectionLayoutConfiguration
// The unique identifier of the header or footer section.
//
// This member is required.
SectionId *string
// The style options of a header or footer section.
Style *SectionStyle
noSmithyDocumentSerde
}
// The aggregated field wells of a heat map.
type HeatMapAggregatedFieldWells struct {
// The columns field well of a heat map.
Columns []DimensionField
// The rows field well of a heat map.
Rows []DimensionField
// The values field well of a heat map.
Values []MeasureField
noSmithyDocumentSerde
}
// The configuration of a heat map.
type HeatMapConfiguration struct {
// The color options (gradient color, point of divergence) in a heat map.
ColorScale *ColorScale
// The label options of the column that is displayed in a heat map.
ColumnLabelOptions *ChartAxisLabelOptions
// The options that determine if visual data labels are displayed.
DataLabels *DataLabelOptions
// The field wells of the visual.
FieldWells *HeatMapFieldWells
// The legend display setup of the visual.
Legend *LegendOptions
// The label options of the row that is displayed in a heat map .
RowLabelOptions *ChartAxisLabelOptions
// The sort configuration of a heat map.
SortConfiguration *HeatMapSortConfiguration
// The tooltip display setup of the visual.
Tooltip *TooltipOptions
noSmithyDocumentSerde
}
// The field well configuration of a heat map. This is a union type structure. For
// this structure to be valid, only one of the attributes can be defined.
type HeatMapFieldWells struct {
// The aggregated field wells of a heat map.
HeatMapAggregatedFieldWells *HeatMapAggregatedFieldWells
noSmithyDocumentSerde
}
// The sort configuration of a heat map.
type HeatMapSortConfiguration struct {
// The limit on the number of columns that are displayed in a heat map.
HeatMapColumnItemsLimitConfiguration *ItemsLimitConfiguration
// The column sort configuration for heat map for columns that aren't a part of a
// field well.
HeatMapColumnSort []FieldSortOptions
// The limit on the number of rows that are displayed in a heat map.
HeatMapRowItemsLimitConfiguration *ItemsLimitConfiguration
// The field sort configuration of the rows fields.
HeatMapRowSort []FieldSortOptions
noSmithyDocumentSerde
}
// A heat map. For more information, see Using heat maps (https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html)
// in the Amazon QuickSight User Guide.
type HeatMapVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers.
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration of a heat map.
ChartConfiguration *HeatMapConfiguration
// The column hierarchy that is used during drill-downs and drill-ups.
ColumnHierarchies []ColumnHierarchy
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// The field well configuration of a histogram.
type HistogramAggregatedFieldWells struct {
// The value field wells of a histogram. Values are aggregated by COUNT or
// DISTINCT_COUNT .
Values []MeasureField
noSmithyDocumentSerde
}
// The options that determine the presentation of histogram bins.
type HistogramBinOptions struct {
// The options that determine the bin count of a histogram.
BinCount *BinCountOptions
// The options that determine the bin width of a histogram.
BinWidth *BinWidthOptions
// The options that determine the selected bin type.
SelectedBinType HistogramBinType
// The options that determine the bin start value.
StartValue *float64
noSmithyDocumentSerde
}
// The configuration for a HistogramVisual .
type HistogramConfiguration struct {
// The options that determine the presentation of histogram bins.
BinOptions *HistogramBinOptions
// The data label configuration of a histogram.
DataLabels *DataLabelOptions
// The field well configuration of a histogram.
FieldWells *HistogramFieldWells
// The tooltip configuration of a histogram.
Tooltip *TooltipOptions
// The visual palette configuration of a histogram.
VisualPalette *VisualPalette
// The options that determine the presentation of the x-axis.
XAxisDisplayOptions *AxisDisplayOptions
// The options that determine the presentation of the x-axis label.
XAxisLabelOptions *ChartAxisLabelOptions
// The options that determine the presentation of the y-axis.
YAxisDisplayOptions *AxisDisplayOptions
noSmithyDocumentSerde
}
// The field well configuration of a histogram.
type HistogramFieldWells struct {
// The field well configuration of a histogram.
HistogramAggregatedFieldWells *HistogramAggregatedFieldWells
noSmithyDocumentSerde
}
// A histogram. For more information, see Using histograms (https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html)
// in the Amazon QuickSight User Guide.
type HistogramVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers.
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration for a HistogramVisual .
ChartConfiguration *HistogramConfiguration
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// An Identity and Access Management (IAM) policy assignment.
type IAMPolicyAssignment struct {
// Assignment ID.
AssignmentId *string
// Assignment name.
AssignmentName *string
// Assignment status.
AssignmentStatus AssignmentStatus
// The Amazon Web Services account ID.
AwsAccountId *string
// Identities.
Identities map[string][]string
// The Amazon Resource Name (ARN) for the IAM policy.
PolicyArn *string
noSmithyDocumentSerde
}
// IAM policy assignment summary.
type IAMPolicyAssignmentSummary struct {
// Assignment name.
AssignmentName *string
// Assignment status.
AssignmentStatus AssignmentStatus
noSmithyDocumentSerde
}
// The incremental refresh configuration for a dataset.
type IncrementalRefresh struct {
// The lookback window setup for an incremental refresh configuration.
//
// This member is required.
LookbackWindow *LookbackWindow
noSmithyDocumentSerde
}
// Information about the SPICE ingestion for a dataset.
type Ingestion struct {
// The Amazon Resource Name (ARN) of the resource.
//
// This member is required.
Arn *string
// The time that this ingestion started.
//
// This member is required.
CreatedTime *time.Time
// Ingestion status.
//
// This member is required.
IngestionStatus IngestionStatus
// Error information for this ingestion.
ErrorInfo *ErrorInfo
// Ingestion ID.
IngestionId *string
// The size of the data ingested, in bytes.
IngestionSizeInBytes *int64
// The time that this ingestion took, measured in seconds.
IngestionTimeInSeconds *int64
// Information about a queued dataset SPICE ingestion.
QueueInfo *QueueInfo
// Event source for this ingestion.
RequestSource IngestionRequestSource
// Type of this ingestion.
RequestType IngestionRequestType
// Information about rows for a data set SPICE ingestion.
RowInfo *RowInfo
noSmithyDocumentSerde
}
// Metadata for a column that is used as the input of a transform operation.
type InputColumn struct {
// The name of this column in the underlying data source.
//
// This member is required.
Name *string
// The data type of the column.
//
// This member is required.
Type InputColumnDataType
noSmithyDocumentSerde
}
// The configuration of an insight visual.
type InsightConfiguration struct {
// The computations configurations of the insight visual
Computations []Computation
// The custom narrative of the insight visual.
CustomNarrative *CustomNarrativeOptions
noSmithyDocumentSerde
}
// An insight visual. For more information, see Working with insights (https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html)
// in the Amazon QuickSight User Guide.
type InsightVisual struct {
// The dataset that is used in the insight visual.
//
// This member is required.
DataSetIdentifier *string
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers.
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration of an insight visual.
InsightConfiguration *InsightConfiguration
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// An integer parameter for a dataset.
type IntegerDatasetParameter struct {
// An identifier for the integer parameter created in the dataset.
//
// This member is required.
Id *string
// The name of the integer parameter that is created in the dataset.
//
// This member is required.
Name *string
// The value type of the dataset parameter. Valid values are single value or multi
// value .
//
// This member is required.
ValueType DatasetParameterValueType
// A list of default values for a given integer parameter. This structure only
// accepts static values.
DefaultValues *IntegerDatasetParameterDefaultValues
noSmithyDocumentSerde
}
// The default values of an integer parameter.
type IntegerDatasetParameterDefaultValues struct {
// A list of static default values for a given integer parameter.
StaticValues []int64
noSmithyDocumentSerde
}
// The default values of the IntegerParameterDeclaration .
type IntegerDefaultValues struct {
// The dynamic value of the IntegerDefaultValues . Different defaults are displayed
// according to users, groups, and values mapping.
DynamicValue *DynamicDefaultValue
// The static values of the IntegerDefaultValues .
StaticValues []int64
noSmithyDocumentSerde
}
// An integer parameter.
type IntegerParameter struct {
// The name of the integer parameter.
//
// This member is required.
Name *string
// The values for the integer parameter.
//
// This member is required.
Values []int64
noSmithyDocumentSerde
}
// A parameter declaration for the Integer data type.
type IntegerParameterDeclaration struct {
// The name of the parameter that is being declared.
//
// This member is required.
Name *string
// The value type determines whether the parameter is a single-value or
// multi-value parameter.
//
// This member is required.
ParameterValueType ParameterValueType
// The default values of a parameter. If the parameter is a single-value
// parameter, a maximum of one default value can be provided.
DefaultValues *IntegerDefaultValues
// A list of dataset parameters that are mapped to an analysis parameter.
MappedDataSetParameters []MappedDataSetParameter
// A parameter declaration for the Integer data type.
ValueWhenUnset *IntegerValueWhenUnsetConfiguration
noSmithyDocumentSerde
}
// A parameter declaration for the Integer data type. This is a union type
// structure. For this structure to be valid, only one of the attributes can be
// defined.
type IntegerValueWhenUnsetConfiguration struct {
// A custom value that's used when the value of a parameter isn't set.
CustomValue *int64
// The built-in options for default values. The value can be one of the following:
// - RECOMMENDED : The recommended value.
// - NULL : The NULL value.
ValueWhenUnsetOption ValueWhenUnsetOption
noSmithyDocumentSerde
}
// The limit configuration of the visual display for an axis.
type ItemsLimitConfiguration struct {
// The limit on how many items of a field are showed in the chart. For example,
// the number of slices that are displayed in a pie chart.
ItemsLimit *int64
// The Show other of an axis in the chart. Choose one of the following options:
// - INCLUDE
// - EXCLUDE
OtherCategories OtherCategories
noSmithyDocumentSerde
}
// The parameters for Jira.
type JiraParameters struct {
// The base URL of the Jira site.
//
// This member is required.
SiteBaseUrl *string
noSmithyDocumentSerde
}
// The instructions associated with a join.
type JoinInstruction struct {
// The operand on the left side of a join.
//
// This member is required.
LeftOperand *string
// The join instructions provided in the ON clause of a join.
//
// This member is required.
OnClause *string
// The operand on the right side of a join.
//
// This member is required.
RightOperand *string
// The type of join that it is.
//
// This member is required.
Type JoinType
// Join key properties of the left operand.
LeftJoinKeyProperties *JoinKeyProperties
// Join key properties of the right operand.
RightJoinKeyProperties *JoinKeyProperties
noSmithyDocumentSerde
}
// Properties associated with the columns participating in a join.
type JoinKeyProperties struct {
// A value that indicates that a row in a table is uniquely identified by the
// columns in a join key. This is used by Amazon QuickSight to optimize query
// performance.
UniqueKey *bool
noSmithyDocumentSerde
}
// The conditional formatting of a KPI visual.
type KPIConditionalFormatting struct {
// The conditional formatting options of a KPI visual.
ConditionalFormattingOptions []KPIConditionalFormattingOption
noSmithyDocumentSerde
}
// The conditional formatting options of a KPI visual.
type KPIConditionalFormattingOption struct {
// The conditional formatting for the primary value of a KPI visual.
PrimaryValue *KPIPrimaryValueConditionalFormatting
// The conditional formatting for the progress bar of a KPI visual.
ProgressBar *KPIProgressBarConditionalFormatting
noSmithyDocumentSerde
}
// The configuration of a KPI visual.
type KPIConfiguration struct {
// The field well configuration of a KPI visual.
FieldWells *KPIFieldWells
// The options that determine the presentation of a KPI visual.
KPIOptions *KPIOptions
// The sort configuration of a KPI visual.
SortConfiguration *KPISortConfiguration
noSmithyDocumentSerde
}
// The field well configuration of a KPI visual.
type KPIFieldWells struct {
// The target value field wells of a KPI visual.
TargetValues []MeasureField
// The trend group field wells of a KPI visual.
TrendGroups []DimensionField
// The value field wells of a KPI visual.
Values []MeasureField
noSmithyDocumentSerde
}
// The options that determine the presentation of a KPI visual.
type KPIOptions struct {
// The comparison configuration of a KPI visual.
Comparison *ComparisonConfiguration
// The options that determine the primary value display type.
PrimaryValueDisplayType PrimaryValueDisplayType
// The options that determine the primary value font configuration.
PrimaryValueFontConfiguration *FontConfiguration
// The options that determine the presentation of the progress bar of a KPI visual.
ProgressBar *ProgressBarOptions
// The options that determine the presentation of the secondary value of a KPI
// visual.
SecondaryValue *SecondaryValueOptions
// The options that determine the secondary value font configuration.
SecondaryValueFontConfiguration *FontConfiguration
// The options that determine the presentation of trend arrows in a KPI visual.
TrendArrows *TrendArrowOptions
noSmithyDocumentSerde
}
// The conditional formatting for the primary value of a KPI visual.
type KPIPrimaryValueConditionalFormatting struct {
// The conditional formatting of the primary value's icon.
Icon *ConditionalFormattingIcon
// The conditional formatting of the primary value's text color.
TextColor *ConditionalFormattingColor
noSmithyDocumentSerde
}
// The conditional formatting for the progress bar of a KPI visual.
type KPIProgressBarConditionalFormatting struct {
// The conditional formatting of the progress bar's foreground color.
ForegroundColor *ConditionalFormattingColor
noSmithyDocumentSerde
}
// The sort configuration of a KPI visual.
type KPISortConfiguration struct {
// The sort configuration of the trend group fields.
TrendGroupSort []FieldSortOptions
noSmithyDocumentSerde
}
// A key performance indicator (KPI). For more information, see Using KPIs (https://docs.aws.amazon.com/quicksight/latest/user/kpi.html)
// in the Amazon QuickSight User Guide.
type KPIVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers.
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration of a KPI visual.
ChartConfiguration *KPIConfiguration
// The column hierarchy that is used during drill-downs and drill-ups.
ColumnHierarchies []ColumnHierarchy
// The conditional formatting of a KPI visual.
ConditionalFormatting *KPIConditionalFormatting
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// The share label options for the labels.
type LabelOptions struct {
// The text for the label.
CustomLabel *string
// The font configuration of the label.
FontConfiguration *FontConfiguration
// Determines whether or not the label is visible.
Visibility Visibility
noSmithyDocumentSerde
}
// A Layout defines the placement of elements within a sheet. For more
// information, see Types of layout (https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html)
// in the Amazon QuickSight User Guide. This is a union type structure. For this
// structure to be valid, only one of the attributes can be defined.
type Layout struct {
// The configuration that determines what the type of layout for a sheet.
//
// This member is required.
Configuration *LayoutConfiguration
noSmithyDocumentSerde
}
// The configuration that determines what the type of layout will be used on a
// sheet. This is a union type structure. For this structure to be valid, only one
// of the attributes can be defined.
type LayoutConfiguration struct {
// A free-form is optimized for a fixed width and has more control over the exact
// placement of layout elements.
FreeFormLayout *FreeFormLayoutConfiguration
// A type of layout that can be used on a sheet. In a grid layout, visuals snap to
// a grid with standard spacing and alignment. Dashboards are displayed as
// designed, with options to fit to screen or view at actual size. A grid layout
// can be configured to behave in one of two ways when the viewport is resized:
// FIXED or RESPONSIVE .
GridLayout *GridLayoutConfiguration
// A section based layout organizes visuals into multiple sections and has
// customized header, footer and page break.
SectionBasedLayout *SectionBasedLayoutConfiguration
noSmithyDocumentSerde
}
// The options for the legend setup of a visual.
type LegendOptions struct {
// The height of the legend. If this value is omitted, a default height is used
// when rendering.
Height *string
// The positions for the legend. Choose one of the following options:
// - AUTO
// - RIGHT
// - BOTTOM
// - LEFT
Position LegendPosition
// The custom title for the legend.
Title *LabelOptions
// Determines whether or not the legend is visible.
Visibility Visibility
// The width of the legend. If this value is omitted, a default width is used when
// rendering.
Width *string
noSmithyDocumentSerde
}
// The field well configuration of a line chart.
type LineChartAggregatedFieldWells struct {
// The category field wells of a line chart. Values are grouped by category fields.
Category []DimensionField
// The color field wells of a line chart. Values are grouped by category fields.
Colors []DimensionField
// The small multiples field well of a line chart.
SmallMultiples []DimensionField
// The value field wells of a line chart. Values are aggregated based on
// categories.
Values []MeasureField
noSmithyDocumentSerde
}
// The configuration of a line chart.
type LineChartConfiguration struct {
// The default configuration of a line chart's contribution analysis.
ContributionAnalysisDefaults []ContributionAnalysisDefault
// The data label configuration of a line chart.
DataLabels *DataLabelOptions
// The options that determine the default presentation of all line series in
// LineChartVisual .
DefaultSeriesSettings *LineChartDefaultSeriesSettings
// The field well configuration of a line chart.
FieldWells *LineChartFieldWells
// The forecast configuration of a line chart.
ForecastConfigurations []ForecastConfiguration
// The legend configuration of a line chart.
Legend *LegendOptions
// The series axis configuration of a line chart.
PrimaryYAxisDisplayOptions *LineSeriesAxisDisplayOptions
// The options that determine the presentation of the y-axis label.
PrimaryYAxisLabelOptions *ChartAxisLabelOptions
// The reference lines configuration of a line chart.
ReferenceLines []ReferenceLine
// The series axis configuration of a line chart.
SecondaryYAxisDisplayOptions *LineSeriesAxisDisplayOptions
// The options that determine the presentation of the secondary y-axis label.
SecondaryYAxisLabelOptions *ChartAxisLabelOptions
// The series item configuration of a line chart.
Series []SeriesItem
// The small multiples setup for the visual.
SmallMultiplesOptions *SmallMultiplesOptions
// The sort configuration of a line chart.
SortConfiguration *LineChartSortConfiguration
// The tooltip configuration of a line chart.
Tooltip *TooltipOptions
// Determines the type of the line chart.
Type LineChartType
// The visual palette configuration of a line chart.
VisualPalette *VisualPalette
// The options that determine the presentation of the x-axis.
XAxisDisplayOptions *AxisDisplayOptions
// The options that determine the presentation of the x-axis label.
XAxisLabelOptions *ChartAxisLabelOptions
noSmithyDocumentSerde
}
// The options that determine the default presentation of all line series in
// LineChartVisual .
type LineChartDefaultSeriesSettings struct {
// The axis to which you are binding all line series to.
AxisBinding AxisBinding
// Line styles options for all line series in the visual.
LineStyleSettings *LineChartLineStyleSettings
// Marker styles options for all line series in the visual.
MarkerStyleSettings *LineChartMarkerStyleSettings
noSmithyDocumentSerde
}
// The field well configuration of a line chart.
type LineChartFieldWells struct {
// The field well configuration of a line chart.
LineChartAggregatedFieldWells *LineChartAggregatedFieldWells
noSmithyDocumentSerde
}
// Line styles options for a line series in LineChartVisual .
type LineChartLineStyleSettings struct {
// Interpolation style for line series.
// - LINEAR : Show as default, linear style.
// - SMOOTH : Show as a smooth curve.
// - STEPPED : Show steps in line.
LineInterpolation LineInterpolation
// Line style for line series.
// - SOLID : Show as a solid line.
// - DOTTED : Show as a dotted line.
// - DASHED : Show as a dashed line.
LineStyle LineChartLineStyle
// Configuration option that determines whether to show the line for the series.
LineVisibility Visibility
// Width that determines the line thickness.
LineWidth *string
noSmithyDocumentSerde
}
// Marker styles options for a line series in LineChartVisual .
type LineChartMarkerStyleSettings struct {
// Color of marker in the series.
MarkerColor *string
// Shape option for markers in the series.
// - CIRCLE : Show marker as a circle.
// - TRIANGLE : Show marker as a triangle.
// - SQUARE : Show marker as a square.
// - DIAMOND : Show marker as a diamond.
// - ROUNDED_SQUARE : Show marker as a rounded square.
MarkerShape LineChartMarkerShape
// Size of marker in the series.
MarkerSize *string
// Configuration option that determines whether to show the markers in the series.
MarkerVisibility Visibility
noSmithyDocumentSerde
}
// The options that determine the presentation of a line series in the visual
type LineChartSeriesSettings struct {
// Line styles options for a line series in LineChartVisual .
LineStyleSettings *LineChartLineStyleSettings
// Marker styles options for a line series in LineChartVisual .
MarkerStyleSettings *LineChartMarkerStyleSettings
noSmithyDocumentSerde
}
// The sort configuration of a line chart.
type LineChartSortConfiguration struct {
// The limit on the number of categories that are displayed in a line chart.
CategoryItemsLimitConfiguration *ItemsLimitConfiguration
// The sort configuration of the category fields.
CategorySort []FieldSortOptions
// The limit on the number of lines that are displayed in a line chart.
ColorItemsLimitConfiguration *ItemsLimitConfiguration
// The limit on the number of small multiples panels that are displayed.
SmallMultiplesLimitConfiguration *ItemsLimitConfiguration
// The sort configuration of the small multiples field.
SmallMultiplesSort []FieldSortOptions
noSmithyDocumentSerde
}
// A line chart. For more information, see Using line charts (https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html)
// in the Amazon QuickSight User Guide.
type LineChartVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers.
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration of a line chart.
ChartConfiguration *LineChartConfiguration
// The column hierarchy that is used during drill-downs and drill-ups.
ColumnHierarchies []ColumnHierarchy
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// The series axis configuration of a line chart.
type LineSeriesAxisDisplayOptions struct {
// The options that determine the presentation of the line series axis.
AxisOptions *AxisDisplayOptions
// The configuration options that determine how missing data is treated during the
// rendering of a line chart.
MissingDataConfigurations []MissingDataConfiguration
noSmithyDocumentSerde
}
// A structure that contains the configuration of a shareable link to the
// dashboard.
type LinkSharingConfiguration struct {
// A structure that contains the permissions of a shareable link.
Permissions []ResourcePermission
noSmithyDocumentSerde
}
// The display options of a control.
type ListControlDisplayOptions struct {
// The configuration of the search options in a list control.
SearchOptions *ListControlSearchOptions
// The configuration of the Select all options in a list control.
SelectAllOptions *ListControlSelectAllOptions
// The options to configure the title visibility, name, and font size.
TitleOptions *LabelOptions
noSmithyDocumentSerde
}
// The configuration of the search options in a list control.
type ListControlSearchOptions struct {
// The visibility configuration of the search options in a list control.
Visibility Visibility
noSmithyDocumentSerde
}
// The configuration of the Select all options in a list control.
type ListControlSelectAllOptions struct {
// The visibility configuration of the Select all options in a list control.
Visibility Visibility
noSmithyDocumentSerde
}
// The configuration of loading animation in free-form layout.
type LoadingAnimation struct {
// The visibility configuration of LoadingAnimation .
Visibility Visibility
noSmithyDocumentSerde
}
// The navigation configuration for CustomActionNavigationOperation .
type LocalNavigationConfiguration struct {
// The sheet that is targeted for navigation in the same analysis.
//
// This member is required.
TargetSheetId *string
noSmithyDocumentSerde
}
// A logical table is a unit that joins and that data transformations operate on.
// A logical table has a source, which can be either a physical table or result of
// a join. When a logical table points to a physical table, the logical table acts
// as a mutable copy of that physical table through transform operations.
type LogicalTable struct {
// A display name for the logical table.
//
// This member is required.
Alias *string
// Source of this logical table.
//
// This member is required.
Source *LogicalTableSource
// Transform operations that act on this logical table. For this structure to be
// valid, only one of the attributes can be non-null.
DataTransforms []TransformOperation
noSmithyDocumentSerde
}
// Information about the source of a logical table. This is a variant type
// structure. For this structure to be valid, only one of the attributes can be
// non-null.
type LogicalTableSource struct {
// The Amazon Resource Number (ARN) of the parent dataset.
DataSetArn *string
// Specifies the result of a join of two logical tables.
JoinInstruction *JoinInstruction
// Physical table ID.
PhysicalTableId *string
noSmithyDocumentSerde
}
// The text format for a subtitle. This is a union type structure. For this
// structure to be valid, only one of the attributes can be defined.
type LongFormatText struct {
// Plain text format.
PlainText *string
// Rich text. Examples of rich text include bold, underline, and italics.
RichText *string
noSmithyDocumentSerde
}
// The lookback window setup of an incremental refresh configuration.
type LookbackWindow struct {
// The name of the lookback window column.
//
// This member is required.
ColumnName *string
// The lookback window column size.
//
// This member is required.
Size int64
// The size unit that is used for the lookback window column. Valid values for
// this structure are HOUR , DAY , and WEEK .
//
// This member is required.
SizeUnit LookbackWindowSizeUnit
noSmithyDocumentSerde
}
// Amazon S3 manifest file location.
type ManifestFileLocation struct {
// Amazon S3 bucket.
//
// This member is required.
Bucket *string
// Amazon S3 key that identifies an object.
//
// This member is required.
Key *string
noSmithyDocumentSerde
}
// A dataset parameter that is mapped to an analysis parameter.
type MappedDataSetParameter struct {
// A unique name that identifies a dataset within the analysis or dashboard.
//
// This member is required.
DataSetIdentifier *string
// The name of the dataset parameter.
//
// This member is required.
DataSetParameterName *string
noSmithyDocumentSerde
}
// The display options for margins around the outside edge of sheets.
type MarginStyle struct {
// This Boolean value controls whether to display sheet margins.
Show *bool
noSmithyDocumentSerde
}
// The parameters for MariaDB.
type MariaDbParameters struct {
// Database.
//
// This member is required.
Database *string
// Host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// The maximum label of a data path label.
type MaximumLabelType struct {
// The visibility of the maximum label.
Visibility Visibility
noSmithyDocumentSerde
}
// The maximum and minimum computation configuration.
type MaximumMinimumComputation struct {
// The ID for a computation.
//
// This member is required.
ComputationId *string
// The time field that is used in a computation.
//
// This member is required.
Time *DimensionField
// The type of computation. Choose one of the following options:
// - MAXIMUM: A maximum computation.
// - MINIMUM: A minimum computation.
//
// This member is required.
Type MaximumMinimumComputationType
// The name of a computation.
Name *string
// The value field that is used in a computation.
Value *MeasureField
noSmithyDocumentSerde
}
// The measure (metric) type field.
type MeasureField struct {
// The calculated measure field only used in pivot tables.
CalculatedMeasureField *CalculatedMeasureField
// The measure type field with categorical type columns.
CategoricalMeasureField *CategoricalMeasureField
// The measure type field with date type columns.
DateMeasureField *DateMeasureField
// The measure type field with numerical type columns.
NumericalMeasureField *NumericalMeasureField
noSmithyDocumentSerde
}
// An object that consists of a member Amazon Resource Name (ARN) and a member ID.
type MemberIdArnPair struct {
// The Amazon Resource Name (ARN) of the member.
MemberArn *string
// The ID of the member.
MemberId *string
noSmithyDocumentSerde
}
// The metric comparison computation configuration.
type MetricComparisonComputation struct {
// The ID for a computation.
//
// This member is required.
ComputationId *string
// The field that is used in a metric comparison from value setup.
//
// This member is required.
FromValue *MeasureField
// The field that is used in a metric comparison to value setup.
//
// This member is required.
TargetValue *MeasureField
// The time field that is used in a computation.
//
// This member is required.
Time *DimensionField
// The name of a computation.
Name *string
noSmithyDocumentSerde
}
// The minimum label of a data path label.
type MinimumLabelType struct {
// The visibility of the minimum label.
Visibility Visibility
noSmithyDocumentSerde
}
// The configuration options that determine how missing data is treated during the
// rendering of a line chart.
type MissingDataConfiguration struct {
// The treatment option that determines how missing data should be rendered.
// Choose from the following options:
// - INTERPOLATE : Interpolate missing values between the prior and the next
// known value.
// - SHOW_AS_ZERO : Show missing values as the value 0 .
// - SHOW_AS_BLANK : Display a blank space when rendering missing data.
TreatmentOption MissingDataTreatmentOption
noSmithyDocumentSerde
}
// The parameters for MySQL.
type MySqlParameters struct {
// Database.
//
// This member is required.
Database *string
// Host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// A structure that represents a named entity.
type NamedEntityDefinition struct {
// The name of the entity.
FieldName *string
// The definition of a metric.
Metric *NamedEntityDefinitionMetric
// The property name to be used for the named entity.
PropertyName *string
// The property role. Valid values for this structure are PRIMARY and ID .
PropertyRole PropertyRole
// The property usage. Valid values for this structure are INHERIT , DIMENSION ,
// and MEASURE .
PropertyUsage PropertyUsage
noSmithyDocumentSerde
}
// A structure that represents a metric.
type NamedEntityDefinitionMetric struct {
// The aggregation of a named entity. Valid values for this structure are SUM , MIN
// , MAX , COUNT , AVERAGE , DISTINCT_COUNT , STDEV , STDEVP , VAR , VARP ,
// PERCENTILE , MEDIAN , and CUSTOM .
Aggregation NamedEntityAggType
// The additional parameters for an aggregation function.
AggregationFunctionParameters map[string]string
noSmithyDocumentSerde
}
// Errors that occur during namespace creation.
type NamespaceError struct {
// The message for the error.
Message *string
// The error type.
Type NamespaceErrorType
noSmithyDocumentSerde
}
// The error type.
type NamespaceInfoV2 struct {
// The namespace ARN.
Arn *string
// The namespace Amazon Web Services Region.
CapacityRegion *string
// The creation status of a namespace that is not yet completely created.
CreationStatus NamespaceStatus
// The identity store used for the namespace.
IdentityStore IdentityStore
// The name of the error.
Name *string
// An error that occurred when the namespace was created.
NamespaceError *NamespaceError
noSmithyDocumentSerde
}
// A structure that represents a negative format.
type NegativeFormat struct {
// The prefix for a negative format.
Prefix *string
// The suffix for a negative format.
Suffix *string
noSmithyDocumentSerde
}
// The options that determine the negative value configuration.
type NegativeValueConfiguration struct {
// Determines the display mode of the negative value configuration.
//
// This member is required.
DisplayMode NegativeValueDisplayMode
noSmithyDocumentSerde
}
// The structure that contains information about a network interface.
type NetworkInterface struct {
// The availability zone that the network interface resides in.
AvailabilityZone *string
// An error message.
ErrorMessage *string
// The network interface ID.
NetworkInterfaceId *string
// The status of the network interface.
Status NetworkInterfaceStatus
// The subnet ID associated with the network interface.
SubnetId *string
noSmithyDocumentSerde
}
// The configuration that overrides the existing default values for a dataset
// parameter that is inherited from another dataset.
type NewDefaultValues struct {
// A list of static default values for a given date time parameter.
DateTimeStaticValues []time.Time
// A list of static default values for a given decimal parameter.
DecimalStaticValues []float64
// A list of static default values for a given integer parameter.
IntegerStaticValues []int64
// A list of static default values for a given string parameter.
StringStaticValues []string
noSmithyDocumentSerde
}
// The options that determine the null value format configuration.
type NullValueFormatConfiguration struct {
// Determines the null string of null values.
//
// This member is required.
NullString *string
noSmithyDocumentSerde
}
// The options that determine the number display format configuration.
type NumberDisplayFormatConfiguration struct {
// The option that determines the decimal places configuration.
DecimalPlacesConfiguration *DecimalPlacesConfiguration
// The options that determine the negative value configuration.
NegativeValueConfiguration *NegativeValueConfiguration
// The options that determine the null value format configuration.
NullValueFormatConfiguration *NullValueFormatConfiguration
// Determines the number scale value of the number format.
NumberScale NumberScale
// Determines the prefix value of the number format.
Prefix *string
// The options that determine the numeric separator configuration.
SeparatorConfiguration *NumericSeparatorConfiguration
// Determines the suffix value of the number format.
Suffix *string
noSmithyDocumentSerde
}
// Formatting configuration for number fields.
type NumberFormatConfiguration struct {
// The options that determine the numeric format configuration.
FormatConfiguration *NumericFormatConfiguration
noSmithyDocumentSerde
}
// Aggregation for numerical values.
type NumericalAggregationFunction struct {
// An aggregation based on the percentile of values in a dimension or measure.
PercentileAggregation *PercentileAggregation
// Built-in aggregation functions for numerical values.
// - SUM : The sum of a dimension or measure.
// - AVERAGE : The average of a dimension or measure.
// - MIN : The minimum value of a dimension or measure.
// - MAX : The maximum value of a dimension or measure.
// - COUNT : The count of a dimension or measure.
// - DISTINCT_COUNT : The count of distinct values in a dimension or measure.
// - VAR : The variance of a dimension or measure.
// - VARP : The partitioned variance of a dimension or measure.
// - STDEV : The standard deviation of a dimension or measure.
// - STDEVP : The partitioned standard deviation of a dimension or measure.
// - MEDIAN : The median value of a dimension or measure.
SimpleNumericalAggregation SimpleNumericalAggregationFunction
noSmithyDocumentSerde
}
// The dimension type field with numerical type columns.
type NumericalDimensionField struct {
// The column that is used in the NumericalDimensionField .
//
// This member is required.
Column *ColumnIdentifier
// The custom field ID.
//
// This member is required.
FieldId *string
// The format configuration of the field.
FormatConfiguration *NumberFormatConfiguration
// The custom hierarchy ID.
HierarchyId *string
noSmithyDocumentSerde
}
// The measure type field with numerical type columns.
type NumericalMeasureField struct {
// The column that is used in the NumericalMeasureField .
//
// This member is required.
Column *ColumnIdentifier
// The custom field ID.
//
// This member is required.
FieldId *string
// The aggregation function of the measure field.
AggregationFunction *NumericalAggregationFunction
// The format configuration of the field.
FormatConfiguration *NumberFormatConfiguration
noSmithyDocumentSerde
}
// The options for an axis with a numeric field.
type NumericAxisOptions struct {
// The range setup of a numeric axis.
Range *AxisDisplayRange
// The scale setup of a numeric axis.
Scale *AxisScale
noSmithyDocumentSerde
}
// The category drill down filter.
type NumericEqualityDrillDownFilter struct {
// The column that the filter is applied to.
//
// This member is required.
Column *ColumnIdentifier
// The value of the double input numeric drill down filter.
//
// This member is required.
Value float64
noSmithyDocumentSerde
}
// A NumericEqualityFilter filters values that are equal to the specified value.
type NumericEqualityFilter struct {
// The column that the filter is applied to.
//
// This member is required.
Column *ColumnIdentifier
// An identifier that uniquely identifies a filter within a dashboard, analysis,
// or template.
//
// This member is required.
FilterId *string
// The match operator that is used to determine if a filter should be applied.
//
// This member is required.
MatchOperator NumericEqualityMatchOperator
// This option determines how null values should be treated when filtering data.
// - ALL_VALUES : Include null values in filtered results.
// - NULLS_ONLY : Only include null values in filtered results.
// - NON_NULLS_ONLY : Exclude null values from filtered results.
//
// This member is required.
NullOption FilterNullOption
// The aggregation function of the filter.
AggregationFunction *AggregationFunction
// The parameter whose value should be used for the filter value.
ParameterName *string
// Select all of the values. Null is not the assigned value of select all.
// - FILTER_ALL_VALUES
SelectAllOptions NumericFilterSelectAllOptions
// The input value.
Value *float64
noSmithyDocumentSerde
}
// The options that determine the numeric format configuration. This is a union
// type structure. For this structure to be valid, only one of the attributes can
// be defined.
type NumericFormatConfiguration struct {
// The options that determine the currency display format configuration.
CurrencyDisplayFormatConfiguration *CurrencyDisplayFormatConfiguration
// The options that determine the number display format configuration.
NumberDisplayFormatConfiguration *NumberDisplayFormatConfiguration
// The options that determine the percentage display format configuration.
PercentageDisplayFormatConfiguration *PercentageDisplayFormatConfiguration
noSmithyDocumentSerde
}
// A NumericRangeFilter filters values that are within the value range.
type NumericRangeFilter struct {
// The column that the filter is applied to.
//
// This member is required.
Column *ColumnIdentifier
// An identifier that uniquely identifies a filter within a dashboard, analysis,
// or template.
//
// This member is required.
FilterId *string
// This option determines how null values should be treated when filtering data.
// - ALL_VALUES : Include null values in filtered results.
// - NULLS_ONLY : Only include null values in filtered results.
// - NON_NULLS_ONLY : Exclude null values from filtered results.
//
// This member is required.
NullOption FilterNullOption
// The aggregation function of the filter.
AggregationFunction *AggregationFunction
// Determines whether the maximum value in the filter value range should be
// included in the filtered results.
IncludeMaximum *bool
// Determines whether the minimum value in the filter value range should be
// included in the filtered results.
IncludeMinimum *bool
// The maximum value for the filter value range.
RangeMaximum *NumericRangeFilterValue
// The minimum value for the filter value range.
RangeMinimum *NumericRangeFilterValue
// Select all of the values. Null is not the assigned value of select all.
// - FILTER_ALL_VALUES
SelectAllOptions NumericFilterSelectAllOptions
noSmithyDocumentSerde
}
// The value input pf the numeric range filter.
type NumericRangeFilterValue struct {
// The parameter that is used in the numeric range.
Parameter *string
// The static value of the numeric range filter.
StaticValue *float64
noSmithyDocumentSerde
}
// The options that determine the numeric separator configuration.
type NumericSeparatorConfiguration struct {
// Determines the decimal separator.
DecimalSeparator NumericSeparatorSymbol
// The options that determine the thousands separator configuration.
ThousandsSeparator *ThousandSeparatorOptions
noSmithyDocumentSerde
}
// The parameters for Oracle.
type OracleParameters struct {
// The database.
//
// This member is required.
Database *string
// An Oracle host.
//
// This member is required.
Host *string
// The port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// Output column.
type OutputColumn struct {
// A description for a column.
Description *string
// A display name for the dataset.
Name *string
// The type.
Type ColumnDataType
noSmithyDocumentSerde
}
// A transform operation that overrides the dataset parameter values that are
// defined in another dataset.
type OverrideDatasetParameterOperation struct {
// The name of the parameter to be overridden with different values.
//
// This member is required.
ParameterName *string
// The new default values for the parameter.
NewDefaultValues *NewDefaultValues
// The new name for the parameter.
NewParameterName *string
noSmithyDocumentSerde
}
// The pagination configuration for a table visual or boxplot.
type PaginationConfiguration struct {
// Indicates the page number.
//
// This member is required.
PageNumber *int64
// Indicates how many items render in one page.
//
// This member is required.
PageSize *int64
noSmithyDocumentSerde
}
// A collection of options that configure how each panel displays in a small
// multiples chart.
type PanelConfiguration struct {
// Sets the background color for each panel.
BackgroundColor *string
// Determines whether or not a background for each small multiples panel is
// rendered.
BackgroundVisibility Visibility
// Sets the line color of panel borders.
BorderColor *string
// Sets the line style of panel borders.
BorderStyle PanelBorderStyle
// Sets the line thickness of panel borders.
BorderThickness *string
// Determines whether or not each panel displays a border.
BorderVisibility Visibility
// Sets the total amount of negative space to display between sibling panels.
GutterSpacing *string
// Determines whether or not negative space between sibling panels is rendered.
GutterVisibility Visibility
// Configures the title display within each small multiples panel.
Title *PanelTitleOptions
noSmithyDocumentSerde
}
// The options that determine the title styles for each small multiples panel.
type PanelTitleOptions struct {
// Configures the display properties of the given text.
FontConfiguration *FontConfiguration
// Sets the horizontal text alignment of the title within each panel.
HorizontalTextAlignment HorizontalTextAlignment
// Determines whether or not panel titles are displayed.
Visibility Visibility
noSmithyDocumentSerde
}
// The control of a parameter that users can interact with in a dashboard or an
// analysis. This is a union type structure. For this structure to be valid, only
// one of the attributes can be defined.
type ParameterControl struct {
// A control from a date parameter that specifies date and time.
DateTimePicker *ParameterDateTimePickerControl
// A control to display a dropdown list with buttons that are used to select a
// single value.
Dropdown *ParameterDropDownControl
// A control to display a list with buttons or boxes that are used to select
// either a single value or multiple values.
List *ParameterListControl
// A control to display a horizontal toggle bar. This is used to change a value by
// sliding the toggle.
Slider *ParameterSliderControl
// A control to display a text box that is used to enter multiple entries.
TextArea *ParameterTextAreaControl
// A control to display a text box that is used to enter a single entry.
TextField *ParameterTextFieldControl
noSmithyDocumentSerde
}
// A control from a date parameter that specifies date and time.
type ParameterDateTimePickerControl struct {
// The ID of the ParameterDateTimePickerControl .
//
// This member is required.
ParameterControlId *string
// The name of the ParameterDateTimePickerControl .
//
// This member is required.
SourceParameterName *string
// The title of the ParameterDateTimePickerControl .
//
// This member is required.
Title *string
// The display options of a control.
DisplayOptions *DateTimePickerControlDisplayOptions
noSmithyDocumentSerde
}
// The declaration definition of a parameter. For more information, see Parameters
// in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html)
// in the Amazon QuickSight User Guide. This is a union type structure. For this
// structure to be valid, only one of the attributes can be defined.
type ParameterDeclaration struct {
// A parameter declaration for the DateTime data type.
DateTimeParameterDeclaration *DateTimeParameterDeclaration
// A parameter declaration for the Decimal data type.
DecimalParameterDeclaration *DecimalParameterDeclaration
// A parameter declaration for the Integer data type.
IntegerParameterDeclaration *IntegerParameterDeclaration
// A parameter declaration for the String data type.
StringParameterDeclaration *StringParameterDeclaration
noSmithyDocumentSerde
}
// A control to display a dropdown list with buttons that are used to select a
// single value.
type ParameterDropDownControl struct {
// The ID of the ParameterDropDownControl .
//
// This member is required.
ParameterControlId *string
// The source parameter name of the ParameterDropDownControl .
//
// This member is required.
SourceParameterName *string
// The title of the ParameterDropDownControl .
//
// This member is required.
Title *string
// The values that are displayed in a control can be configured to only show
// values that are valid based on what's selected in other controls.
CascadingControlConfiguration *CascadingControlConfiguration
// The display options of a control.
DisplayOptions *DropDownControlDisplayOptions
// A list of selectable values that are used in a control.
SelectableValues *ParameterSelectableValues
// The type parameter name of the ParameterDropDownControl .
Type SheetControlListType
noSmithyDocumentSerde
}
// A control to display a list with buttons or boxes that are used to select
// either a single value or multiple values.
type ParameterListControl struct {
// The ID of the ParameterListControl .
//
// This member is required.
ParameterControlId *string
// The source parameter name of the ParameterListControl .
//
// This member is required.
SourceParameterName *string
// The title of the ParameterListControl .
//
// This member is required.
Title *string
// The values that are displayed in a control can be configured to only show
// values that are valid based on what's selected in other controls.
CascadingControlConfiguration *CascadingControlConfiguration
// The display options of a control.
DisplayOptions *ListControlDisplayOptions
// A list of selectable values that are used in a control.
SelectableValues *ParameterSelectableValues
// The type of ParameterListControl .
Type SheetControlListType
noSmithyDocumentSerde
}
// A list of Amazon QuickSight parameters and the list's override values.
type Parameters struct {
// The parameters that have a data type of date-time.
DateTimeParameters []DateTimeParameter
// The parameters that have a data type of decimal.
DecimalParameters []DecimalParameter
// The parameters that have a data type of integer.
IntegerParameters []IntegerParameter
// The parameters that have a data type of string.
StringParameters []StringParameter
noSmithyDocumentSerde
}
// A list of selectable values that are used in a control.
type ParameterSelectableValues struct {
// The column identifier that fetches values from the data set.
LinkToDataSetColumn *ColumnIdentifier
// The values that are used in ParameterSelectableValues .
Values []string
noSmithyDocumentSerde
}
// A control to display a horizontal toggle bar. This is used to change a value by
// sliding the toggle.
type ParameterSliderControl struct {
// The smaller value that is displayed at the left of the slider.
//
// This member is required.
MaximumValue float64
// The larger value that is displayed at the right of the slider.
//
// This member is required.
MinimumValue float64
// The ID of the ParameterSliderControl .
//
// This member is required.
ParameterControlId *string
// The source parameter name of the ParameterSliderControl .
//
// This member is required.
SourceParameterName *string
// The number of increments that the slider bar is divided into.
//
// This member is required.
StepSize float64
// The title of the ParameterSliderControl .
//
// This member is required.
Title *string
// The display options of a control.
DisplayOptions *SliderControlDisplayOptions
noSmithyDocumentSerde
}
// A control to display a text box that is used to enter multiple entries.
type ParameterTextAreaControl struct {
// The ID of the ParameterTextAreaControl .
//
// This member is required.
ParameterControlId *string
// The source parameter name of the ParameterTextAreaControl .
//
// This member is required.
SourceParameterName *string
// The title of the ParameterTextAreaControl .
//
// This member is required.
Title *string
// The delimiter that is used to separate the lines in text.
Delimiter *string
// The display options of a control.
DisplayOptions *TextAreaControlDisplayOptions
noSmithyDocumentSerde
}
// A control to display a text box that is used to enter a single entry.
type ParameterTextFieldControl struct {
// The ID of the ParameterTextFieldControl .
//
// This member is required.
ParameterControlId *string
// The source parameter name of the ParameterTextFieldControl .
//
// This member is required.
SourceParameterName *string
// The title of the ParameterTextFieldControl .
//
// This member is required.
Title *string
// The display options of a control.
DisplayOptions *TextFieldControlDisplayOptions
noSmithyDocumentSerde
}
// The options that determine the percentage display format configuration.
type PercentageDisplayFormatConfiguration struct {
// The option that determines the decimal places configuration.
DecimalPlacesConfiguration *DecimalPlacesConfiguration
// The options that determine the negative value configuration.
NegativeValueConfiguration *NegativeValueConfiguration
// The options that determine the null value format configuration.
NullValueFormatConfiguration *NullValueFormatConfiguration
// Determines the prefix value of the percentage format.
Prefix *string
// The options that determine the numeric separator configuration.
SeparatorConfiguration *NumericSeparatorConfiguration
// Determines the suffix value of the percentage format.
Suffix *string
noSmithyDocumentSerde
}
// An aggregation based on the percentile of values in a dimension or measure.
type PercentileAggregation struct {
// The percentile value. This value can be any numeric constant 0–100. A
// percentile value of 50 computes the median value of the measure.
PercentileValue *float64
noSmithyDocumentSerde
}
// The percent range in the visible range.
type PercentVisibleRange struct {
// The lower bound of the range.
From *float64
// The top bound of the range.
To *float64
noSmithyDocumentSerde
}
// The period over period computation configuration.
type PeriodOverPeriodComputation struct {
// The ID for a computation.
//
// This member is required.
ComputationId *string
// The time field that is used in a computation.
//
// This member is required.
Time *DimensionField
// The name of a computation.
Name *string
// The value field that is used in a computation.
Value *MeasureField
noSmithyDocumentSerde
}
// The period to date computation configuration.
type PeriodToDateComputation struct {
// The ID for a computation.
//
// This member is required.
ComputationId *string
// The time field that is used in a computation.
//
// This member is required.
Time *DimensionField
// The name of a computation.
Name *string
// The time granularity setup of period to date computation. Choose from the
// following options:
// - YEAR: Year to date.
// - MONTH: Month to date.
PeriodTimeGranularity TimeGranularity
// The value field that is used in a computation.
Value *MeasureField
noSmithyDocumentSerde
}
// A view of a data source that contains information about the shape of the data
// in the underlying source. This is a variant type structure. For this structure
// to be valid, only one of the attributes can be non-null.
//
// The following types satisfy this interface:
//
// PhysicalTableMemberCustomSql
// PhysicalTableMemberRelationalTable
// PhysicalTableMemberS3Source
type PhysicalTable interface {
isPhysicalTable()
}
// A physical table type built from the results of the custom SQL query.
type PhysicalTableMemberCustomSql struct {
Value CustomSql
noSmithyDocumentSerde
}
func (*PhysicalTableMemberCustomSql) isPhysicalTable() {}
// A physical table type for relational data sources.
type PhysicalTableMemberRelationalTable struct {
Value RelationalTable
noSmithyDocumentSerde
}
func (*PhysicalTableMemberRelationalTable) isPhysicalTable() {}
// A physical table type for as S3 data source.
type PhysicalTableMemberS3Source struct {
Value S3Source
noSmithyDocumentSerde
}
func (*PhysicalTableMemberS3Source) isPhysicalTable() {}
// The field well configuration of a pie chart.
type PieChartAggregatedFieldWells struct {
// The category (group/color) field wells of a pie chart.
Category []DimensionField
// The small multiples field well of a pie chart.
SmallMultiples []DimensionField
// The value field wells of a pie chart. Values are aggregated based on categories.
Values []MeasureField
noSmithyDocumentSerde
}
// The configuration of a pie chart.
type PieChartConfiguration struct {
// The label options of the group/color that is displayed in a pie chart.
CategoryLabelOptions *ChartAxisLabelOptions
// The contribution analysis (anomaly configuration) setup of the visual.
ContributionAnalysisDefaults []ContributionAnalysisDefault
// The options that determine if visual data labels are displayed.
DataLabels *DataLabelOptions
// The options that determine the shape of the chart. This option determines
// whether the chart is a pie chart or a donut chart.
DonutOptions *DonutOptions
// The field wells of the visual.
FieldWells *PieChartFieldWells
// The legend display setup of the visual.
Legend *LegendOptions
// The small multiples setup for the visual.
SmallMultiplesOptions *SmallMultiplesOptions
// The sort configuration of a pie chart.
SortConfiguration *PieChartSortConfiguration
// The tooltip display setup of the visual.
Tooltip *TooltipOptions
// The label options for the value that is displayed in a pie chart.
ValueLabelOptions *ChartAxisLabelOptions
// The palette (chart color) display setup of the visual.
VisualPalette *VisualPalette
noSmithyDocumentSerde
}
// The field well configuration of a pie chart. This is a union type structure.
// For this structure to be valid, only one of the attributes can be defined.
type PieChartFieldWells struct {
// The field well configuration of a pie chart.
PieChartAggregatedFieldWells *PieChartAggregatedFieldWells
noSmithyDocumentSerde
}
// The sort configuration of a pie chart.
type PieChartSortConfiguration struct {
// The limit on the number of categories that are displayed in a pie chart.
CategoryItemsLimit *ItemsLimitConfiguration
// The sort configuration of the category fields.
CategorySort []FieldSortOptions
// The limit on the number of small multiples panels that are displayed.
SmallMultiplesLimitConfiguration *ItemsLimitConfiguration
// The sort configuration of the small multiples field.
SmallMultiplesSort []FieldSortOptions
noSmithyDocumentSerde
}
// A pie or donut chart. The PieChartVisual structure describes a visual that is a
// member of the pie chart family. The following charts can be described by using
// this structure:
// - Pie charts
// - Donut charts
//
// For more information, see Using pie charts (https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html)
// in the Amazon QuickSight User Guide. For more information, see Using donut
// charts (https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html) in
// the Amazon QuickSight User Guide.
type PieChartVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers.
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration of a pie chart.
ChartConfiguration *PieChartConfiguration
// The column hierarchy that is used during drill-downs and drill-ups.
ColumnHierarchies []ColumnHierarchy
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// The field sort options for a pivot table sort configuration.
type PivotFieldSortOptions struct {
// The field ID for the field sort options.
//
// This member is required.
FieldId *string
// The sort by field for the field sort options.
//
// This member is required.
SortBy *PivotTableSortBy
noSmithyDocumentSerde
}
// The aggregated field well for the pivot table.
type PivotTableAggregatedFieldWells struct {
// The columns field well for a pivot table. Values are grouped by columns fields.
Columns []DimensionField
// The rows field well for a pivot table. Values are grouped by rows fields.
Rows []DimensionField
// The values field well for a pivot table. Values are aggregated based on rows
// and columns fields.
Values []MeasureField
noSmithyDocumentSerde
}
// The cell conditional formatting option for a pivot table.
type PivotTableCellConditionalFormatting struct {
// The field ID of the cell for conditional formatting.
//
// This member is required.
FieldId *string
// The scope of the cell for conditional formatting.
Scope *PivotTableConditionalFormattingScope
// A list of cell scopes for conditional formatting.
Scopes []PivotTableConditionalFormattingScope
// The text format of the cell for conditional formatting.
TextFormat *TextConditionalFormat
noSmithyDocumentSerde
}
// The conditional formatting for a PivotTableVisual .
type PivotTableConditionalFormatting struct {
// Conditional formatting options for a PivotTableVisual .
ConditionalFormattingOptions []PivotTableConditionalFormattingOption
noSmithyDocumentSerde
}
// Conditional formatting options for a PivotTableVisual .
type PivotTableConditionalFormattingOption struct {
// The cell conditional formatting option for a pivot table.
Cell *PivotTableCellConditionalFormatting
noSmithyDocumentSerde
}
// The scope of the cell for conditional formatting.
type PivotTableConditionalFormattingScope struct {
// The role (field, field total, grand total) of the cell for conditional
// formatting.
Role PivotTableConditionalFormattingScopeRole
noSmithyDocumentSerde
}
// The configuration for a PivotTableVisual .
type PivotTableConfiguration struct {
// The field options for a pivot table visual.
FieldOptions *PivotTableFieldOptions
// The field wells of the visual.
FieldWells *PivotTableFieldWells
// The paginated report options for a pivot table visual.
PaginatedReportOptions *PivotTablePaginatedReportOptions
// The sort configuration for a PivotTableVisual .
SortConfiguration *PivotTableSortConfiguration
// The table options for a pivot table visual.
TableOptions *PivotTableOptions
// The total options for a pivot table visual.
TotalOptions *PivotTableTotalOptions
noSmithyDocumentSerde
}
// The data path options for the pivot table field options.
type PivotTableDataPathOption struct {
// The list of data path values for the data path options.
//
// This member is required.
DataPathList []DataPathValue
// The width of the data path option.
Width *string
noSmithyDocumentSerde
}
// The collapse state options for the pivot table field options.
type PivotTableFieldCollapseStateOption struct {
// A tagged-union object that sets the collapse state.
//
// This member is required.
Target *PivotTableFieldCollapseStateTarget
// The state of the field target of a pivot table. Choose one of the following
// options:
// - COLLAPSED
// - EXPANDED
State PivotTableFieldCollapseState
noSmithyDocumentSerde
}
// The target of a pivot table field collapse state.
type PivotTableFieldCollapseStateTarget struct {
// The data path of the pivot table's header. Used to set the collapse state.
FieldDataPathValues []DataPathValue
// The field ID of the pivot table that the collapse state needs to be set to.
FieldId *string
noSmithyDocumentSerde
}
// The selected field options for the pivot table field options.
type PivotTableFieldOption struct {
// The field ID of the pivot table field.
//
// This member is required.
FieldId *string
// The custom label of the pivot table field.
CustomLabel *string
// The visibility of the pivot table field.
Visibility Visibility
noSmithyDocumentSerde
}
// The field options for a pivot table visual.
type PivotTableFieldOptions struct {
// The collapse state options for the pivot table field options.
CollapseStateOptions []PivotTableFieldCollapseStateOption
// The data path options for the pivot table field options.
DataPathOptions []PivotTableDataPathOption
// The selected field options for the pivot table field options.
SelectedFieldOptions []PivotTableFieldOption
noSmithyDocumentSerde
}
// The optional configuration of subtotals cells.
type PivotTableFieldSubtotalOptions struct {
// The field ID of the subtotal options.
FieldId *string
noSmithyDocumentSerde
}
// The field wells for a pivot table visual. This is a union type structure. For
// this structure to be valid, only one of the attributes can be defined.
type PivotTableFieldWells struct {
// The aggregated field well for the pivot table.
PivotTableAggregatedFieldWells *PivotTableAggregatedFieldWells
noSmithyDocumentSerde
}
// The table options for a pivot table visual.
type PivotTableOptions struct {
// The table cell style of cells.
CellStyle *TableCellStyle
// The visibility setting of a pivot table's collapsed row dimension fields. If
// the value of this structure is HIDDEN , all collapsed columns in a pivot table
// are automatically hidden. The default value is VISIBLE .
CollapsedRowDimensionsVisibility Visibility
// The table cell style of the column header.
ColumnHeaderStyle *TableCellStyle
// The visibility of the column names.
ColumnNamesVisibility Visibility
// The metric placement (row, column) options.
MetricPlacement PivotTableMetricPlacement
// The row alternate color options (widget status, row alternate colors).
RowAlternateColorOptions *RowAlternateColorOptions
// The table cell style of row field names.
RowFieldNamesStyle *TableCellStyle
// The table cell style of the row headers.
RowHeaderStyle *TableCellStyle
// The visibility of the single metric options.
SingleMetricVisibility Visibility
// Determines the visibility of the pivot table.
ToggleButtonsVisibility Visibility
noSmithyDocumentSerde
}
// The paginated report options for a pivot table visual.
type PivotTablePaginatedReportOptions struct {
// The visibility of the repeating header rows on each page.
OverflowColumnHeaderVisibility Visibility
// The visibility of the printing table overflow across pages.
VerticalOverflowVisibility Visibility
noSmithyDocumentSerde
}
// The sort by field for the field sort options.
type PivotTableSortBy struct {
// The column sort (field id, direction) for the pivot table sort by options.
Column *ColumnSort
// The data path sort (data path value, direction) for the pivot table sort by
// options.
DataPath *DataPathSort
// The field sort (field id, direction) for the pivot table sort by options.
Field *FieldSort
noSmithyDocumentSerde
}
// The sort configuration for a PivotTableVisual .
type PivotTableSortConfiguration struct {
// The field sort options for a pivot table sort configuration.
FieldSortOptions []PivotFieldSortOptions
noSmithyDocumentSerde
}
// The total options for a pivot table visual.
type PivotTableTotalOptions struct {
// The column subtotal options.
ColumnSubtotalOptions *SubtotalOptions
// The column total options.
ColumnTotalOptions *PivotTotalOptions
// The row subtotal options.
RowSubtotalOptions *SubtotalOptions
// The row total options.
RowTotalOptions *PivotTotalOptions
noSmithyDocumentSerde
}
// A pivot table. For more information, see Using pivot tables (https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html)
// in the Amazon QuickSight User Guide.
type PivotTableVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers..
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration settings of the visual.
ChartConfiguration *PivotTableConfiguration
// The conditional formatting for a PivotTableVisual .
ConditionalFormatting *PivotTableConditionalFormatting
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// The optional configuration of totals cells in a PivotTableVisual .
type PivotTotalOptions struct {
// The custom label string for the total cells.
CustomLabel *string
// The cell styling options for the total of header cells.
MetricHeaderCellStyle *TableCellStyle
// The placement (start, end) for the total cells.
Placement TableTotalsPlacement
// The scroll status (pinned, scrolled) for the total cells.
ScrollStatus TableTotalsScrollStatus
// The cell styling options for the total cells.
TotalCellStyle *TableCellStyle
// The visibility configuration for the total cells.
TotalsVisibility Visibility
// The cell styling options for the totals of value cells.
ValueCellStyle *TableCellStyle
noSmithyDocumentSerde
}
// The parameters for PostgreSQL.
type PostgreSqlParameters struct {
// Database.
//
// This member is required.
Database *string
// Host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// The option that determines the hierarchy of the fields that are defined during
// data preparation. These fields are available to use in any analysis that uses
// the data source.
type PredefinedHierarchy struct {
// The list of columns that define the predefined hierarchy.
//
// This member is required.
Columns []ColumnIdentifier
// The hierarchy ID of the predefined hierarchy.
//
// This member is required.
HierarchyId *string
// The option that determines the drill down filters for the predefined hierarchy.
DrillDownFilters []DrillDownFilter
noSmithyDocumentSerde
}
// The parameters for Presto.
type PrestoParameters struct {
// Catalog.
//
// This member is required.
Catalog *string
// Host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// The options that determine the presentation of the progress bar of a KPI visual.
type ProgressBarOptions struct {
// The visibility of the progress bar.
Visibility Visibility
noSmithyDocumentSerde
}
// A transform operation that projects columns. Operations that come after a
// projection can only refer to projected columns.
type ProjectOperation struct {
// Projected columns.
//
// This member is required.
ProjectedColumns []string
noSmithyDocumentSerde
}
// Information about a queued dataset SPICE ingestion.
type QueueInfo struct {
// The ID of the ongoing ingestion. The queued ingestion is waiting for the
// ongoing ingestion to complete.
//
// This member is required.
QueuedIngestion *string
// The ID of the queued ingestion.
//
// This member is required.
WaitingOnIngestion *string
noSmithyDocumentSerde
}
// The aggregated field well configuration of a RadarChartVisual .
type RadarChartAggregatedFieldWells struct {
// The aggregated field well categories of a radar chart.
Category []DimensionField
// The color that are assigned to the aggregated field wells of a radar chart.
Color []DimensionField
// The values that are assigned to the aggregated field wells of a radar chart.
Values []MeasureField
noSmithyDocumentSerde
}
// The configured style settings of a radar chart.
type RadarChartAreaStyleSettings struct {
// The visibility settings of a radar chart.
Visibility Visibility
noSmithyDocumentSerde
}
// The configuration of a RadarChartVisual .
type RadarChartConfiguration struct {
// Determines the visibility of the colors of alternatign bands in a radar chart.
AlternateBandColorsVisibility Visibility
// The color of the even-numbered alternate bands of a radar chart.
AlternateBandEvenColor *string
// The color of the odd-numbered alternate bands of a radar chart.
AlternateBandOddColor *string
// The axis behavior options of a radar chart.
AxesRangeScale RadarChartAxesRangeScale
// The base sreies settings of a radar chart.
BaseSeriesSettings *RadarChartSeriesSettings
// The category axis of a radar chart.
CategoryAxis *AxisDisplayOptions
// The category label options of a radar chart.
CategoryLabelOptions *ChartAxisLabelOptions
// The color axis of a radar chart.
ColorAxis *AxisDisplayOptions
// The color label options of a radar chart.
ColorLabelOptions *ChartAxisLabelOptions
// The field well configuration of a RadarChartVisual .
FieldWells *RadarChartFieldWells
// The legend display setup of the visual.
Legend *LegendOptions
// The shape of the radar chart.
Shape RadarChartShape
// The sort configuration of a RadarChartVisual .
SortConfiguration *RadarChartSortConfiguration
// The start angle of a radar chart's axis.
StartAngle *float64
// The palette (chart color) display setup of the visual.
VisualPalette *VisualPalette
noSmithyDocumentSerde
}
// The field wells of a radar chart visual.
type RadarChartFieldWells struct {
// The aggregated field wells of a radar chart visual.
RadarChartAggregatedFieldWells *RadarChartAggregatedFieldWells
noSmithyDocumentSerde
}
// The series settings of a radar chart.
type RadarChartSeriesSettings struct {
// The area style settings of a radar chart.
AreaStyleSettings *RadarChartAreaStyleSettings
noSmithyDocumentSerde
}
// The sort configuration of a RadarChartVisual .
type RadarChartSortConfiguration struct {
// The category items limit for a radar chart.
CategoryItemsLimit *ItemsLimitConfiguration
// The category sort options of a radar chart.
CategorySort []FieldSortOptions
// The color items limit of a radar chart.
ColorItemsLimit *ItemsLimitConfiguration
// The color sort configuration of a radar chart.
ColorSort []FieldSortOptions
noSmithyDocumentSerde
}
// A radar chart visual.
type RadarChartVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers.
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration settings of the visual.
ChartConfiguration *RadarChartConfiguration
// The column hierarchy that is used during drill-downs and drill-ups.
ColumnHierarchies []ColumnHierarchy
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// A structure that represents a range constant.
type RangeConstant struct {
// The maximum value for a range constant.
Maximum *string
// The minimum value for a range constant.
Minimum *string
noSmithyDocumentSerde
}
// The range ends label type of a data path label.
type RangeEndsLabelType struct {
// The visibility of the range ends label.
Visibility Visibility
noSmithyDocumentSerde
}
// The parameters for Amazon RDS.
type RdsParameters struct {
// Database.
//
// This member is required.
Database *string
// Instance ID.
//
// This member is required.
InstanceId *string
noSmithyDocumentSerde
}
// The parameters for Amazon Redshift. The ClusterId field can be blank if Host
// and Port are both set. The Host and Port fields can be blank if the ClusterId
// field is set.
type RedshiftParameters struct {
// Database.
//
// This member is required.
Database *string
// Cluster ID. This field can be blank if the Host and Port are provided.
ClusterId *string
// Host. This field can be blank if ClusterId is provided.
Host *string
// Port. This field can be blank if the ClusterId is provided.
Port int32
noSmithyDocumentSerde
}
// The reference line visual display options.
type ReferenceLine struct {
// The data configuration of the reference line.
//
// This member is required.
DataConfiguration *ReferenceLineDataConfiguration
// The label configuration of the reference line.
LabelConfiguration *ReferenceLineLabelConfiguration
// The status of the reference line. Choose one of the following options:
// - ENABLE
// - DISABLE
Status WidgetStatus
// The style configuration of the reference line.
StyleConfiguration *ReferenceLineStyleConfiguration
noSmithyDocumentSerde
}
// The configuration for a custom label on a ReferenceLine .
type ReferenceLineCustomLabelConfiguration struct {
// The string text of the custom label.
//
// This member is required.
CustomLabel *string
noSmithyDocumentSerde
}
// The data configuration of the reference line.
type ReferenceLineDataConfiguration struct {
// The axis binding type of the reference line. Choose one of the following
// options:
// - PrimaryY
// - SecondaryY
AxisBinding AxisBinding
// The dynamic configuration of the reference line data configuration.
DynamicConfiguration *ReferenceLineDynamicDataConfiguration
// The static data configuration of the reference line data configuration.
StaticConfiguration *ReferenceLineStaticDataConfiguration
noSmithyDocumentSerde
}
// The dynamic configuration of the reference line data configuration.
type ReferenceLineDynamicDataConfiguration struct {
// The calculation that is used in the dynamic data.
//
// This member is required.
Calculation *NumericalAggregationFunction
// The column that the dynamic data targets.
//
// This member is required.
Column *ColumnIdentifier
// The aggregation function that is used in the dynamic data.
MeasureAggregationFunction *AggregationFunction
noSmithyDocumentSerde
}
// The label configuration of a reference line.
type ReferenceLineLabelConfiguration struct {
// The custom label configuration of the label in a reference line.
CustomLabelConfiguration *ReferenceLineCustomLabelConfiguration
// The font color configuration of the label in a reference line.
FontColor *string
// The font configuration of the label in a reference line.
FontConfiguration *FontConfiguration
// The horizontal position configuration of the label in a reference line. Choose
// one of the following options:
// - LEFT
// - CENTER
// - RIGHT
HorizontalPosition ReferenceLineLabelHorizontalPosition
// The value label configuration of the label in a reference line.
ValueLabelConfiguration *ReferenceLineValueLabelConfiguration
// The vertical position configuration of the label in a reference line. Choose
// one of the following options:
// - ABOVE
// - BELOW
VerticalPosition ReferenceLineLabelVerticalPosition
noSmithyDocumentSerde
}
// The static data configuration of the reference line data configuration.
type ReferenceLineStaticDataConfiguration struct {
// The double input of the static data.
//
// This member is required.
Value float64
noSmithyDocumentSerde
}
// The style configuration of the reference line.
type ReferenceLineStyleConfiguration struct {
// The hex color of the reference line.
Color *string
// The pattern type of the line style. Choose one of the following options:
// - SOLID
// - DASHED
// - DOTTED
Pattern ReferenceLinePatternType
noSmithyDocumentSerde
}
// The value label configuration of the label in a reference line.
type ReferenceLineValueLabelConfiguration struct {
// The format configuration of the value label.
FormatConfiguration *NumericFormatConfiguration
// The relative position of the value label. Choose one of the following options:
// - BEFORE_CUSTOM_LABEL
// - AFTER_CUSTOM_LABEL
RelativePosition ReferenceLineValueLabelRelativePosition
noSmithyDocumentSerde
}
// The refresh configuration of a dataset.
type RefreshConfiguration struct {
// The incremental refresh for the dataset.
//
// This member is required.
IncrementalRefresh *IncrementalRefresh
noSmithyDocumentSerde
}
// Specifies the interval between each scheduled refresh of a dataset.
type RefreshFrequency struct {
// The interval between scheduled refreshes. Valid values are as follows:
// - MINUTE15 : The dataset refreshes every 15 minutes. This value is only
// supported for incremental refreshes. This interval can only be used for one
// schedule per dataset.
// - MINUTE30 :The dataset refreshes every 30 minutes. This value is only
// supported for incremental refreshes. This interval can only be used for one
// schedule per dataset.
// - HOURLY : The dataset refreshes every hour. This interval can only be used
// for one schedule per dataset.
// - DAILY : The dataset refreshes every day.
// - WEEKLY : The dataset refreshes every week.
// - MONTHLY : The dataset refreshes every month.
//
// This member is required.
Interval RefreshInterval
// The day of the week that you want to schedule the refresh on. This value is
// required for weekly and monthly refresh intervals.
RefreshOnDay *ScheduleRefreshOnEntity
// The time of day that you want the datset to refresh. This value is expressed in
// HH:MM format. This field is not required for schedules that refresh hourly.
TimeOfTheDay *string
// The timezone that you want the refresh schedule to use. The timezone ID must
// match a corresponding ID found on java.util.time.getAvailableIDs() .
Timezone *string
noSmithyDocumentSerde
}
// The refresh schedule of a dataset.
type RefreshSchedule struct {
// The type of refresh that a datset undergoes. Valid values are as follows:
// - FULL_REFRESH : A complete refresh of a dataset.
// - INCREMENTAL_REFRESH : A partial refresh of some rows of a dataset, based on
// the time window specified.
// For more information on full and incremental refreshes, see Refreshing SPICE
// data (https://docs.aws.amazon.com/quicksight/latest/user/refreshing-imported-data.html)
// in the Amazon QuickSight User Guide.
//
// This member is required.
RefreshType IngestionType
// The frequency for the refresh schedule.
//
// This member is required.
ScheduleFrequency *RefreshFrequency
// An identifier for the refresh schedule.
//
// This member is required.
ScheduleId *string
// The Amazon Resource Name (ARN) for the refresh schedule.
Arn *string
// Time after which the refresh schedule can be started, expressed in
// YYYY-MM-DDTHH:MM:SS format.
StartAfterDateTime *time.Time
noSmithyDocumentSerde
}
// The feature configurations of an embedded Amazon QuickSight console.
type RegisteredUserConsoleFeatureConfigurations struct {
// The state persistence configurations of an embedded Amazon QuickSight console.
StatePersistence *StatePersistenceConfigurations
noSmithyDocumentSerde
}
// Information about the dashboard you want to embed.
type RegisteredUserDashboardEmbeddingConfiguration struct {
// The dashboard ID for the dashboard that you want the user to see first. This ID
// is included in the output URL. When the URL in response is accessed, Amazon
// QuickSight renders this dashboard if the user has permissions to view it. If the
// user does not have permission to view this dashboard, they see a permissions
// error message.
//
// This member is required.
InitialDashboardId *string
// The feature configurations of an embbedded Amazon QuickSight dashboard.
FeatureConfigurations *RegisteredUserDashboardFeatureConfigurations
noSmithyDocumentSerde
}
// The feature configuration for an embedded dashboard.
type RegisteredUserDashboardFeatureConfigurations struct {
// The bookmarks configuration for an embedded dashboard in Amazon QuickSight.
Bookmarks *BookmarksConfigurations
// The state persistence settings of an embedded dashboard.
StatePersistence *StatePersistenceConfigurations
noSmithyDocumentSerde
}
// The experience that you are embedding. You can use this object to generate a
// url that embeds a visual into your application.
type RegisteredUserDashboardVisualEmbeddingConfiguration struct {
// The visual ID for the visual that you want the user to embed. This ID is
// included in the output URL. When the URL in response is accessed, Amazon
// QuickSight renders this visual. The Amazon Resource Name (ARN) of the dashboard
// that the visual belongs to must be included in the AuthorizedResourceArns
// parameter. Otherwise, the request will fail with InvalidParameterValueException .
//
// This member is required.
InitialDashboardVisualId *DashboardVisualId
noSmithyDocumentSerde
}
// The type of experience you want to embed. For registered users, you can embed
// Amazon QuickSight dashboards or the Amazon QuickSight console. Exactly one of
// the experience configurations is required. You can choose Dashboard or
// QuickSightConsole . You cannot choose more than one experience configuration.
type RegisteredUserEmbeddingExperienceConfiguration struct {
// The configuration details for providing a dashboard embedding experience.
Dashboard *RegisteredUserDashboardEmbeddingConfiguration
// The type of embedding experience. In this case, Amazon QuickSight visuals.
DashboardVisual *RegisteredUserDashboardVisualEmbeddingConfiguration
// The configuration details for embedding the Q search bar. For more information
// about embedding the Q search bar, see Embedding Overview (https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html)
// in the Amazon QuickSight User Guide.
QSearchBar *RegisteredUserQSearchBarEmbeddingConfiguration
// The configuration details for providing each Amazon QuickSight console
// embedding experience. This can be used along with custom permissions to restrict
// access to certain features. For more information, see Customizing Access to the
// Amazon QuickSight Console (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html)
// in the Amazon QuickSight User Guide. Use GenerateEmbedUrlForRegisteredUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html)
// where you want to provide an authoring portal that allows users to create data
// sources, datasets, analyses, and dashboards. The users who accesses an embedded
// Amazon QuickSight console needs to belong to the author or admin security
// cohort. If you want to restrict permissions to some of these features, add a
// custom permissions profile to the user with the UpdateUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html)
// API operation. Use the RegisterUser (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html)
// API operation to add a new user with a custom permission profile attached. For
// more information, see the following sections in the Amazon QuickSight User
// Guide:
// - Embedding the Full Functionality of the Amazon QuickSight Console for
// Authenticated Users (https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users.html)
// - Customizing Access to the Amazon QuickSight Console (https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html)
// For more information about the high-level steps for embedding and for an
// interactive demo of the ways you can customize embedding, visit the Amazon
// QuickSight Developer Portal (https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html)
// .
QuickSightConsole *RegisteredUserQuickSightConsoleEmbeddingConfiguration
noSmithyDocumentSerde
}
// Information about the Q search bar embedding experience.
type RegisteredUserQSearchBarEmbeddingConfiguration struct {
// The ID of the Q topic that you want to make the starting topic in the Q search
// bar. You can find a topic ID by navigating to the Topics pane in the Amazon
// QuickSight application and opening a topic. The ID is in the URL for the topic
// that you open. If you don't specify an initial topic, a list of all shared
// topics is shown in the Q bar for your readers. When you select an initial topic,
// you can specify whether or not readers are allowed to select other topics from
// the available ones in the list.
InitialTopicId *string
noSmithyDocumentSerde
}
// Information about the Amazon QuickSight console that you want to embed.
type RegisteredUserQuickSightConsoleEmbeddingConfiguration struct {
// The embedding configuration of an embedded Amazon QuickSight console.
FeatureConfigurations *RegisteredUserConsoleFeatureConfigurations
// The initial URL path for the Amazon QuickSight console. InitialPath is
// required. The entry point URL is constrained to the following paths:
// - /start
// - /start/analyses
// - /start/dashboards
// - /start/favorites
// - /dashboards/DashboardId . DashboardId is the actual ID key from the Amazon
// QuickSight console URL of the dashboard.
// - /analyses/AnalysisId . AnalysisId is the actual ID key from the Amazon
// QuickSight console URL of the analysis.
InitialPath *string
noSmithyDocumentSerde
}
// A physical table type for relational data sources.
type RelationalTable struct {
// The Amazon Resource Name (ARN) for the data source.
//
// This member is required.
DataSourceArn *string
// The column schema of the table.
//
// This member is required.
InputColumns []InputColumn
// The name of the relational table.
//
// This member is required.
Name *string
// The catalog associated with a table.
Catalog *string
// The schema name. This name applies to certain relational database engines.
Schema *string
noSmithyDocumentSerde
}
// A RelativeDatesFilter filters relative dates values.
type RelativeDatesFilter struct {
// The date configuration of the filter.
//
// This member is required.
AnchorDateConfiguration *AnchorDateConfiguration
// The column that the filter is applied to.
//
// This member is required.
Column *ColumnIdentifier
// An identifier that uniquely identifies a filter within a dashboard, analysis,
// or template.
//
// This member is required.
FilterId *string
// This option determines how null values should be treated when filtering data.
// - ALL_VALUES : Include null values in filtered results.
// - NULLS_ONLY : Only include null values in filtered results.
// - NON_NULLS_ONLY : Exclude null values from filtered results.
//
// This member is required.
NullOption FilterNullOption
// The range date type of the filter. Choose one of the options below:
// - PREVIOUS
// - THIS
// - LAST
// - NOW
// - NEXT
//
// This member is required.
RelativeDateType RelativeDateType
// The level of time precision that is used to aggregate DateTime values.
//
// This member is required.
TimeGranularity TimeGranularity
// The configuration for the exclude period of the filter.
ExcludePeriodConfiguration *ExcludePeriodConfiguration
// The minimum granularity (period granularity) of the relative dates filter.
MinimumGranularity TimeGranularity
// The parameter whose value should be used for the filter value.
ParameterName *string
// The date value of the filter.
RelativeDateValue *int32
noSmithyDocumentSerde
}
// The display options of a control.
type RelativeDateTimeControlDisplayOptions struct {
// Customize how dates are formatted in controls.
DateTimeFormat *string
// The options to configure the title visibility, name, and font size.
TitleOptions *LabelOptions
noSmithyDocumentSerde
}
// A transform operation that renames a column.
type RenameColumnOperation struct {
// The name of the column to be renamed.
//
// This member is required.
ColumnName *string
// The new name for the column.
//
// This member is required.
NewColumnName *string
noSmithyDocumentSerde
}
// Permission for the resource.
type ResourcePermission struct {
// The IAM action to grant or revoke permissions on.
//
// This member is required.
Actions []string
// The Amazon Resource Name (ARN) of the principal. This can be one of the
// following:
// - The ARN of an Amazon QuickSight user or group associated with a data source
// or dataset. (This is common.)
// - The ARN of an Amazon QuickSight user, group, or namespace associated with
// an analysis, dashboard, template, or theme. (This is common.)
// - The ARN of an Amazon Web Services account root: This is an IAM ARN rather
// than a QuickSight ARN. Use this option only to share resources (templates)
// across Amazon Web Services accounts. (This is less common.)
//
// This member is required.
Principal *string
noSmithyDocumentSerde
}
// The rolling date configuration of a date time filter.
type RollingDateConfiguration struct {
// The expression of the rolling date configuration.
//
// This member is required.
Expression *string
// The data set that is used in the rolling date configuration.
DataSetIdentifier *string
noSmithyDocumentSerde
}
// Determines the row alternate color options.
type RowAlternateColorOptions struct {
// Determines the list of row alternate colors.
RowAlternateColors []string
// Determines the widget status.
Status WidgetStatus
noSmithyDocumentSerde
}
// Information about rows for a data set SPICE ingestion.
type RowInfo struct {
// The number of rows that were not ingested.
RowsDropped *int64
// The number of rows that were ingested.
RowsIngested *int64
// The total number of rows in the dataset.
TotalRowsInDataset *int64
noSmithyDocumentSerde
}
// Information about a dataset that contains permissions for row-level security
// (RLS). The permissions dataset maps fields to users or groups. For more
// information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset (https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html)
// in the Amazon QuickSight User Guide. The option to deny permissions by setting
// PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.
type RowLevelPermissionDataSet struct {
// The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
//
// This member is required.
Arn *string
// The type of permissions to use when interpreting the permissions for RLS.
// DENY_ACCESS is included for backward compatibility only.
//
// This member is required.
PermissionPolicy RowLevelPermissionPolicy
// The user or group rules associated with the dataset that contains permissions
// for RLS. By default, FormatVersion is VERSION_1 . When FormatVersion is
// VERSION_1 , UserName and GroupName are required. When FormatVersion is VERSION_2
// , UserARN and GroupARN are required, and Namespace must not exist.
FormatVersion RowLevelPermissionFormatVersion
// The namespace associated with the dataset that contains permissions for RLS.
Namespace *string
// The status of the row-level security permission dataset. If enabled, the status
// is ENABLED . If disabled, the status is DISABLED .
Status Status
noSmithyDocumentSerde
}
// The configuration of tags on a dataset to set row-level security.
type RowLevelPermissionTagConfiguration struct {
// A set of rules associated with row-level security, such as the tag names and
// columns that they are assigned to.
//
// This member is required.
TagRules []RowLevelPermissionTagRule
// The status of row-level security tags. If enabled, the status is ENABLED . If
// disabled, the status is DISABLED .
Status Status
// A list of tag configuration rules to apply to a dataset. All tag configurations
// have the OR condition. Tags within each tile will be joined (AND). At least one
// rule in this structure must have all tag values assigned to it to apply
// Row-level security (RLS) to the dataset.
TagRuleConfigurations [][]string
noSmithyDocumentSerde
}
// A set of rules associated with a tag.
type RowLevelPermissionTagRule struct {
// The column name that a tag key is assigned to.
//
// This member is required.
ColumnName *string
// The unique key for a tag.
//
// This member is required.
TagKey *string
// A string that you want to use to filter by all the values in a column in the
// dataset and don’t want to list the values one by one. For example, you can use
// an asterisk as your match all value.
MatchAllValue *string
// A string that you want to use to delimit the values when you pass the values at
// run time. For example, you can delimit the values with a comma.
TagMultiValueDelimiter *string
noSmithyDocumentSerde
}
// The parameters for S3.
type S3Parameters struct {
// Location of the Amazon S3 manifest file. This is NULL if the manifest file was
// uploaded into Amazon QuickSight.
//
// This member is required.
ManifestFileLocation *ManifestFileLocation
// Use the RoleArn structure to override an account-wide role for a specific S3
// data source. For example, say an account administrator has turned off all S3
// access with an account-wide role. The administrator can then use RoleArn to
// bypass the account-wide role and allow S3 access for the single S3 data source
// that is specified in the structure, even if the account-wide role forbidding S3
// access is still active.
RoleArn *string
noSmithyDocumentSerde
}
// A physical table type for an S3 data source.
type S3Source struct {
// The Amazon Resource Name (ARN) for the data source.
//
// This member is required.
DataSourceArn *string
// A physical table type for an S3 data source. For files that aren't JSON, only
// STRING data types are supported in input columns.
//
// This member is required.
InputColumns []InputColumn
// Information about the format for the S3 source file or files.
UploadSettings *UploadSettings
noSmithyDocumentSerde
}
// The configuration of the same-sheet target visuals that you want to be
// filtered. This is a union type structure. For this structure to be valid, only
// one of the attributes can be defined.
type SameSheetTargetVisualConfiguration struct {
// The options that choose the target visual in the same sheet. Valid values are
// defined as follows:
// - ALL_VISUALS : Applies the filter operation to all visuals in the same sheet.
TargetVisualOptions TargetVisualOptions
// A list of the target visual IDs that are located in the same sheet of the
// analysis.
TargetVisuals []string
noSmithyDocumentSerde
}
// The field well configuration of a sankey diagram.
type SankeyDiagramAggregatedFieldWells struct {
// The destination field wells of a sankey diagram.
Destination []DimensionField
// The source field wells of a sankey diagram.
Source []DimensionField
// The weight field wells of a sankey diagram.
Weight []MeasureField
noSmithyDocumentSerde
}
// The configuration of a sankey diagram.
type SankeyDiagramChartConfiguration struct {
// The data label configuration of a sankey diagram.
DataLabels *DataLabelOptions
// The field well configuration of a sankey diagram.
FieldWells *SankeyDiagramFieldWells
// The sort configuration of a sankey diagram.
SortConfiguration *SankeyDiagramSortConfiguration
noSmithyDocumentSerde
}
// The field well configuration of a sankey diagram.
type SankeyDiagramFieldWells struct {
// The field well configuration of a sankey diagram.
SankeyDiagramAggregatedFieldWells *SankeyDiagramAggregatedFieldWells
noSmithyDocumentSerde
}
// The sort configuration of a sankey diagram.
type SankeyDiagramSortConfiguration struct {
// The limit on the number of destination nodes that are displayed in a sankey
// diagram.
DestinationItemsLimit *ItemsLimitConfiguration
// The limit on the number of source nodes that are displayed in a sankey diagram.
SourceItemsLimit *ItemsLimitConfiguration
// The sort configuration of the weight fields.
WeightSort []FieldSortOptions
noSmithyDocumentSerde
}
// A sankey diagram. For more information, see Using Sankey diagrams (https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html)
// in the Amazon QuickSight User Guide.
type SankeyDiagramVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers.
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration of a sankey diagram.
ChartConfiguration *SankeyDiagramChartConfiguration
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// The aggregated field well of a scatter plot.
type ScatterPlotCategoricallyAggregatedFieldWells struct {
// The category field well of a scatter plot.
Category []DimensionField
// The label field well of a scatter plot.
Label []DimensionField
// The size field well of a scatter plot.
Size []MeasureField
// The x-axis field well of a scatter plot. The x-axis is aggregated by category.
XAxis []MeasureField
// The y-axis field well of a scatter plot. The y-axis is aggregated by category.
YAxis []MeasureField
noSmithyDocumentSerde
}
// The configuration of a scatter plot.
type ScatterPlotConfiguration struct {
// The options that determine if visual data labels are displayed.
DataLabels *DataLabelOptions
// The field wells of the visual.
FieldWells *ScatterPlotFieldWells
// The legend display setup of the visual.
Legend *LegendOptions
// The legend display setup of the visual.
Tooltip *TooltipOptions
// The palette (chart color) display setup of the visual.
VisualPalette *VisualPalette
// The label display options (grid line, range, scale, and axis step) of the
// scatter plot's x-axis.
XAxisDisplayOptions *AxisDisplayOptions
// The label options (label text, label visibility, and sort icon visibility) of
// the scatter plot's x-axis.
XAxisLabelOptions *ChartAxisLabelOptions
// The label display options (grid line, range, scale, and axis step) of the
// scatter plot's y-axis.
YAxisDisplayOptions *AxisDisplayOptions
// The label options (label text, label visibility, and sort icon visibility) of
// the scatter plot's y-axis.
YAxisLabelOptions *ChartAxisLabelOptions
noSmithyDocumentSerde
}
// The field well configuration of a scatter plot. This is a union type structure.
// For this structure to be valid, only one of the attributes can be defined.
type ScatterPlotFieldWells struct {
// The aggregated field wells of a scatter plot. The x and y-axes of scatter plots
// with aggregated field wells are aggregated by category, label, or both.
ScatterPlotCategoricallyAggregatedFieldWells *ScatterPlotCategoricallyAggregatedFieldWells
// The unaggregated field wells of a scatter plot. The x and y-axes of these
// scatter plots are unaggregated.
ScatterPlotUnaggregatedFieldWells *ScatterPlotUnaggregatedFieldWells
noSmithyDocumentSerde
}
// The unaggregated field wells of a scatter plot.
type ScatterPlotUnaggregatedFieldWells struct {
// The category field well of a scatter plot.
Category []DimensionField
// The label field well of a scatter plot.
Label []DimensionField
// The size field well of a scatter plot.
Size []MeasureField
// The x-axis field well of a scatter plot. The x-axis is a dimension field and
// cannot be aggregated.
XAxis []DimensionField
// The y-axis field well of a scatter plot. The y-axis is a dimension field and
// cannot be aggregated.
YAxis []DimensionField
noSmithyDocumentSerde
}
// A scatter plot. For more information, see Using scatter plots (https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html)
// in the Amazon QuickSight User Guide.
type ScatterPlotVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers.
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration settings of the visual.
ChartConfiguration *ScatterPlotConfiguration
// The column hierarchy that is used during drill-downs and drill-ups.
ColumnHierarchies []ColumnHierarchy
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// The refresh on entity for weekly or monthly schedules.
type ScheduleRefreshOnEntity struct {
// The day of the month that you want to schedule refresh on.
DayOfMonth *string
// The day of the week that you want to schedule a refresh on.
DayOfWeek DayOfWeek
noSmithyDocumentSerde
}
// The visual display options for a data zoom scroll bar.
type ScrollBarOptions struct {
// The visibility of the data zoom scroll bar.
Visibility Visibility
// The visibility range for the data zoom scroll bar.
VisibleRange *VisibleRangeOptions
noSmithyDocumentSerde
}
// The options that determine the presentation of the secondary value of a KPI
// visual.
type SecondaryValueOptions struct {
// Determines the visibility of the secondary value.
Visibility Visibility
noSmithyDocumentSerde
}
// The configuration of a page break after a section.
type SectionAfterPageBreak struct {
// The option that enables or disables a page break at the end of a section.
Status SectionPageBreakStatus
noSmithyDocumentSerde
}
// The options for the canvas of a section-based layout.
type SectionBasedLayoutCanvasSizeOptions struct {
// The options for a paper canvas of a section-based layout.
PaperCanvasSizeOptions *SectionBasedLayoutPaperCanvasSizeOptions
noSmithyDocumentSerde
}
// The configuration for a section-based layout.
type SectionBasedLayoutConfiguration struct {
// A list of body section configurations.
//
// This member is required.
BodySections []BodySectionConfiguration
// The options for the canvas of a section-based layout.
//
// This member is required.
CanvasSizeOptions *SectionBasedLayoutCanvasSizeOptions
// A list of footer section configurations.
//
// This member is required.
FooterSections []HeaderFooterSectionConfiguration
// A list of header section configurations.
//
// This member is required.
HeaderSections []HeaderFooterSectionConfiguration
noSmithyDocumentSerde
}
// The options for a paper canvas of a section-based layout.
type SectionBasedLayoutPaperCanvasSizeOptions struct {
// Defines the spacing between the canvas content and the top, bottom, left, and
// right edges.
PaperMargin *Spacing
// The paper orientation that is used to define canvas dimensions. Choose one of
// the following options:
// - PORTRAIT
// - LANDSCAPE
PaperOrientation PaperOrientation
// The paper size that is used to define canvas dimensions.
PaperSize PaperSize
noSmithyDocumentSerde
}
// The layout configuration of a section.
type SectionLayoutConfiguration struct {
// The free-form layout configuration of a section.
//
// This member is required.
FreeFormLayout *FreeFormSectionLayoutConfiguration
noSmithyDocumentSerde
}
// The configuration of a page break for a section.
type SectionPageBreakConfiguration struct {
// The configuration of a page break after a section.
After *SectionAfterPageBreak
noSmithyDocumentSerde
}
// The options that style a section.
type SectionStyle struct {
// The height of a section. Heights can only be defined for header and footer
// sections. The default height margin is 0.5 inches.
Height *string
// The spacing between section content and its top, bottom, left, and right edges.
// There is no padding by default.
Padding *Spacing
noSmithyDocumentSerde
}
// The configuration for applying a filter to specific sheets or visuals. You can
// apply this filter to multiple visuals that are on one sheet or to all visuals on
// a sheet. This is a union type structure. For this structure to be valid, only
// one of the attributes can be defined.
type SelectedSheetsFilterScopeConfiguration struct {
// The sheet ID and visual IDs of the sheet and visuals that the filter is applied
// to.
SheetVisualScopingConfigurations []SheetVisualScopingConfiguration
noSmithyDocumentSerde
}
// A structure that represents a semantic entity type.
type SemanticEntityType struct {
// The semantic entity sub type name.
SubTypeName *string
// The semantic entity type name.
TypeName *string
// The semantic entity type parameters.
TypeParameters map[string]string
noSmithyDocumentSerde
}
// A structure that represents a semantic type.
type SemanticType struct {
// The semantic type falsey cell value.
FalseyCellValue *string
// The other names or aliases for the false cell value.
FalseyCellValueSynonyms []string
// The semantic type sub type name.
SubTypeName *string
// The semantic type truthy cell value.
TruthyCellValue *string
// The other names or aliases for the true cell value.
TruthyCellValueSynonyms []string
// The semantic type name.
TypeName *string
// The semantic type parameters.
TypeParameters map[string]string
noSmithyDocumentSerde
}
// The series item configuration of a line chart. This is a union type structure.
// For this structure to be valid, only one of the attributes can be defined.
type SeriesItem struct {
// The data field series item configuration of a line chart.
DataFieldSeriesItem *DataFieldSeriesItem
// The field series item configuration of a line chart.
FieldSeriesItem *FieldSeriesItem
noSmithyDocumentSerde
}
// The parameters for ServiceNow.
type ServiceNowParameters struct {
// URL of the base site.
//
// This member is required.
SiteBaseUrl *string
noSmithyDocumentSerde
}
// The key-value pair used for the row-level security tags feature.
type SessionTag struct {
// The key for the tag.
//
// This member is required.
Key *string
// The value that you want to assign the tag.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// The configuration of adding parameters in action.
type SetParameterValueConfiguration struct {
// The destination parameter name of the SetParameterValueConfiguration .
//
// This member is required.
DestinationParameterName *string
// The configuration of destination parameter values. This is a union type
// structure. For this structure to be valid, only one of the attributes can be
// defined.
//
// This member is required.
Value *DestinationParameterValueConfiguration
noSmithyDocumentSerde
}
// The shape conditional formatting of a filled map visual.
type ShapeConditionalFormat struct {
// The conditional formatting for the shape background color of a filled map
// visual.
//
// This member is required.
BackgroundColor *ConditionalFormattingColor
noSmithyDocumentSerde
}
// A sheet, which is an object that contains a set of visuals that are viewed
// together on one page in Amazon QuickSight. Every analysis and dashboard contains
// at least one sheet. Each sheet contains at least one visualization widget, for
// example a chart, pivot table, or narrative insight. Sheets can be associated
// with other components, such as controls, filters, and so on.
type Sheet struct {
// The name of a sheet. This name is displayed on the sheet's tab in the Amazon
// QuickSight console.
Name *string
// The unique identifier associated with a sheet.
SheetId *string
noSmithyDocumentSerde
}
// A grid layout to define the placement of sheet control.
type SheetControlLayout struct {
// The configuration that determines the elements and canvas size options of sheet
// control.
//
// This member is required.
Configuration *SheetControlLayoutConfiguration
noSmithyDocumentSerde
}
// The configuration that determines the elements and canvas size options of sheet
// control.
type SheetControlLayoutConfiguration struct {
// The configuration that determines the elements and canvas size options of sheet
// control.
GridLayout *GridLayoutConfiguration
noSmithyDocumentSerde
}
// Sheet controls option.
type SheetControlsOption struct {
// Visibility state.
VisibilityState DashboardUIState
noSmithyDocumentSerde
}
// A sheet is an object that contains a set of visuals that are viewed together on
// one page in a paginated report. Every analysis and dashboard must contain at
// least one sheet.
type SheetDefinition struct {
// The unique identifier of a sheet.
//
// This member is required.
SheetId *string
// The layout content type of the sheet. Choose one of the following options:
// - PAGINATED : Creates a sheet for a paginated report.
// - INTERACTIVE : Creates a sheet for an interactive dashboard.
ContentType SheetContentType
// A description of the sheet.
Description *string
// The list of filter controls that are on a sheet. For more information, see
// Adding filter controls to analysis sheets (https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html)
// in the Amazon QuickSight User Guide.
FilterControls []FilterControl
// Layouts define how the components of a sheet are arranged. For more
// information, see Types of layout (https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html)
// in the Amazon QuickSight User Guide.
Layouts []Layout
// The name of the sheet. This name is displayed on the sheet's tab in the Amazon
// QuickSight console.
Name *string
// The list of parameter controls that are on a sheet. For more information, see
// Using a Control with a Parameter in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html)
// in the Amazon QuickSight User Guide.
ParameterControls []ParameterControl
// The control layouts of the sheet.
SheetControlLayouts []SheetControlLayout
// The text boxes that are on a sheet.
TextBoxes []SheetTextBox
// The title of the sheet.
Title *string
// A list of the visuals that are on a sheet. Visual placement is determined by
// the layout of the sheet.
Visuals []Visual
noSmithyDocumentSerde
}
// The override configuration of the rendering rules of a sheet.
type SheetElementConfigurationOverrides struct {
// Determines whether or not the overrides are visible. Choose one of the
// following options:
// - VISIBLE
// - HIDDEN
Visibility Visibility
noSmithyDocumentSerde
}
// The rendering rules of a sheet that uses a free-form layout.
type SheetElementRenderingRule struct {
// The override configuration of the rendering rules of a sheet.
//
// This member is required.
ConfigurationOverrides *SheetElementConfigurationOverrides
// The expression of the rendering rules of a sheet.
//
// This member is required.
Expression *string
noSmithyDocumentSerde
}
// The sheet layout maximization options of a dashbaord.
type SheetLayoutElementMaximizationOption struct {
// The status of the sheet layout maximization options of a dashbaord.
AvailabilityStatus DashboardBehavior
noSmithyDocumentSerde
}
// The theme display options for sheets.
type SheetStyle struct {
// The display options for tiles.
Tile *TileStyle
// The layout options for tiles.
TileLayout *TileLayoutStyle
noSmithyDocumentSerde
}
// A text box.
type SheetTextBox struct {
// The unique identifier for a text box. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have text boxes that share identifiers.
//
// This member is required.
SheetTextBoxId *string
// The content that is displayed in the text box.
Content *string
noSmithyDocumentSerde
}
// The filter that is applied to the options.
type SheetVisualScopingConfiguration struct {
// The scope of the applied entities. Choose one of the following options:
// - ALL_VISUALS
// - SELECTED_VISUALS
//
// This member is required.
Scope FilterVisualScope
// The selected sheet that the filter is applied to.
//
// This member is required.
SheetId *string
// The selected visuals that the filter is applied to.
VisualIds []string
noSmithyDocumentSerde
}
// The text format for the title. This is a union type structure. For this
// structure to be valid, only one of the attributes can be defined.
type ShortFormatText struct {
// Plain text format.
PlainText *string
// Rich text. Examples of rich text include bold, underline, and italics.
RichText *string
noSmithyDocumentSerde
}
// A SignupResponse object that contains a summary of a newly created account.
type SignupResponse struct {
// The name of your Amazon QuickSight account.
AccountName *string
// The type of Active Directory that is being used to authenticate the Amazon
// QuickSight account. Valid values are SIMPLE_AD , AD_CONNECTOR , and MICROSOFT_AD
// .
DirectoryType *string
// A Boolean that is TRUE if the Amazon QuickSight uses IAM as an authentication
// method.
IAMUser bool
// The user login name for your Amazon QuickSight account.
UserLoginName *string
noSmithyDocumentSerde
}
// The simple cluster marker of the cluster marker.
type SimpleClusterMarker struct {
// The color of the simple cluster marker.
Color *string
noSmithyDocumentSerde
}
// The display options of a control.
type SliderControlDisplayOptions struct {
// The options to configure the title visibility, name, and font size.
TitleOptions *LabelOptions
noSmithyDocumentSerde
}
// Options that determine the layout and display options of a chart's small
// multiples.
type SmallMultiplesOptions struct {
// Sets the maximum number of visible columns to display in the grid of small
// multiples panels. The default is Auto , which automatically adjusts the columns
// in the grid to fit the overall layout and size of the given chart.
MaxVisibleColumns *int64
// Sets the maximum number of visible rows to display in the grid of small
// multiples panels. The default value is Auto , which automatically adjusts the
// rows in the grid to fit the overall layout and size of the given chart.
MaxVisibleRows *int64
// Configures the display options for each small multiples panel.
PanelConfiguration *PanelConfiguration
noSmithyDocumentSerde
}
// The parameters for Snowflake.
type SnowflakeParameters struct {
// Database.
//
// This member is required.
Database *string
// Host.
//
// This member is required.
Host *string
// Warehouse.
//
// This member is required.
Warehouse *string
noSmithyDocumentSerde
}
// The configuration of spacing (often a margin or padding).
type Spacing struct {
// Define the bottom spacing.
Bottom *string
// Define the left spacing.
Left *string
// Define the right spacing.
Right *string
// Define the top spacing.
Top *string
noSmithyDocumentSerde
}
// The parameters for Spark.
type SparkParameters struct {
// Host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// The parameters for SQL Server.
type SqlServerParameters struct {
// Database.
//
// This member is required.
Database *string
// Host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects
// to your underlying data source.
type SslProperties struct {
// A Boolean option to control whether SSL should be disabled.
DisableSsl bool
noSmithyDocumentSerde
}
// The state perssitence configuration of an embedded dashboard.
type StatePersistenceConfigurations struct {
// Determines if a Amazon QuickSight dashboard's state persistence settings are
// turned on or off.
//
// This member is required.
Enabled bool
noSmithyDocumentSerde
}
// A string parameter for a dataset.
type StringDatasetParameter struct {
// An identifier for the string parameter that is created in the dataset.
//
// This member is required.
Id *string
// The name of the string parameter that is created in the dataset.
//
// This member is required.
Name *string
// The value type of the dataset parameter. Valid values are single value or multi
// value .
//
// This member is required.
ValueType DatasetParameterValueType
// A list of default values for a given string dataset parameter type. This
// structure only accepts static values.
DefaultValues *StringDatasetParameterDefaultValues
noSmithyDocumentSerde
}
// The default values of a string parameter.
type StringDatasetParameterDefaultValues struct {
// A list of static default values for a given string parameter.
StaticValues []string
noSmithyDocumentSerde
}
// The default values of the StringParameterDeclaration .
type StringDefaultValues struct {
// The dynamic value of the StringDefaultValues . Different defaults displayed
// according to users, groups, and values mapping.
DynamicValue *DynamicDefaultValue
// The static values of the DecimalDefaultValues .
StaticValues []string
noSmithyDocumentSerde
}
// Formatting configuration for string fields.
type StringFormatConfiguration struct {
// The options that determine the null value format configuration.
NullValueFormatConfiguration *NullValueFormatConfiguration
// The formatting configuration for numeric strings.
NumericFormatConfiguration *NumericFormatConfiguration
noSmithyDocumentSerde
}
// A string parameter.
type StringParameter struct {
// A display name for a string parameter.
//
// This member is required.
Name *string
// The values of a string parameter.
//
// This member is required.
Values []string
noSmithyDocumentSerde
}
// A parameter declaration for the String data type.
type StringParameterDeclaration struct {
// The name of the parameter that is being declared.
//
// This member is required.
Name *string
// The value type determines whether the parameter is a single-value or
// multi-value parameter.
//
// This member is required.
ParameterValueType ParameterValueType
// The default values of a parameter. If the parameter is a single-value
// parameter, a maximum of one default value can be provided.
DefaultValues *StringDefaultValues
// A list of dataset parameters that are mapped to an analysis parameter.
MappedDataSetParameters []MappedDataSetParameter
// The configuration that defines the default value of a String parameter when a
// value has not been set.
ValueWhenUnset *StringValueWhenUnsetConfiguration
noSmithyDocumentSerde
}
// The configuration that defines the default value of a String parameter when a
// value has not been set.
type StringValueWhenUnsetConfiguration struct {
// A custom value that's used when the value of a parameter isn't set.
CustomValue *string
// The built-in options for default values. The value can be one of the following:
// - RECOMMENDED : The recommended value.
// - NULL : The NULL value.
ValueWhenUnsetOption ValueWhenUnsetOption
noSmithyDocumentSerde
}
// The subtotal options.
type SubtotalOptions struct {
// The custom label string for the subtotal cells.
CustomLabel *string
// The field level (all, custom, last) for the subtotal cells.
FieldLevel PivotTableSubtotalLevel
// The optional configuration of subtotal cells.
FieldLevelOptions []PivotTableFieldSubtotalOptions
// The cell styling options for the subtotals of header cells.
MetricHeaderCellStyle *TableCellStyle
// The cell styling options for the subtotal cells.
TotalCellStyle *TableCellStyle
// The visibility configuration for the subtotal cells.
TotalsVisibility Visibility
// The cell styling options for the subtotals of value cells.
ValueCellStyle *TableCellStyle
noSmithyDocumentSerde
}
// The aggregated field well for the table.
type TableAggregatedFieldWells struct {
// The group by field well for a pivot table. Values are grouped by group by
// fields.
GroupBy []DimensionField
// The values field well for a pivot table. Values are aggregated based on group
// by fields.
Values []MeasureField
noSmithyDocumentSerde
}
// The border options for a table border.
type TableBorderOptions struct {
// The color of a table border.
Color *string
// The style (none, solid) of a table border.
Style TableBorderStyle
// The thickness of a table border.
Thickness *int32
noSmithyDocumentSerde
}
// The cell conditional formatting option for a table.
type TableCellConditionalFormatting struct {
// The field ID of the cell for conditional formatting.
//
// This member is required.
FieldId *string
// The text format of the cell for conditional formatting.
TextFormat *TextConditionalFormat
noSmithyDocumentSerde
}
// The sizing options for the table image configuration.
type TableCellImageSizingConfiguration struct {
// The cell scaling configuration of the sizing options for the table image
// configuration.
TableCellImageScalingConfiguration TableCellImageScalingConfiguration
noSmithyDocumentSerde
}
// The table cell style for a cell in pivot table or table visual.
type TableCellStyle struct {
// The background color for the table cells.
BackgroundColor *string
// The borders for the table cells.
Border *GlobalTableBorderOptions
// The font configuration of the table cells.
FontConfiguration *FontConfiguration
// The height color for the table cells.
Height *int32
// The horizontal text alignment (left, center, right, auto) for the table cells.
HorizontalTextAlignment HorizontalTextAlignment
// The text wrap (none, wrap) for the table cells.
TextWrap TextWrap
// The vertical text alignment (top, middle, bottom) for the table cells.
VerticalTextAlignment VerticalTextAlignment
// The visibility of the table cells.
Visibility Visibility
noSmithyDocumentSerde
}
// The conditional formatting for a PivotTableVisual .
type TableConditionalFormatting struct {
// Conditional formatting options for a PivotTableVisual .
ConditionalFormattingOptions []TableConditionalFormattingOption
noSmithyDocumentSerde
}
// Conditional formatting options for a PivotTableVisual .
type TableConditionalFormattingOption struct {
// The cell conditional formatting option for a table.
Cell *TableCellConditionalFormatting
// The row conditional formatting option for a table.
Row *TableRowConditionalFormatting
noSmithyDocumentSerde
}
// The configuration for a TableVisual .
type TableConfiguration struct {
// The field options for a table visual.
FieldOptions *TableFieldOptions
// The field wells of the visual.
FieldWells *TableFieldWells
// The paginated report options for a table visual.
PaginatedReportOptions *TablePaginatedReportOptions
// The sort configuration for a TableVisual .
SortConfiguration *TableSortConfiguration
// A collection of inline visualizations to display within a chart.
TableInlineVisualizations []TableInlineVisualization
// The table options for a table visual.
TableOptions *TableOptions
// The total options for a table visual.
TotalOptions *TotalOptions
noSmithyDocumentSerde
}
// The custom icon content for the table link content configuration.
type TableFieldCustomIconContent struct {
// The icon set type (link) of the custom icon content for table URL link content.
Icon TableFieldIconSetType
noSmithyDocumentSerde
}
// The custom text content (value, font configuration) for the table link content
// configuration.
type TableFieldCustomTextContent struct {
// The font configuration of the custom text content for the table URL link
// content.
//
// This member is required.
FontConfiguration *FontConfiguration
// The string value of the custom text content for the table URL link content.
Value *string
noSmithyDocumentSerde
}
// The image configuration of a table field URL.
type TableFieldImageConfiguration struct {
// The sizing options for the table image configuration.
SizingOptions *TableCellImageSizingConfiguration
noSmithyDocumentSerde
}
// The link configuration of a table field URL.
type TableFieldLinkConfiguration struct {
// The URL content (text, icon) for the table link configuration.
//
// This member is required.
Content *TableFieldLinkContentConfiguration
// The URL target (new tab, new window, same tab) for the table link configuration.
//
// This member is required.
Target URLTargetConfiguration
noSmithyDocumentSerde
}
// The URL content (text, icon) for the table link configuration.
type TableFieldLinkContentConfiguration struct {
// The custom icon content for the table link content configuration.
CustomIconContent *TableFieldCustomIconContent
// The custom text content (value, font configuration) for the table link content
// configuration.
CustomTextContent *TableFieldCustomTextContent
noSmithyDocumentSerde
}
// The options for a table field.
type TableFieldOption struct {
// The field ID for a table field.
//
// This member is required.
FieldId *string
// The custom label for a table field.
CustomLabel *string
// The URL configuration for a table field.
URLStyling *TableFieldURLConfiguration
// The visibility of a table field.
Visibility Visibility
// The width for a table field.
Width *string
noSmithyDocumentSerde
}
// The field options for a table visual.
type TableFieldOptions struct {
// The order of field IDs of the field options for a table visual.
Order []string
// The selected field options for the table field options.
SelectedFieldOptions []TableFieldOption
noSmithyDocumentSerde
}
// The URL configuration for a table field.
type TableFieldURLConfiguration struct {
// The image configuration of a table field URL.
ImageConfiguration *TableFieldImageConfiguration
// The link configuration of a table field URL.
LinkConfiguration *TableFieldLinkConfiguration
noSmithyDocumentSerde
}
// The field wells for a table visual. This is a union type structure. For this
// structure to be valid, only one of the attributes can be defined.
type TableFieldWells struct {
// The aggregated field well for the table.
TableAggregatedFieldWells *TableAggregatedFieldWells
// The unaggregated field well for the table.
TableUnaggregatedFieldWells *TableUnaggregatedFieldWells
noSmithyDocumentSerde
}
// The inline visualization of a specific type to display within a chart.
type TableInlineVisualization struct {
// The configuration of the inline visualization of the data bars within a chart.
DataBars *DataBarsOptions
noSmithyDocumentSerde
}
// The table options for a table visual.
type TableOptions struct {
// The table cell style of table cells.
CellStyle *TableCellStyle
// The table cell style of a table header.
HeaderStyle *TableCellStyle
// The orientation (vertical, horizontal) for a table.
Orientation TableOrientation
// The row alternate color options (widget status, row alternate colors) for a
// table.
RowAlternateColorOptions *RowAlternateColorOptions
noSmithyDocumentSerde
}
// The paginated report options for a table visual.
type TablePaginatedReportOptions struct {
// The visibility of repeating header rows on each page.
OverflowColumnHeaderVisibility Visibility
// The visibility of printing table overflow across pages.
VerticalOverflowVisibility Visibility
noSmithyDocumentSerde
}
// The conditional formatting of a table row.
type TableRowConditionalFormatting struct {
// The conditional formatting color (solid, gradient) of the background for a
// table row.
BackgroundColor *ConditionalFormattingColor
// The conditional formatting color (solid, gradient) of the text for a table row.
TextColor *ConditionalFormattingColor
noSmithyDocumentSerde
}
// The side border options for a table.
type TableSideBorderOptions struct {
// The table border options of the bottom border.
Bottom *TableBorderOptions
// The table border options of the inner horizontal border.
InnerHorizontal *TableBorderOptions
// The table border options of the inner vertical border.
InnerVertical *TableBorderOptions
// The table border options of the left border.
Left *TableBorderOptions
// The table border options of the right border.
Right *TableBorderOptions
// The table border options of the top border.
Top *TableBorderOptions
noSmithyDocumentSerde
}
// The sort configuration for a TableVisual .
type TableSortConfiguration struct {
// The pagination configuration (page size, page number) for the table.
PaginationConfiguration *PaginationConfiguration
// The field sort options for rows in the table.
RowSort []FieldSortOptions
noSmithyDocumentSerde
}
// The unaggregated field well for the table.
type TableUnaggregatedFieldWells struct {
// The values field well for a pivot table. Values are unaggregated for an
// unaggregated table.
Values []UnaggregatedField
noSmithyDocumentSerde
}
// A table visual. For more information, see Using tables as visuals (https://docs.aws.amazon.com/quicksight/latest/user/tabular.html)
// in the Amazon QuickSight User Guide.
type TableVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers..
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration settings of the visual.
ChartConfiguration *TableConfiguration
// The conditional formatting for a PivotTableVisual .
ConditionalFormatting *TableConditionalFormatting
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// The key or keys of the key-value pairs for the resource tag or tags assigned to
// the resource.
type Tag struct {
// Tag key.
//
// This member is required.
Key *string
// Tag value.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// A transform operation that tags a column with additional information.
type TagColumnOperation struct {
// The column that this operation acts on.
//
// This member is required.
ColumnName *string
// The dataset column tag, currently only used for geospatial type tagging. This
// is not tags for the Amazon Web Services tagging feature.
//
// This member is required.
Tags []ColumnTag
noSmithyDocumentSerde
}
// A template object. A template is an entity in Amazon QuickSight that
// encapsulates the metadata required to create an analysis and that you can use to
// create a dashboard. A template adds a layer of abstraction by using placeholders
// to replace the dataset associated with an analysis. You can use templates to
// create dashboards by replacing dataset placeholders with datasets that follow
// the same schema that was used to create the source analysis and template. You
// can share templates across Amazon Web Services accounts by allowing users in
// other Amazon Web Services accounts to create a template or a dashboard from an
// existing template.
type Template struct {
// The Amazon Resource Name (ARN) of the template.
Arn *string
// Time when this was created.
CreatedTime *time.Time
// Time when this was last updated.
LastUpdatedTime *time.Time
// The display name of the template.
Name *string
// The ID for the template. This is unique per Amazon Web Services Region for each
// Amazon Web Services account.
TemplateId *string
// A structure describing the versions of the template.
Version *TemplateVersion
noSmithyDocumentSerde
}
// The template alias.
type TemplateAlias struct {
// The display name of the template alias.
AliasName *string
// The Amazon Resource Name (ARN) of the template alias.
Arn *string
// The version number of the template alias.
TemplateVersionNumber *int64
noSmithyDocumentSerde
}
// List of errors that occurred when the template version creation failed.
type TemplateError struct {
// Description of the error type.
Message *string
// Type of error.
Type TemplateErrorType
// An error path that shows which entities caused the template error.
ViolatedEntities []Entity
noSmithyDocumentSerde
}
// The source analysis of the template.
type TemplateSourceAnalysis struct {
// The Amazon Resource Name (ARN) of the resource.
//
// This member is required.
Arn *string
// A structure containing information about the dataset references used as
// placeholders in the template.
//
// This member is required.
DataSetReferences []DataSetReference
noSmithyDocumentSerde
}
// The source entity of the template.
type TemplateSourceEntity struct {
// The source analysis, if it is based on an analysis.
SourceAnalysis *TemplateSourceAnalysis
// The source template, if it is based on an template.
SourceTemplate *TemplateSourceTemplate
noSmithyDocumentSerde
}
// The source template of the template.
type TemplateSourceTemplate struct {
// The Amazon Resource Name (ARN) of the resource.
//
// This member is required.
Arn *string
noSmithyDocumentSerde
}
// The template summary.
type TemplateSummary struct {
// A summary of a template.
Arn *string
// The last time that this template was created.
CreatedTime *time.Time
// The last time that this template was updated.
LastUpdatedTime *time.Time
// A structure containing a list of version numbers for the template summary.
LatestVersionNumber *int64
// A display name for the template.
Name *string
// The ID of the template. This ID is unique per Amazon Web Services Region for
// each Amazon Web Services account.
TemplateId *string
noSmithyDocumentSerde
}
// A version of a template.
type TemplateVersion struct {
// The time that this template version was created.
CreatedTime *time.Time
// Schema of the dataset identified by the placeholder. Any dashboard created from
// this template should be bound to new datasets matching the same schema described
// through this API operation.
DataSetConfigurations []DataSetConfiguration
// The description of the template.
Description *string
// Errors associated with this template version.
Errors []TemplateError
// A list of the associated sheets with the unique identifier and name of each
// sheet.
Sheets []Sheet
// The Amazon Resource Name (ARN) of an analysis or template that was used to
// create this template.
SourceEntityArn *string
// The status that is associated with the template.
// - CREATION_IN_PROGRESS
// - CREATION_SUCCESSFUL
// - CREATION_FAILED
// - UPDATE_IN_PROGRESS
// - UPDATE_SUCCESSFUL
// - UPDATE_FAILED
// - DELETED
Status ResourceStatus
// The ARN of the theme associated with this version of the template.
ThemeArn *string
// The version number of the template version.
VersionNumber *int64
noSmithyDocumentSerde
}
// The detailed definition of a template.
type TemplateVersionDefinition struct {
// An array of dataset configurations. These configurations define the required
// columns for each dataset used within a template.
//
// This member is required.
DataSetConfigurations []DataSetConfiguration
// The configuration for default analysis settings.
AnalysisDefaults *AnalysisDefaults
// An array of calculated field definitions for the template.
CalculatedFields []CalculatedField
// An array of template-level column configurations. Column configurations are
// used to set default formatting for a column that's used throughout a template.
ColumnConfigurations []ColumnConfiguration
// Filter definitions for a template. For more information, see Filtering Data (https://docs.aws.amazon.com/quicksight/latest/user/filtering-visual-data.html)
// in the Amazon QuickSight User Guide.
FilterGroups []FilterGroup
// An array of parameter declarations for a template. Parameters are named
// variables that can transfer a value for use by an action or an object. For more
// information, see Parameters in Amazon QuickSight (https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html)
// in the Amazon QuickSight User Guide.
ParameterDeclarations []ParameterDeclaration
// An array of sheet definitions for a template.
Sheets []SheetDefinition
noSmithyDocumentSerde
}
// The template version.
type TemplateVersionSummary struct {
// The Amazon Resource Name (ARN) of the template version.
Arn *string
// The time that this template version was created.
CreatedTime *time.Time
// The description of the template version.
Description *string
// The status of the template version.
Status ResourceStatus
// The version number of the template version.
VersionNumber *int64
noSmithyDocumentSerde
}
// The parameters for Teradata.
type TeradataParameters struct {
// Database.
//
// This member is required.
Database *string
// Host.
//
// This member is required.
Host *string
// Port.
//
// This member is required.
Port int32
noSmithyDocumentSerde
}
// The display options of a control.
type TextAreaControlDisplayOptions struct {
// The configuration of the placeholder options in a text area control.
PlaceholderOptions *TextControlPlaceholderOptions
// The options to configure the title visibility, name, and font size.
TitleOptions *LabelOptions
noSmithyDocumentSerde
}
// The conditional formatting for the text.
type TextConditionalFormat struct {
// The conditional formatting for the text background color.
BackgroundColor *ConditionalFormattingColor
// The conditional formatting for the icon.
Icon *ConditionalFormattingIcon
// The conditional formatting for the text color.
TextColor *ConditionalFormattingColor
noSmithyDocumentSerde
}
// The configuration of the placeholder options in a text control.
type TextControlPlaceholderOptions struct {
// The visibility configuration of the placeholder options in a text control.
Visibility Visibility
noSmithyDocumentSerde
}
// The display options of a control.
type TextFieldControlDisplayOptions struct {
// The configuration of the placeholder options in a text field control.
PlaceholderOptions *TextControlPlaceholderOptions
// The options to configure the title visibility, name, and font size.
TitleOptions *LabelOptions
noSmithyDocumentSerde
}
// Summary information about a theme.
type Theme struct {
// The Amazon Resource Name (ARN) of the theme.
Arn *string
// The date and time that the theme was created.
CreatedTime *time.Time
// The date and time that the theme was last updated.
LastUpdatedTime *time.Time
// The name that the user gives to the theme.
Name *string
// The identifier that the user gives to the theme.
ThemeId *string
// The type of theme, based on how it was created. Valid values include: QUICKSIGHT
// and CUSTOM .
Type ThemeType
// A version of a theme.
Version *ThemeVersion
noSmithyDocumentSerde
}
// An alias for a theme.
type ThemeAlias struct {
// The display name of the theme alias.
AliasName *string
// The Amazon Resource Name (ARN) of the theme alias.
Arn *string
// The version number of the theme alias.
ThemeVersionNumber *int64
noSmithyDocumentSerde
}
// The theme configuration. This configuration contains all of the display
// properties for a theme.
type ThemeConfiguration struct {
// Color properties that apply to chart data colors.
DataColorPalette *DataColorPalette
// Display options related to sheets.
Sheet *SheetStyle
// Determines the typography options.
Typography *Typography
// Color properties that apply to the UI and to charts, excluding the colors that
// apply to data.
UIColorPalette *UIColorPalette
noSmithyDocumentSerde
}
// Theme error.
type ThemeError struct {
// The error message.
Message *string
// The type of error.
Type ThemeErrorType
noSmithyDocumentSerde
}
// The theme summary.
type ThemeSummary struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// The date and time that this theme was created.
CreatedTime *time.Time
// The last date and time that this theme was updated.
LastUpdatedTime *time.Time
// The latest version number for the theme.
LatestVersionNumber *int64
// the display name for the theme.
Name *string
// The ID of the theme. This ID is unique per Amazon Web Services Region for each
// Amazon Web Services account.
ThemeId *string
noSmithyDocumentSerde
}
// A version of a theme.
type ThemeVersion struct {
// The Amazon Resource Name (ARN) of the resource.
Arn *string
// The Amazon QuickSight-defined ID of the theme that a custom theme inherits
// from. All themes initially inherit from a default Amazon QuickSight theme.
BaseThemeId *string
// The theme configuration, which contains all the theme display properties.
Configuration *ThemeConfiguration
// The date and time that this theme version was created.
CreatedTime *time.Time
// The description of the theme.
Description *string
// Errors associated with the theme.
Errors []ThemeError
// The status of the theme version.
Status ResourceStatus
// The version number of the theme.
VersionNumber *int64
noSmithyDocumentSerde
}
// The theme version.
type ThemeVersionSummary struct {
// The Amazon Resource Name (ARN) of the theme version.
Arn *string
// The date and time that this theme version was created.
CreatedTime *time.Time
// The description of the theme version.
Description *string
// The status of the theme version.
Status ResourceStatus
// The version number of the theme version.
VersionNumber *int64
noSmithyDocumentSerde
}
// The options that determine the thousands separator configuration.
type ThousandSeparatorOptions struct {
// Determines the thousands separator symbol.
Symbol NumericSeparatorSymbol
// Determines the visibility of the thousands separator.
Visibility Visibility
noSmithyDocumentSerde
}
// The display options for the layout of tiles on a sheet.
type TileLayoutStyle struct {
// The gutter settings that apply between tiles.
Gutter *GutterStyle
// The margin settings that apply around the outside edge of sheets.
Margin *MarginStyle
noSmithyDocumentSerde
}
// Display options related to tiles on a sheet.
type TileStyle struct {
// The border around a tile.
Border *BorderStyle
noSmithyDocumentSerde
}
// The forecast properties setup of a forecast in the line chart.
type TimeBasedForecastProperties struct {
// The lower boundary setup of a forecast computation.
LowerBoundary *float64
// The periods backward setup of a forecast computation.
PeriodsBackward *int32
// The periods forward setup of a forecast computation.
PeriodsForward *int32
// The prediction interval setup of a forecast computation.
PredictionInterval *int32
// The seasonality setup of a forecast computation. Choose one of the following
// options:
// - NULL : The input is set to NULL .
// - NON_NULL : The input is set to a custom value.
Seasonality *int32
// The upper boundary setup of a forecast computation.
UpperBoundary *float64
noSmithyDocumentSerde
}
// A TimeEqualityFilter filters values that are equal to a given value.
type TimeEqualityFilter struct {
// The column that the filter is applied to.
//
// This member is required.
Column *ColumnIdentifier
// An identifier that uniquely identifies a filter within a dashboard, analysis,
// or template.
//
// This member is required.
FilterId *string
// The parameter whose value should be used for the filter value. This field is
// mutually exclusive to Value .
ParameterName *string
// The level of time precision that is used to aggregate DateTime values.
TimeGranularity TimeGranularity
// The value of a TimeEquality filter. This field is mutually exclusive to
// ParameterName .
Value *time.Time
noSmithyDocumentSerde
}
// The time range drill down filter.
type TimeRangeDrillDownFilter struct {
// The column that the filter is applied to.
//
// This member is required.
Column *ColumnIdentifier
// The maximum value for the filter value range.
//
// This member is required.
RangeMaximum *time.Time
// The minimum value for the filter value range.
//
// This member is required.
RangeMinimum *time.Time
// The level of time precision that is used to aggregate DateTime values.
//
// This member is required.
TimeGranularity TimeGranularity
noSmithyDocumentSerde
}
// A TimeRangeFilter filters values that are between two specified values.
type TimeRangeFilter struct {
// The column that the filter is applied to.
//
// This member is required.
Column *ColumnIdentifier
// An identifier that uniquely identifies a filter within a dashboard, analysis,
// or template.
//
// This member is required.
FilterId *string
// This option determines how null values should be treated when filtering data.
// - ALL_VALUES : Include null values in filtered results.
// - NULLS_ONLY : Only include null values in filtered results.
// - NON_NULLS_ONLY : Exclude null values from filtered results.
//
// This member is required.
NullOption FilterNullOption
// The exclude period of the time range filter.
ExcludePeriodConfiguration *ExcludePeriodConfiguration
// Determines whether the maximum value in the filter value range should be
// included in the filtered results.
IncludeMaximum *bool
// Determines whether the minimum value in the filter value range should be
// included in the filtered results.
IncludeMinimum *bool
// The maximum value for the filter value range.
RangeMaximumValue *TimeRangeFilterValue
// The minimum value for the filter value range.
RangeMinimumValue *TimeRangeFilterValue
// The level of time precision that is used to aggregate DateTime values.
TimeGranularity TimeGranularity
noSmithyDocumentSerde
}
// The value of a time range filter. This is a union type structure. For this
// structure to be valid, only one of the attributes can be defined.
type TimeRangeFilterValue struct {
// The parameter type input value.
Parameter *string
// The rolling date input value.
RollingDate *RollingDateConfiguration
// The static input value.
StaticValue *time.Time
noSmithyDocumentSerde
}
// The tooltip. This is a union type structure. For this structure to be valid,
// only one of the attributes can be defined.
type TooltipItem struct {
// The tooltip item for the columns that are not part of a field well.
ColumnTooltipItem *ColumnTooltipItem
// The tooltip item for the fields.
FieldTooltipItem *FieldTooltipItem
noSmithyDocumentSerde
}
// The display options for the visual tooltip.
type TooltipOptions struct {
// The setup for the detailed tooltip. The tooltip setup is always saved. The
// display type is decided based on the tooltip type.
FieldBasedTooltip *FieldBasedTooltip
// The selected type for the tooltip. Choose one of the following options:
// - BASIC : A basic tooltip.
// - DETAILED : A detailed tooltip.
SelectedTooltipType SelectedTooltipType
// Determines whether or not the tooltip is visible.
TooltipVisibility Visibility
noSmithyDocumentSerde
}
// A TopBottomFilter filters values that are at the top or the bottom.
type TopBottomFilter struct {
// The aggregation and sort configuration of the top bottom filter.
//
// This member is required.
AggregationSortConfigurations []AggregationSortConfiguration
// The column that the filter is applied to.
//
// This member is required.
Column *ColumnIdentifier
// An identifier that uniquely identifies a filter within a dashboard, analysis,
// or template.
//
// This member is required.
FilterId *string
// The number of items to include in the top bottom filter results.
Limit *int32
// The parameter whose value should be used for the filter value.
ParameterName *string
// The level of time precision that is used to aggregate DateTime values.
TimeGranularity TimeGranularity
noSmithyDocumentSerde
}
// The top movers and bottom movers computation setup.
type TopBottomMoversComputation struct {
// The category field that is used in a computation.
//
// This member is required.
Category *DimensionField
// The ID for a computation.
//
// This member is required.
ComputationId *string
// The time field that is used in a computation.
//
// This member is required.
Time *DimensionField
// The computation type. Choose from the following options:
// - TOP: Top movers computation.
// - BOTTOM: Bottom movers computation.
//
// This member is required.
Type TopBottomComputationType
// The mover size setup of the top and bottom movers computation.
MoverSize int32
// The name of a computation.
Name *string
// The sort order setup of the top and bottom movers computation.
SortOrder TopBottomSortOrder
// The value field that is used in a computation.
Value *MeasureField
noSmithyDocumentSerde
}
// The top ranked and bottom ranked computation configuration.
type TopBottomRankedComputation struct {
// The category field that is used in a computation.
//
// This member is required.
Category *DimensionField
// The ID for a computation.
//
// This member is required.
ComputationId *string
// The computation type. Choose one of the following options:
// - TOP: A top ranked computation.
// - BOTTOM: A bottom ranked computation.
//
// This member is required.
Type TopBottomComputationType
// The name of a computation.
Name *string
// The result size of a top and bottom ranked computation.
ResultSize int32
// The value field that is used in a computation.
Value *MeasureField
noSmithyDocumentSerde
}
// A structure that represents a calculated field.
type TopicCalculatedField struct {
// The calculated field name.
//
// This member is required.
CalculatedFieldName *string
// The calculated field expression.
//
// This member is required.
Expression *string
// The default aggregation. Valid values for this structure are SUM , MAX , MIN ,
// COUNT , DISTINCT_COUNT , and AVERAGE .
Aggregation DefaultAggregation
// The list of aggregation types that are allowed for the calculated field. Valid
// values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM
// , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
AllowedAggregations []AuthorSpecifiedAggregation
// The calculated field description.
CalculatedFieldDescription *string
// The other names or aliases for the calculated field.
CalculatedFieldSynonyms []string
// The other names or aliases for the calculated field cell value.
CellValueSynonyms []CellValueSynonym
// The column data role for a calculated field. Valid values for this structure
// are DIMENSION and MEASURE .
ColumnDataRole ColumnDataRole
// The order in which data is displayed for the calculated field when it's used in
// a comparative context.
ComparativeOrder *ComparativeOrder
// The default formatting definition.
DefaultFormatting *DefaultFormatting
// A Boolean value that indicates if a calculated field is visible in the
// autocomplete.
DisableIndexing *bool
// A boolean value that indicates if a calculated field is included in the topic.
IsIncludedInTopic bool
// A Boolean value that indicates whether to never aggregate calculated field in
// filters.
NeverAggregateInFilter bool
// The list of aggregation types that are not allowed for the calculated field.
// Valid values for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN
// , SUM , AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
NotAllowedAggregations []AuthorSpecifiedAggregation
// The semantic type.
SemanticType *SemanticType
// The level of time precision that is used to aggregate DateTime values.
TimeGranularity TopicTimeGranularity
noSmithyDocumentSerde
}
// A structure that represents a category filter.
type TopicCategoryFilter struct {
// The category filter function. Valid values for this structure are EXACT and
// CONTAINS .
CategoryFilterFunction CategoryFilterFunction
// The category filter type. This element is used to specify whether a filter is a
// simple category filter or an inverse category filter.
CategoryFilterType CategoryFilterType
// The constant used in a category filter.
Constant *TopicCategoryFilterConstant
// A Boolean value that indicates if the filter is inverse.
Inverse bool
noSmithyDocumentSerde
}
// A constant used in a category filter.
type TopicCategoryFilterConstant struct {
// A collective constant used in a category filter. This element is used to
// specify a list of values for the constant.
CollectiveConstant *CollectiveConstant
// The type of category filter constant. This element is used to specify whether a
// constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE .
ConstantType ConstantType
// A singular constant used in a category filter. This element is used to specify
// a single value for the constant.
SingularConstant *string
noSmithyDocumentSerde
}
// Represents a column in a dataset.
type TopicColumn struct {
// The name of the column.
//
// This member is required.
ColumnName *string
// The type of aggregation that is performed on the column data when it's queried.
// Valid values for this structure are SUM , MAX , MIN , COUNT , DISTINCT_COUNT ,
// and AVERAGE .
Aggregation DefaultAggregation
// The list of aggregation types that are allowed for the column. Valid values for
// this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM , AVERAGE ,
// STDEV , STDEVP , VAR , VARP , and PERCENTILE .
AllowedAggregations []AuthorSpecifiedAggregation
// The other names or aliases for the column cell value.
CellValueSynonyms []CellValueSynonym
// The role of the column in the data. Valid values are DIMENSION and MEASURE .
ColumnDataRole ColumnDataRole
// A description of the column and its contents.
ColumnDescription *string
// A user-friendly name for the column.
ColumnFriendlyName *string
// The other names or aliases for the column.
ColumnSynonyms []string
// The order in which data is displayed for the column when it's used in a
// comparative context.
ComparativeOrder *ComparativeOrder
// The default formatting used for values in the column.
DefaultFormatting *DefaultFormatting
// A Boolean value that indicates whether the column shows in the autocomplete
// functionality.
DisableIndexing *bool
// A Boolean value that indicates whether the column is included in the query
// results.
IsIncludedInTopic bool
// A Boolean value that indicates whether to aggregate the column data when it's
// used in a filter context.
NeverAggregateInFilter bool
// The list of aggregation types that are not allowed for the column. Valid values
// for this structure are COUNT , DISTINCT_COUNT , MIN , MAX , MEDIAN , SUM ,
// AVERAGE , STDEV , STDEVP , VAR , VARP , and PERCENTILE .
NotAllowedAggregations []AuthorSpecifiedAggregation
// The semantic type of data contained in the column.
SemanticType *SemanticType
// The level of time precision that is used to aggregate DateTime values.
TimeGranularity TopicTimeGranularity
noSmithyDocumentSerde
}
// A filter used to restrict data based on a range of dates or times.
type TopicDateRangeFilter struct {
// The constant used in a date range filter.
Constant *TopicRangeFilterConstant
// A Boolean value that indicates whether the date range filter should include the
// boundary values. If set to true, the filter includes the start and end dates. If
// set to false, the filter excludes them.
Inclusive bool
noSmithyDocumentSerde
}
// A structure that describes the details of a topic, such as its name,
// description, and associated data sets.
type TopicDetails struct {
// The data sets that the topic is associated with.
DataSets []DatasetMetadata
// The description of the topic.
Description *string
// The name of the topic.
Name *string
noSmithyDocumentSerde
}
// A structure that represents a filter used to select items for a topic.
type TopicFilter struct {
// The name of the filter.
//
// This member is required.
FilterName *string
// The name of the field that the filter operates on.
//
// This member is required.
OperandFieldName *string
// The category filter that is associated with this filter.
CategoryFilter *TopicCategoryFilter
// The date range filter.
DateRangeFilter *TopicDateRangeFilter
// The class of the filter. Valid values for this structure are
// ENFORCED_VALUE_FILTER , CONDITIONAL_VALUE_FILTER , and NAMED_VALUE_FILTER .
FilterClass FilterClass
// A description of the filter used to select items for a topic.
FilterDescription *string
// The other names or aliases for the filter.
FilterSynonyms []string
// The type of the filter. Valid values for this structure are CATEGORY_FILTER ,
// NUMERIC_EQUALITY_FILTER , NUMERIC_RANGE_FILTER , DATE_RANGE_FILTER , and
// RELATIVE_DATE_FILTER .
FilterType NamedFilterType
// The numeric equality filter.
NumericEqualityFilter *TopicNumericEqualityFilter
// The numeric range filter.
NumericRangeFilter *TopicNumericRangeFilter
// The relative date filter.
RelativeDateFilter *TopicRelativeDateFilter
noSmithyDocumentSerde
}
// A structure that represents a named entity.
type TopicNamedEntity struct {
// The name of the named entity.
//
// This member is required.
EntityName *string
// The definition of a named entity.
Definition []NamedEntityDefinition
// The description of the named entity.
EntityDescription *string
// The other names or aliases for the named entity.
EntitySynonyms []string
// The type of named entity that a topic represents.
SemanticEntityType *SemanticEntityType
noSmithyDocumentSerde
}
// A filter that filters topics based on the value of a numeric field. The filter
// includes only topics whose numeric field value matches the specified value.
type TopicNumericEqualityFilter struct {
// An aggregation function that specifies how to calculate the value of a numeric
// field for a topic. Valid values for this structure are NO_AGGREGATION , SUM ,
// AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR ,
// and VARP .
Aggregation NamedFilterAggType
// The constant used in a numeric equality filter.
Constant *TopicSingularFilterConstant
noSmithyDocumentSerde
}
// A filter that filters topics based on the value of a numeric field. The filter
// includes only topics whose numeric field value falls within the specified range.
type TopicNumericRangeFilter struct {
// An aggregation function that specifies how to calculate the value of a numeric
// field for a topic, Valid values for this structure are NO_AGGREGATION , SUM ,
// AVERAGE , COUNT , DISTINCT_COUNT , MAX , MEDIAN , MIN , STDEV , STDEVP , VAR ,
// and VARP .
Aggregation NamedFilterAggType
// The constant used in a numeric range filter.
Constant *TopicRangeFilterConstant
// A Boolean value that indicates whether the endpoints of the numeric range are
// included in the filter. If set to true, topics whose numeric field value is
// equal to the endpoint values will be included in the filter. If set to false,
// topics whose numeric field value is equal to the endpoint values will be
// excluded from the filter.
Inclusive bool
noSmithyDocumentSerde
}
// A constant value that is used in a range filter to specify the endpoints of the
// range.
type TopicRangeFilterConstant struct {
// The data type of the constant value that is used in a range filter. Valid
// values for this structure are RANGE .
ConstantType ConstantType
// The value of the constant that is used to specify the endpoints of a range
// filter.
RangeConstant *RangeConstant
noSmithyDocumentSerde
}
// The details about the refresh of a topic.
type TopicRefreshDetails struct {
// The Amazon Resource Name (ARN) of the topic refresh.
RefreshArn *string
// The ID of the refresh, which occurs as a result of topic creation or topic
// update.
RefreshId *string
// The status of the refresh job that indicates whether the job is still running,
// completed successfully, or failed.
RefreshStatus TopicRefreshStatus
noSmithyDocumentSerde
}
// A structure that represents a topic refresh schedule.
type TopicRefreshSchedule struct {
// A Boolean value that controls whether to schedule runs at the same schedule
// that is specified in SPICE dataset.
//
// This member is required.
BasedOnSpiceSchedule bool
// A Boolean value that controls whether to schedule is enabled.
//
// This member is required.
IsEnabled *bool
// The time of day when the refresh should run, for example, Monday-Sunday.
RepeatAt *string
// The starting date and time for the refresh schedule.
StartingAt *time.Time
// The timezone that you want the refresh schedule to use.
Timezone *string
// The type of refresh schedule. Valid values for this structure are HOURLY , DAILY
// , WEEKLY , and MONTHLY .
TopicScheduleType TopicScheduleType
noSmithyDocumentSerde
}
// A summary of the refresh schedule details for a dataset.
type TopicRefreshScheduleSummary struct {
// The Amazon Resource Name (ARN) of the dataset.
DatasetArn *string
// The ID of the dataset.
DatasetId *string
// The name of the dataset.
DatasetName *string
// The definition of a refresh schedule.
RefreshSchedule *TopicRefreshSchedule
noSmithyDocumentSerde
}
// A structure that represents a relative date filter.
type TopicRelativeDateFilter struct {
// The constant used in a relative date filter.
Constant *TopicSingularFilterConstant
// The function to be used in a relative date filter to determine the range of
// dates to include in the results. Valid values for this structure are BEFORE ,
// AFTER , and BETWEEN .
RelativeDateFilterFunction TopicRelativeDateFilterFunction
// The level of time precision that is used to aggregate DateTime values.
TimeGranularity TopicTimeGranularity
noSmithyDocumentSerde
}
// A structure that represents a singular filter constant, used in filters to
// specify a single value to match against.
type TopicSingularFilterConstant struct {
// The type of the singular filter constant. Valid values for this structure are
// SINGULAR .
ConstantType ConstantType
// The value of the singular filter constant.
SingularConstant *string
noSmithyDocumentSerde
}
// A topic summary.
type TopicSummary struct {
// The Amazon Resource Name (ARN) of the topic.
Arn *string
// The name of the topic.
Name *string
// The ID for the topic. This ID is unique per Amazon Web Services Region for each
// Amazon Web Services account.
TopicId *string
noSmithyDocumentSerde
}
// The total aggregation computation configuration.
type TotalAggregationComputation struct {
// The ID for a computation.
//
// This member is required.
ComputationId *string
// The value field that is used in a computation.
//
// This member is required.
Value *MeasureField
// The name of a computation.
Name *string
noSmithyDocumentSerde
}
// The total options for a table visual.
type TotalOptions struct {
// The custom label string for the total cells.
CustomLabel *string
// The placement (start, end) for the total cells.
Placement TableTotalsPlacement
// The scroll status (pinned, scrolled) for the total cells.
ScrollStatus TableTotalsScrollStatus
// Cell styling options for the total cells.
TotalCellStyle *TableCellStyle
// The visibility configuration for the total cells.
TotalsVisibility Visibility
noSmithyDocumentSerde
}
// A data transformation on a logical table. This is a variant type structure. For
// this structure to be valid, only one of the attributes can be non-null.
//
// The following types satisfy this interface:
//
// TransformOperationMemberCastColumnTypeOperation
// TransformOperationMemberCreateColumnsOperation
// TransformOperationMemberFilterOperation
// TransformOperationMemberOverrideDatasetParameterOperation
// TransformOperationMemberProjectOperation
// TransformOperationMemberRenameColumnOperation
// TransformOperationMemberTagColumnOperation
// TransformOperationMemberUntagColumnOperation
type TransformOperation interface {
isTransformOperation()
}
// A transform operation that casts a column to a different type.
type TransformOperationMemberCastColumnTypeOperation struct {
Value CastColumnTypeOperation
noSmithyDocumentSerde
}
func (*TransformOperationMemberCastColumnTypeOperation) isTransformOperation() {}
// An operation that creates calculated columns. Columns created in one such
// operation form a lexical closure.
type TransformOperationMemberCreateColumnsOperation struct {
Value CreateColumnsOperation
noSmithyDocumentSerde
}
func (*TransformOperationMemberCreateColumnsOperation) isTransformOperation() {}
// An operation that filters rows based on some condition.
type TransformOperationMemberFilterOperation struct {
Value FilterOperation
noSmithyDocumentSerde
}
func (*TransformOperationMemberFilterOperation) isTransformOperation() {}
// A transform operation that overrides the dataset parameter values that are
// defined in another dataset.
type TransformOperationMemberOverrideDatasetParameterOperation struct {
Value OverrideDatasetParameterOperation
noSmithyDocumentSerde
}
func (*TransformOperationMemberOverrideDatasetParameterOperation) isTransformOperation() {}
// An operation that projects columns. Operations that come after a projection can
// only refer to projected columns.
type TransformOperationMemberProjectOperation struct {
Value ProjectOperation
noSmithyDocumentSerde
}
func (*TransformOperationMemberProjectOperation) isTransformOperation() {}
// An operation that renames a column.
type TransformOperationMemberRenameColumnOperation struct {
Value RenameColumnOperation
noSmithyDocumentSerde
}
func (*TransformOperationMemberRenameColumnOperation) isTransformOperation() {}
// An operation that tags a column with additional information.
type TransformOperationMemberTagColumnOperation struct {
Value TagColumnOperation
noSmithyDocumentSerde
}
func (*TransformOperationMemberTagColumnOperation) isTransformOperation() {}
// A transform operation that removes tags associated with a column.
type TransformOperationMemberUntagColumnOperation struct {
Value UntagColumnOperation
noSmithyDocumentSerde
}
func (*TransformOperationMemberUntagColumnOperation) isTransformOperation() {}
// Aggregated field wells of a tree map.
type TreeMapAggregatedFieldWells struct {
// The color field well of a tree map. Values are grouped by aggregations based on
// group by fields.
Colors []MeasureField
// The group by field well of a tree map. Values are grouped based on group by
// fields.
Groups []DimensionField
// The size field well of a tree map. Values are aggregated based on group by
// fields.
Sizes []MeasureField
noSmithyDocumentSerde
}
// The configuration of a tree map.
type TreeMapConfiguration struct {
// The label options (label text, label visibility) for the colors displayed in a
// tree map.
ColorLabelOptions *ChartAxisLabelOptions
// The color options (gradient color, point of divergence) of a tree map.
ColorScale *ColorScale
// The options that determine if visual data labels are displayed.
DataLabels *DataLabelOptions
// The field wells of the visual.
FieldWells *TreeMapFieldWells
// The label options (label text, label visibility) of the groups that are
// displayed in a tree map.
GroupLabelOptions *ChartAxisLabelOptions
// The legend display setup of the visual.
Legend *LegendOptions
// The label options (label text, label visibility) of the sizes that are
// displayed in a tree map.
SizeLabelOptions *ChartAxisLabelOptions
// The sort configuration of a tree map.
SortConfiguration *TreeMapSortConfiguration
// The tooltip display setup of the visual.
Tooltip *TooltipOptions
noSmithyDocumentSerde
}
// The field wells of a tree map. This is a union type structure. For this
// structure to be valid, only one of the attributes can be defined.
type TreeMapFieldWells struct {
// The aggregated field wells of a tree map.
TreeMapAggregatedFieldWells *TreeMapAggregatedFieldWells
noSmithyDocumentSerde
}
// The sort configuration of a tree map.
type TreeMapSortConfiguration struct {
// The limit on the number of groups that are displayed.
TreeMapGroupItemsLimitConfiguration *ItemsLimitConfiguration
// The sort configuration of group by fields.
TreeMapSort []FieldSortOptions
noSmithyDocumentSerde
}
// A tree map. For more information, see Using tree maps (https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html)
// in the Amazon QuickSight User Guide.
type TreeMapVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers..
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration settings of the visual.
ChartConfiguration *TreeMapConfiguration
// The column hierarchy that is used during drill-downs and drill-ups.
ColumnHierarchies []ColumnHierarchy
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// The options that determine the presentation of trend arrows in a KPI visual.
type TrendArrowOptions struct {
// The visibility of the trend arrows.
Visibility Visibility
noSmithyDocumentSerde
}
// The parameters for Twitter.
type TwitterParameters struct {
// Maximum number of rows to query Twitter.
//
// This member is required.
MaxRows int32
// Twitter query string.
//
// This member is required.
Query *string
noSmithyDocumentSerde
}
// Determines the typography options.
type Typography struct {
// Determines the list of font families.
FontFamilies []Font
noSmithyDocumentSerde
}
// The theme colors that apply to UI and to charts, excluding data colors. The
// colors description is a hexadecimal color code that consists of six
// alphanumerical characters, prefixed with # , for example #37BFF5. 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.
type UIColorPalette struct {
// This color is that applies to selected states and buttons.
Accent *string
// The foreground color that applies to any text or other elements that appear
// over the accent color.
AccentForeground *string
// The color that applies to error messages.
Danger *string
// The foreground color that applies to any text or other elements that appear
// over the error color.
DangerForeground *string
// The color that applies to the names of fields that are identified as dimensions.
Dimension *string
// The foreground color that applies to any text or other elements that appear
// over the dimension color.
DimensionForeground *string
// The color that applies to the names of fields that are identified as measures.
Measure *string
// The foreground color that applies to any text or other elements that appear
// over the measure color.
MeasureForeground *string
// The background color that applies to visuals and other high emphasis UI.
PrimaryBackground *string
// The color of text and other foreground elements that appear over the primary
// background regions, such as grid lines, borders, table banding, icons, and so
// on.
PrimaryForeground *string
// The background color that applies to the sheet background and sheet controls.
SecondaryBackground *string
// The foreground color that applies to any sheet title, sheet control text, or UI
// that appears over the secondary background.
SecondaryForeground *string
// The color that applies to success messages, for example the check mark for a
// successful download.
Success *string
// The foreground color that applies to any text or other elements that appear
// over the success color.
SuccessForeground *string
// This color that applies to warning and informational messages.
Warning *string
// The foreground color that applies to any text or other elements that appear
// over the warning color.
WarningForeground *string
noSmithyDocumentSerde
}
// The unaggregated field for a table.
type UnaggregatedField struct {
// The column that is used in the UnaggregatedField .
//
// This member is required.
Column *ColumnIdentifier
// The custom field ID.
//
// This member is required.
FieldId *string
// The format configuration of the field.
FormatConfiguration *FormatConfiguration
noSmithyDocumentSerde
}
// The unique values computation configuration.
type UniqueValuesComputation struct {
// The category field that is used in a computation.
//
// This member is required.
Category *DimensionField
// The ID for a computation.
//
// This member is required.
ComputationId *string
// The name of a computation.
Name *string
noSmithyDocumentSerde
}
// A transform operation that removes tags associated with a column.
type UntagColumnOperation struct {
// The column that this operation acts on.
//
// This member is required.
ColumnName *string
// The column tags to remove from this column.
//
// This member is required.
TagNames []ColumnTagName
noSmithyDocumentSerde
}
// Information about the format for a source file or files.
type UploadSettings struct {
// Whether the file has a header row, or the files each have a header row.
ContainsHeader *bool
// The delimiter between values in the file.
Delimiter *string
// File format.
Format FileFormat
// A row number to start reading data from.
StartFromRow *int32
// Text qualifier.
TextQualifier TextQualifier
noSmithyDocumentSerde
}
// A registered user of Amazon QuickSight.
type User struct {
// The active status of user. When you create an Amazon QuickSight user that's not
// an IAM user or an Active Directory user, that user is inactive until they sign
// in and provide a password.
Active bool
// The Amazon Resource Name (ARN) for the user.
Arn *string
// The custom permissions profile associated with this user.
CustomPermissionsName *string
// The user's email address.
Email *string
// The type of supported external login provider that provides identity to let the
// user federate into Amazon QuickSight with an associated IAM role. The type can
// be one of the following.
// - COGNITO : Amazon Cognito. The provider URL is
// cognito-identity.amazonaws.com.
// - CUSTOM_OIDC : Custom OpenID Connect (OIDC) provider.
ExternalLoginFederationProviderType *string
// The URL of the external login provider.
ExternalLoginFederationProviderUrl *string
// The identity ID for the user in the external login provider.
ExternalLoginId *string
// The type of identity authentication used by the user.
IdentityType IdentityType
// The principal ID of the user.
PrincipalId *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 Amazon
// QuickSight settings.
// - RESTRICTED_READER : This role isn't currently available for use.
// - RESTRICTED_AUTHOR : This role isn't currently available for use.
Role UserRole
// The user's user name. This value is required if you are registering a user that
// will be managed in Amazon QuickSight. In the output, the value for UserName is
// N/A when the value for IdentityType is IAM and the corresponding IAM user is
// deleted.
UserName *string
noSmithyDocumentSerde
}
// The range options for the data zoom scroll bar.
type VisibleRangeOptions struct {
// The percent range in the visible range.
PercentRange *PercentVisibleRange
noSmithyDocumentSerde
}
// A visual displayed on a sheet in an analysis, dashboard, or template. This is a
// union type structure. For this structure to be valid, only one of the attributes
// can be defined.
type Visual struct {
// A bar chart. For more information, see Using bar charts (https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html)
// in the Amazon QuickSight User Guide.
BarChartVisual *BarChartVisual
// A box plot. For more information, see Using box plots (https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html)
// in the Amazon QuickSight User Guide.
BoxPlotVisual *BoxPlotVisual
// A combo chart. For more information, see Using combo charts (https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html)
// in the Amazon QuickSight User Guide.
ComboChartVisual *ComboChartVisual
// A visual that contains custom content. For more information, see Using custom
// visual content (https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html)
// in the Amazon QuickSight User Guide.
CustomContentVisual *CustomContentVisual
// An empty visual.
EmptyVisual *EmptyVisual
// A filled map. For more information, see Creating filled maps (https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html)
// in the Amazon QuickSight User Guide.
FilledMapVisual *FilledMapVisual
// A funnel chart. For more information, see Using funnel charts (https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html)
// in the Amazon QuickSight User Guide.
FunnelChartVisual *FunnelChartVisual
// A gauge chart. For more information, see Using gauge charts (https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html)
// in the Amazon QuickSight User Guide.
GaugeChartVisual *GaugeChartVisual
// A geospatial map or a points on map visual. For more information, see Creating
// point maps (https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html)
// in the Amazon QuickSight User Guide.
GeospatialMapVisual *GeospatialMapVisual
// A heat map. For more information, see Using heat maps (https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html)
// in the Amazon QuickSight User Guide.
HeatMapVisual *HeatMapVisual
// A histogram. For more information, see Using histograms (https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html)
// in the Amazon QuickSight User Guide.
HistogramVisual *HistogramVisual
// An insight visual. For more information, see Working with insights (https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html)
// in the Amazon QuickSight User Guide.
InsightVisual *InsightVisual
// A key performance indicator (KPI). For more information, see Using KPIs (https://docs.aws.amazon.com/quicksight/latest/user/kpi.html)
// in the Amazon QuickSight User Guide.
KPIVisual *KPIVisual
// A line chart. For more information, see Using line charts (https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html)
// in the Amazon QuickSight User Guide.
LineChartVisual *LineChartVisual
// A pie or donut chart. For more information, see Using pie charts (https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html)
// in the Amazon QuickSight User Guide.
PieChartVisual *PieChartVisual
// A pivot table. For more information, see Using pivot tables (https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html)
// in the Amazon QuickSight User Guide.
PivotTableVisual *PivotTableVisual
// A radar chart visual. For more information, see Using radar charts (https://docs.aws.amazon.com/quicksight/latest/user/radar-chart.html)
// in the Amazon QuickSight User Guide.
RadarChartVisual *RadarChartVisual
// A sankey diagram. For more information, see Using Sankey diagrams (https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html)
// in the Amazon QuickSight User Guide.
SankeyDiagramVisual *SankeyDiagramVisual
// A scatter plot. For more information, see Using scatter plots (https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html)
// in the Amazon QuickSight User Guide.
ScatterPlotVisual *ScatterPlotVisual
// A table visual. For more information, see Using tables as visuals (https://docs.aws.amazon.com/quicksight/latest/user/tabular.html)
// in the Amazon QuickSight User Guide.
TableVisual *TableVisual
// A tree map. For more information, see Using tree maps (https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html)
// in the Amazon QuickSight User Guide.
TreeMapVisual *TreeMapVisual
// A waterfall chart. For more information, see Using waterfall charts (https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html)
// in the Amazon QuickSight User Guide.
WaterfallVisual *WaterfallVisual
// A word cloud. For more information, see Using word clouds (https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html)
// in the Amazon QuickSight User Guide.
WordCloudVisual *WordCloudVisual
noSmithyDocumentSerde
}
// The axis sort options for a visual.
type VisualAxisSortOption struct {
// The availaiblity status of a visual's axis sort options.
AvailabilityStatus DashboardBehavior
noSmithyDocumentSerde
}
// A custom action defined on a visual.
type VisualCustomAction struct {
// A list of VisualCustomActionOperations . This is a union type structure. For
// this structure to be valid, only one of the attributes can be defined.
//
// This member is required.
ActionOperations []VisualCustomActionOperation
// The ID of the VisualCustomAction .
//
// This member is required.
CustomActionId *string
// The name of the VisualCustomAction .
//
// This member is required.
Name *string
// The trigger of the VisualCustomAction . Valid values are defined as follows:
// - DATA_POINT_CLICK : Initiates a custom action by a left pointer click on a
// data point.
// - DATA_POINT_MENU : Initiates a custom action by right pointer click from the
// menu.
//
// This member is required.
Trigger VisualCustomActionTrigger
// The status of the VisualCustomAction .
Status WidgetStatus
noSmithyDocumentSerde
}
// The operation that is defined by the custom action. This is a union type
// structure. For this structure to be valid, only one of the attributes can be
// defined.
type VisualCustomActionOperation struct {
// The filter operation that filters data included in a visual or in an entire
// sheet.
FilterOperation *CustomActionFilterOperation
// The navigation operation that navigates between different sheets in the same
// analysis.
NavigationOperation *CustomActionNavigationOperation
// The set parameter operation that sets parameters in custom action.
SetParametersOperation *CustomActionSetParametersOperation
// The URL operation that opens a link to another webpage.
URLOperation *CustomActionURLOperation
noSmithyDocumentSerde
}
// The menu options for a visual.
type VisualMenuOption struct {
// The availaiblity status of a visual's menu options.
AvailabilityStatus DashboardBehavior
noSmithyDocumentSerde
}
// The visual display options for the visual palette.
type VisualPalette struct {
// The chart color options for the visual palette.
ChartColor *string
// The color map options for the visual palette.
ColorMap []DataPathColor
noSmithyDocumentSerde
}
// The subtitle label options for a visual.
type VisualSubtitleLabelOptions struct {
// The long text format of the subtitle label, such as plain text or rich text.
FormatText *LongFormatText
// The visibility of the subtitle label.
Visibility Visibility
noSmithyDocumentSerde
}
// The title label options for a visual.
type VisualTitleLabelOptions struct {
// The short text format of the title label, such as plain text or rich text.
FormatText *ShortFormatText
// The visibility of the title label.
Visibility Visibility
noSmithyDocumentSerde
}
// The structure of a VPC connection.
type VPCConnection struct {
// The Amazon Resource Name (ARN) of the VPC connection.
Arn *string
// The availability status of the VPC connection.
AvailabilityStatus VPCConnectionAvailabilityStatus
// The time that the VPC connection was created.
CreatedTime *time.Time
// A list of IP addresses of DNS resolver endpoints for the VPC connection.
DnsResolvers []string
// The time that the VPC connection was last updated.
LastUpdatedTime *time.Time
// The display name for the VPC connection.
Name *string
// A list of network interfaces.
NetworkInterfaces []NetworkInterface
// The ARN of the IAM role associated with the VPC connection.
RoleArn *string
// The Amazon EC2 security group IDs associated with the VPC connection.
SecurityGroupIds []string
// The status of the VPC connection.
Status VPCConnectionResourceStatus
// The ID of the VPC connection that you're creating. This ID is a unique
// identifier for each Amazon Web Services Region in an Amazon Web Services
// account.
VPCConnectionId *string
// The Amazon EC2 VPC ID associated with the VPC connection.
VPCId *string
noSmithyDocumentSerde
}
// VPC connection properties.
type VpcConnectionProperties struct {
// The Amazon Resource Name (ARN) for the VPC connection.
//
// This member is required.
VpcConnectionArn *string
noSmithyDocumentSerde
}
// The summary metadata that describes a VPC connection.
type VPCConnectionSummary struct {
// The Amazon Resource Name (ARN) of the VPC connection.
Arn *string
// The availability status of the VPC connection.
AvailabilityStatus VPCConnectionAvailabilityStatus
// The time that the VPC connection was created.
CreatedTime *time.Time
// A list of IP addresses of DNS resolver endpoints for the VPC connection.
DnsResolvers []string
// The time that the VPC connection was last updated.
LastUpdatedTime *time.Time
// The display name for the VPC connection.
Name *string
// A list of network interfaces.
NetworkInterfaces []NetworkInterface
// The ARN of the IAM role associated with the VPC connection.
RoleArn *string
// The Amazon EC2 security group IDs associated with the VPC connection.
SecurityGroupIds []string
// The status of the VPC connection.
Status VPCConnectionResourceStatus
// The ID of the VPC connection that you're creating. This ID is a unique
// identifier for each Amazon Web Services Region in an Amazon Web Services
// account.
VPCConnectionId *string
// The Amazon EC2 VPC ID associated with the VPC connection.
VPCId *string
noSmithyDocumentSerde
}
// The field well configuration of a waterfall visual.
type WaterfallChartAggregatedFieldWells struct {
// The breakdown field wells of a waterfall visual.
Breakdowns []DimensionField
// The category field wells of a waterfall visual.
Categories []DimensionField
// The value field wells of a waterfall visual.
Values []MeasureField
noSmithyDocumentSerde
}
// The configuration for a waterfall visual.
type WaterfallChartConfiguration struct {
// The options that determine the presentation of the category axis.
CategoryAxisDisplayOptions *AxisDisplayOptions
// The options that determine the presentation of the category axis label.
CategoryAxisLabelOptions *ChartAxisLabelOptions
// The data label configuration of a waterfall visual.
DataLabels *DataLabelOptions
// The field well configuration of a waterfall visual.
FieldWells *WaterfallChartFieldWells
// The legend configuration of a waterfall visual.
Legend *LegendOptions
// The options that determine the presentation of the y-axis.
PrimaryYAxisDisplayOptions *AxisDisplayOptions
// The options that determine the presentation of the y-axis label.
PrimaryYAxisLabelOptions *ChartAxisLabelOptions
// The sort configuration of a waterfall visual.
SortConfiguration *WaterfallChartSortConfiguration
// The visual palette configuration of a waterfall visual.
VisualPalette *VisualPalette
// The options that determine the presentation of a waterfall visual.
WaterfallChartOptions *WaterfallChartOptions
noSmithyDocumentSerde
}
// The field well configuration of a waterfall visual.
type WaterfallChartFieldWells struct {
// The field well configuration of a waterfall visual.
WaterfallChartAggregatedFieldWells *WaterfallChartAggregatedFieldWells
noSmithyDocumentSerde
}
// The options that determine the presentation of a waterfall visual.
type WaterfallChartOptions struct {
// This option determines the total bar label of a waterfall visual.
TotalBarLabel *string
noSmithyDocumentSerde
}
// The sort configuration of a waterfall visual.
type WaterfallChartSortConfiguration struct {
// The limit on the number of bar groups that are displayed.
BreakdownItemsLimit *ItemsLimitConfiguration
// The sort configuration of the category fields.
CategorySort []FieldSortOptions
noSmithyDocumentSerde
}
// A waterfall chart. For more information, see Using waterfall charts (https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html)
// in the Amazon QuickSight User Guide.
type WaterfallVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers.
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration for a waterfall visual.
ChartConfiguration *WaterfallChartConfiguration
// The column hierarchy that is used during drill-downs and drill-ups.
ColumnHierarchies []ColumnHierarchy
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
// Provides the forecast to meet the target for a particular date.
type WhatIfPointScenario struct {
// The date that you need the forecast results for.
//
// This member is required.
Date *time.Time
// The target value that you want to meet for the provided date.
//
// This member is required.
Value float64
noSmithyDocumentSerde
}
// Provides the forecast to meet the target for a particular date range.
type WhatIfRangeScenario struct {
// The end date in the date range that you need the forecast results for.
//
// This member is required.
EndDate *time.Time
// The start date in the date range that you need the forecast results for.
//
// This member is required.
StartDate *time.Time
// The target value that you want to meet for the provided date range.
//
// This member is required.
Value float64
noSmithyDocumentSerde
}
// The aggregated field wells of a word cloud.
type WordCloudAggregatedFieldWells struct {
// The group by field well of a word cloud. Values are grouped by group by fields.
GroupBy []DimensionField
// The size field well of a word cloud. Values are aggregated based on group by
// fields.
Size []MeasureField
noSmithyDocumentSerde
}
// The configuration of a word cloud visual.
type WordCloudChartConfiguration struct {
// The label options (label text, label visibility, and sort icon visibility) for
// the word cloud category.
CategoryLabelOptions *ChartAxisLabelOptions
// The field wells of the visual.
FieldWells *WordCloudFieldWells
// The sort configuration of a word cloud visual.
SortConfiguration *WordCloudSortConfiguration
// The options for a word cloud visual.
WordCloudOptions *WordCloudOptions
noSmithyDocumentSerde
}
// The field wells of a word cloud visual. This is a union type structure. For
// this structure to be valid, only one of the attributes can be defined.
type WordCloudFieldWells struct {
// The aggregated field wells of a word cloud.
WordCloudAggregatedFieldWells *WordCloudAggregatedFieldWells
noSmithyDocumentSerde
}
// The word cloud options for a word cloud visual.
type WordCloudOptions struct {
// The cloud layout options (fluid, normal) of a word cloud.
CloudLayout WordCloudCloudLayout
// The length limit of each word from 1-100.
MaximumStringLength *int32
// The word casing options (lower_case, existing_case) for the words in a word
// cloud.
WordCasing WordCloudWordCasing
// The word orientation options (horizontal, horizontal_and_vertical) for the
// words in a word cloud.
WordOrientation WordCloudWordOrientation
// The word padding options (none, small, medium, large) for the words in a word
// cloud.
WordPadding WordCloudWordPadding
// The word scaling options (emphasize, normal) for the words in a word cloud.
WordScaling WordCloudWordScaling
noSmithyDocumentSerde
}
// The sort configuration of a word cloud visual.
type WordCloudSortConfiguration struct {
// The limit on the number of groups that are displayed in a word cloud.
CategoryItemsLimit *ItemsLimitConfiguration
// The sort configuration of group by fields.
CategorySort []FieldSortOptions
noSmithyDocumentSerde
}
// A word cloud. For more information, see Using word clouds (https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html)
// in the Amazon QuickSight User Guide.
type WordCloudVisual struct {
// The unique identifier of a visual. This identifier must be unique within the
// context of a dashboard, template, or analysis. Two dashboards, analyses, or
// templates can have visuals with the same identifiers..
//
// This member is required.
VisualId *string
// The list of custom actions that are configured for a visual.
Actions []VisualCustomAction
// The configuration settings of the visual.
ChartConfiguration *WordCloudChartConfiguration
// The column hierarchy that is used during drill-downs and drill-ups.
ColumnHierarchies []ColumnHierarchy
// The subtitle that is displayed on the visual.
Subtitle *VisualSubtitleLabelOptions
// The title that is displayed on the visual.
Title *VisualTitleLabelOptions
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
// UnknownUnionMember is returned when a union member is returned over the wire,
// but has an unknown tag.
type UnknownUnionMember struct {
Tag string
Value []byte
noSmithyDocumentSerde
}
func (*UnknownUnionMember) isDataSourceParameters() {}
func (*UnknownUnionMember) isPhysicalTable() {}
func (*UnknownUnionMember) isTransformOperation() {}
| 13,673 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package types_test
import (
"fmt"
"github.com/aws/aws-sdk-go-v2/service/quicksight/types"
)
func ExampleDataSourceParameters_outputUsage() {
var union types.DataSourceParameters
// type switches can be used to check the union value
switch v := union.(type) {
case *types.DataSourceParametersMemberAmazonElasticsearchParameters:
_ = v.Value // Value is types.AmazonElasticsearchParameters
case *types.DataSourceParametersMemberAmazonOpenSearchParameters:
_ = v.Value // Value is types.AmazonOpenSearchParameters
case *types.DataSourceParametersMemberAthenaParameters:
_ = v.Value // Value is types.AthenaParameters
case *types.DataSourceParametersMemberAuroraParameters:
_ = v.Value // Value is types.AuroraParameters
case *types.DataSourceParametersMemberAuroraPostgreSqlParameters:
_ = v.Value // Value is types.AuroraPostgreSqlParameters
case *types.DataSourceParametersMemberAwsIotAnalyticsParameters:
_ = v.Value // Value is types.AwsIotAnalyticsParameters
case *types.DataSourceParametersMemberDatabricksParameters:
_ = v.Value // Value is types.DatabricksParameters
case *types.DataSourceParametersMemberExasolParameters:
_ = v.Value // Value is types.ExasolParameters
case *types.DataSourceParametersMemberJiraParameters:
_ = v.Value // Value is types.JiraParameters
case *types.DataSourceParametersMemberMariaDbParameters:
_ = v.Value // Value is types.MariaDbParameters
case *types.DataSourceParametersMemberMySqlParameters:
_ = v.Value // Value is types.MySqlParameters
case *types.DataSourceParametersMemberOracleParameters:
_ = v.Value // Value is types.OracleParameters
case *types.DataSourceParametersMemberPostgreSqlParameters:
_ = v.Value // Value is types.PostgreSqlParameters
case *types.DataSourceParametersMemberPrestoParameters:
_ = v.Value // Value is types.PrestoParameters
case *types.DataSourceParametersMemberRdsParameters:
_ = v.Value // Value is types.RdsParameters
case *types.DataSourceParametersMemberRedshiftParameters:
_ = v.Value // Value is types.RedshiftParameters
case *types.DataSourceParametersMemberS3Parameters:
_ = v.Value // Value is types.S3Parameters
case *types.DataSourceParametersMemberServiceNowParameters:
_ = v.Value // Value is types.ServiceNowParameters
case *types.DataSourceParametersMemberSnowflakeParameters:
_ = v.Value // Value is types.SnowflakeParameters
case *types.DataSourceParametersMemberSparkParameters:
_ = v.Value // Value is types.SparkParameters
case *types.DataSourceParametersMemberSqlServerParameters:
_ = v.Value // Value is types.SqlServerParameters
case *types.DataSourceParametersMemberTeradataParameters:
_ = v.Value // Value is types.TeradataParameters
case *types.DataSourceParametersMemberTwitterParameters:
_ = v.Value // Value is types.TwitterParameters
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
var _ *types.AmazonElasticsearchParameters
var _ *types.MariaDbParameters
var _ *types.RdsParameters
var _ *types.AmazonOpenSearchParameters
var _ *types.RedshiftParameters
var _ *types.DatabricksParameters
var _ *types.OracleParameters
var _ *types.JiraParameters
var _ *types.TeradataParameters
var _ *types.MySqlParameters
var _ *types.ExasolParameters
var _ *types.SnowflakeParameters
var _ *types.SqlServerParameters
var _ *types.PostgreSqlParameters
var _ *types.ServiceNowParameters
var _ *types.PrestoParameters
var _ *types.AuroraParameters
var _ *types.S3Parameters
var _ *types.TwitterParameters
var _ *types.AuroraPostgreSqlParameters
var _ *types.AwsIotAnalyticsParameters
var _ *types.AthenaParameters
var _ *types.SparkParameters
func ExamplePhysicalTable_outputUsage() {
var union types.PhysicalTable
// type switches can be used to check the union value
switch v := union.(type) {
case *types.PhysicalTableMemberCustomSql:
_ = v.Value // Value is types.CustomSql
case *types.PhysicalTableMemberRelationalTable:
_ = v.Value // Value is types.RelationalTable
case *types.PhysicalTableMemberS3Source:
_ = v.Value // Value is types.S3Source
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
var _ *types.S3Source
var _ *types.CustomSql
var _ *types.RelationalTable
func ExampleTransformOperation_outputUsage() {
var union types.TransformOperation
// type switches can be used to check the union value
switch v := union.(type) {
case *types.TransformOperationMemberCastColumnTypeOperation:
_ = v.Value // Value is types.CastColumnTypeOperation
case *types.TransformOperationMemberCreateColumnsOperation:
_ = v.Value // Value is types.CreateColumnsOperation
case *types.TransformOperationMemberFilterOperation:
_ = v.Value // Value is types.FilterOperation
case *types.TransformOperationMemberOverrideDatasetParameterOperation:
_ = v.Value // Value is types.OverrideDatasetParameterOperation
case *types.TransformOperationMemberProjectOperation:
_ = v.Value // Value is types.ProjectOperation
case *types.TransformOperationMemberRenameColumnOperation:
_ = v.Value // Value is types.RenameColumnOperation
case *types.TransformOperationMemberTagColumnOperation:
_ = v.Value // Value is types.TagColumnOperation
case *types.TransformOperationMemberUntagColumnOperation:
_ = v.Value // Value is types.UntagColumnOperation
case *types.UnknownUnionMember:
fmt.Println("unknown tag:", v.Tag)
default:
fmt.Println("union is nil or unknown type")
}
}
var _ *types.OverrideDatasetParameterOperation
var _ *types.CreateColumnsOperation
var _ *types.FilterOperation
var _ *types.ProjectOperation
var _ *types.CastColumnTypeOperation
var _ *types.TagColumnOperation
var _ *types.RenameColumnOperation
var _ *types.UntagColumnOperation
| 187 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/aws/defaults"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/retry"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
awshttp "github.com/aws/aws-sdk-go-v2/aws/transport/http"
internalConfig "github.com/aws/aws-sdk-go-v2/internal/configsources"
smithy "github.com/aws/smithy-go"
smithydocument "github.com/aws/smithy-go/document"
"github.com/aws/smithy-go/logging"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"net"
"net/http"
"time"
)
const ServiceID = "RAM"
const ServiceAPIVersion = "2018-01-04"
// Client provides the API client to make operations call for AWS Resource Access
// Manager.
type Client struct {
options Options
}
// 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 New(options Options, optFns ...func(*Options)) *Client {
options = options.Copy()
resolveDefaultLogger(&options)
setResolvedDefaultsMode(&options)
resolveRetryer(&options)
resolveHTTPClient(&options)
resolveHTTPSignerV4(&options)
resolveDefaultEndpointConfiguration(&options)
for _, fn := range optFns {
fn(&options)
}
client := &Client{
options: options,
}
return client
}
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
// Configures the events that will be sent to the configured logger.
ClientLogMode aws.ClientLogMode
// The credentials object to use when signing requests.
Credentials aws.CredentialsProvider
// The configuration DefaultsMode that the SDK should use when constructing the
// clients initial default settings.
DefaultsMode aws.DefaultsMode
// The endpoint options to be used when attempting to resolve an endpoint.
EndpointOptions EndpointResolverOptions
// The service endpoint resolver.
EndpointResolver EndpointResolver
// Signature Version 4 (SigV4) Signer
HTTPSignerV4 HTTPSignerV4
// The logger writer interface to write logging messages to.
Logger logging.Logger
// The region to send requests to. (Required)
Region string
// RetryMaxAttempts specifies the maximum number attempts an API client will call
// an operation that fails with a retryable error. A value of 0 is ignored, and
// will not be used to configure the API client created default retryer, or modify
// per operation call's retry max attempts. When creating a new API Clients this
// member will only be used if the Retryer Options member is nil. This value will
// be ignored if Retryer is not nil. If specified in an operation call's functional
// options with a value that is different than the constructed client's Options,
// the Client's Retryer will be wrapped to use the operation's specific
// RetryMaxAttempts value.
RetryMaxAttempts int
// RetryMode specifies the retry mode the API client will be created with, if
// Retryer option is not also specified. When creating a new API Clients this
// member will only be used if the Retryer Options member is nil. This value will
// be ignored if Retryer is not nil. Currently does not support per operation call
// overrides, may in the future.
RetryMode aws.RetryMode
// Retryer guides how HTTP requests should be retried in case of recoverable
// failures. When nil the API client will use a default retryer. The kind of
// default retry created by the API client can be changed with the RetryMode
// option.
Retryer aws.Retryer
// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
// should not populate this structure programmatically, or rely on the values here
// within your applications.
RuntimeEnvironment aws.RuntimeEnvironment
// The initial DefaultsMode used when the client options were constructed. If the
// DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved
// value was at that point in time. Currently does not support per operation call
// overrides, may in the future.
resolvedDefaultsMode aws.DefaultsMode
// The HTTP client to invoke API calls with. Defaults to client's default HTTP
// implementation if nil.
HTTPClient HTTPClient
}
// WithAPIOptions returns a functional option for setting the Client's APIOptions
// option.
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options) {
return func(o *Options) {
o.APIOptions = append(o.APIOptions, optFns...)
}
}
// WithEndpointResolver returns a functional option for setting the Client's
// EndpointResolver option.
func WithEndpointResolver(v EndpointResolver) func(*Options) {
return func(o *Options) {
o.EndpointResolver = v
}
}
type HTTPClient interface {
Do(*http.Request) (*http.Response, error)
}
// Copy creates a clone where the APIOptions list is deep copied.
func (o Options) Copy() Options {
to := o
to.APIOptions = make([]func(*middleware.Stack) error, len(o.APIOptions))
copy(to.APIOptions, o.APIOptions)
return to
}
func (c *Client) invokeOperation(ctx context.Context, opID string, params interface{}, optFns []func(*Options), stackFns ...func(*middleware.Stack, Options) error) (result interface{}, metadata middleware.Metadata, err error) {
ctx = middleware.ClearStackValues(ctx)
stack := middleware.NewStack(opID, smithyhttp.NewStackRequest)
options := c.options.Copy()
for _, fn := range optFns {
fn(&options)
}
finalizeRetryMaxAttemptOptions(&options, *c)
finalizeClientEndpointResolverOptions(&options)
for _, fn := range stackFns {
if err := fn(stack, options); err != nil {
return nil, metadata, err
}
}
for _, fn := range options.APIOptions {
if err := fn(stack); err != nil {
return nil, metadata, err
}
}
handler := middleware.DecorateHandler(smithyhttp.NewClientHandler(options.HTTPClient), stack)
result, metadata, err = handler.Handle(ctx, params)
if err != nil {
err = &smithy.OperationError{
ServiceID: ServiceID,
OperationName: opID,
Err: err,
}
}
return result, metadata, err
}
type noSmithyDocumentSerde = smithydocument.NoSerde
func resolveDefaultLogger(o *Options) {
if o.Logger != nil {
return
}
o.Logger = logging.Nop{}
}
func addSetLoggerMiddleware(stack *middleware.Stack, o Options) error {
return middleware.AddSetLoggerMiddleware(stack, o.Logger)
}
func setResolvedDefaultsMode(o *Options) {
if len(o.resolvedDefaultsMode) > 0 {
return
}
var mode aws.DefaultsMode
mode.SetFromString(string(o.DefaultsMode))
if mode == aws.DefaultsModeAuto {
mode = defaults.ResolveDefaultsModeAuto(o.Region, o.RuntimeEnvironment)
}
o.resolvedDefaultsMode = mode
}
// NewFromConfig returns a new client from the provided config.
func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client {
opts := Options{
Region: cfg.Region,
DefaultsMode: cfg.DefaultsMode,
RuntimeEnvironment: cfg.RuntimeEnvironment,
HTTPClient: cfg.HTTPClient,
Credentials: cfg.Credentials,
APIOptions: cfg.APIOptions,
Logger: cfg.Logger,
ClientLogMode: cfg.ClientLogMode,
}
resolveAWSRetryerProvider(cfg, &opts)
resolveAWSRetryMaxAttempts(cfg, &opts)
resolveAWSRetryMode(cfg, &opts)
resolveAWSEndpointResolver(cfg, &opts)
resolveUseDualStackEndpoint(cfg, &opts)
resolveUseFIPSEndpoint(cfg, &opts)
return New(opts, optFns...)
}
func resolveHTTPClient(o *Options) {
var buildable *awshttp.BuildableClient
if o.HTTPClient != nil {
var ok bool
buildable, ok = o.HTTPClient.(*awshttp.BuildableClient)
if !ok {
return
}
} else {
buildable = awshttp.NewBuildableClient()
}
modeConfig, err := defaults.GetModeConfiguration(o.resolvedDefaultsMode)
if err == nil {
buildable = buildable.WithDialerOptions(func(dialer *net.Dialer) {
if dialerTimeout, ok := modeConfig.GetConnectTimeout(); ok {
dialer.Timeout = dialerTimeout
}
})
buildable = buildable.WithTransportOptions(func(transport *http.Transport) {
if tlsHandshakeTimeout, ok := modeConfig.GetTLSNegotiationTimeout(); ok {
transport.TLSHandshakeTimeout = tlsHandshakeTimeout
}
})
}
o.HTTPClient = buildable
}
func resolveRetryer(o *Options) {
if o.Retryer != nil {
return
}
if len(o.RetryMode) == 0 {
modeConfig, err := defaults.GetModeConfiguration(o.resolvedDefaultsMode)
if err == nil {
o.RetryMode = modeConfig.RetryMode
}
}
if len(o.RetryMode) == 0 {
o.RetryMode = aws.RetryModeStandard
}
var standardOptions []func(*retry.StandardOptions)
if v := o.RetryMaxAttempts; v != 0 {
standardOptions = append(standardOptions, func(so *retry.StandardOptions) {
so.MaxAttempts = v
})
}
switch o.RetryMode {
case aws.RetryModeAdaptive:
var adaptiveOptions []func(*retry.AdaptiveModeOptions)
if len(standardOptions) != 0 {
adaptiveOptions = append(adaptiveOptions, func(ao *retry.AdaptiveModeOptions) {
ao.StandardOptions = append(ao.StandardOptions, standardOptions...)
})
}
o.Retryer = retry.NewAdaptiveMode(adaptiveOptions...)
default:
o.Retryer = retry.NewStandard(standardOptions...)
}
}
func resolveAWSRetryerProvider(cfg aws.Config, o *Options) {
if cfg.Retryer == nil {
return
}
o.Retryer = cfg.Retryer()
}
func resolveAWSRetryMode(cfg aws.Config, o *Options) {
if len(cfg.RetryMode) == 0 {
return
}
o.RetryMode = cfg.RetryMode
}
func resolveAWSRetryMaxAttempts(cfg aws.Config, o *Options) {
if cfg.RetryMaxAttempts == 0 {
return
}
o.RetryMaxAttempts = cfg.RetryMaxAttempts
}
func finalizeRetryMaxAttemptOptions(o *Options, client Client) {
if v := o.RetryMaxAttempts; v == 0 || v == client.options.RetryMaxAttempts {
return
}
o.Retryer = retry.AddWithMaxAttempts(o.Retryer, o.RetryMaxAttempts)
}
func resolveAWSEndpointResolver(cfg aws.Config, o *Options) {
if cfg.EndpointResolver == nil && cfg.EndpointResolverWithOptions == nil {
return
}
o.EndpointResolver = withEndpointResolver(cfg.EndpointResolver, cfg.EndpointResolverWithOptions, NewDefaultEndpointResolver())
}
func addClientUserAgent(stack *middleware.Stack) error {
return awsmiddleware.AddSDKAgentKeyValue(awsmiddleware.APIMetadata, "ram", goModuleVersion)(stack)
}
func addHTTPSignerV4Middleware(stack *middleware.Stack, o Options) error {
mw := v4.NewSignHTTPRequestMiddleware(v4.SignHTTPRequestMiddlewareOptions{
CredentialsProvider: o.Credentials,
Signer: o.HTTPSignerV4,
LogSigning: o.ClientLogMode.IsSigning(),
})
return stack.Finalize.Add(mw, middleware.After)
}
type HTTPSignerV4 interface {
SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}
func resolveHTTPSignerV4(o *Options) {
if o.HTTPSignerV4 != nil {
return
}
o.HTTPSignerV4 = newDefaultV4Signer(*o)
}
func newDefaultV4Signer(o Options) *v4.Signer {
return v4.NewSigner(func(so *v4.SignerOptions) {
so.Logger = o.Logger
so.LogSigning = o.ClientLogMode.IsSigning()
})
}
func addRetryMiddlewares(stack *middleware.Stack, o Options) error {
mo := retry.AddRetryMiddlewaresOptions{
Retryer: o.Retryer,
LogRetryAttempts: o.ClientLogMode.IsRetries(),
}
return retry.AddRetryMiddlewares(stack, mo)
}
// resolves dual-stack endpoint configuration
func resolveUseDualStackEndpoint(cfg aws.Config, o *Options) error {
if len(cfg.ConfigSources) == 0 {
return nil
}
value, found, err := internalConfig.ResolveUseDualStackEndpoint(context.Background(), cfg.ConfigSources)
if err != nil {
return err
}
if found {
o.EndpointOptions.UseDualStackEndpoint = value
}
return nil
}
// resolves FIPS endpoint configuration
func resolveUseFIPSEndpoint(cfg aws.Config, o *Options) error {
if len(cfg.ConfigSources) == 0 {
return nil
}
value, found, err := internalConfig.ResolveUseFIPSEndpoint(context.Background(), cfg.ConfigSources)
if err != nil {
return err
}
if found {
o.EndpointOptions.UseFIPSEndpoint = value
}
return nil
}
func addRequestIDRetrieverMiddleware(stack *middleware.Stack) error {
return awsmiddleware.AddRequestIDRetrieverMiddleware(stack)
}
func addResponseErrorMiddleware(stack *middleware.Stack) error {
return awshttp.AddResponseErrorMiddleware(stack)
}
func addRequestResponseLogging(stack *middleware.Stack, o Options) error {
return stack.Deserialize.Add(&smithyhttp.RequestResponseLogger{
LogRequest: o.ClientLogMode.IsRequest(),
LogRequestWithBody: o.ClientLogMode.IsRequestWithBody(),
LogResponse: o.ClientLogMode.IsResponse(),
LogResponseWithBody: o.ClientLogMode.IsResponseWithBody(),
}, middleware.After)
}
| 435 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
"io/ioutil"
"net/http"
"strings"
"testing"
)
func TestClient_resolveRetryOptions(t *testing.T) {
nopClient := smithyhttp.ClientDoFunc(func(_ *http.Request) (*http.Response, error) {
return &http.Response{
StatusCode: 200,
Header: http.Header{},
Body: ioutil.NopCloser(strings.NewReader("")),
}, nil
})
cases := map[string]struct {
defaultsMode aws.DefaultsMode
retryer aws.Retryer
retryMaxAttempts int
opRetryMaxAttempts *int
retryMode aws.RetryMode
expectClientRetryMode aws.RetryMode
expectClientMaxAttempts int
expectOpMaxAttempts int
}{
"defaults": {
defaultsMode: aws.DefaultsModeStandard,
expectClientRetryMode: aws.RetryModeStandard,
expectClientMaxAttempts: 3,
expectOpMaxAttempts: 3,
},
"custom default retry": {
retryMode: aws.RetryModeAdaptive,
retryMaxAttempts: 10,
expectClientRetryMode: aws.RetryModeAdaptive,
expectClientMaxAttempts: 10,
expectOpMaxAttempts: 10,
},
"custom op max attempts": {
retryMode: aws.RetryModeAdaptive,
retryMaxAttempts: 10,
opRetryMaxAttempts: aws.Int(2),
expectClientRetryMode: aws.RetryModeAdaptive,
expectClientMaxAttempts: 10,
expectOpMaxAttempts: 2,
},
"custom op no change max attempts": {
retryMode: aws.RetryModeAdaptive,
retryMaxAttempts: 10,
opRetryMaxAttempts: aws.Int(10),
expectClientRetryMode: aws.RetryModeAdaptive,
expectClientMaxAttempts: 10,
expectOpMaxAttempts: 10,
},
"custom op 0 max attempts": {
retryMode: aws.RetryModeAdaptive,
retryMaxAttempts: 10,
opRetryMaxAttempts: aws.Int(0),
expectClientRetryMode: aws.RetryModeAdaptive,
expectClientMaxAttempts: 10,
expectOpMaxAttempts: 10,
},
}
for name, c := range cases {
t.Run(name, func(t *testing.T) {
client := NewFromConfig(aws.Config{
DefaultsMode: c.defaultsMode,
Retryer: func() func() aws.Retryer {
if c.retryer == nil {
return nil
}
return func() aws.Retryer { return c.retryer }
}(),
HTTPClient: nopClient,
RetryMaxAttempts: c.retryMaxAttempts,
RetryMode: c.retryMode,
})
if e, a := c.expectClientRetryMode, client.options.RetryMode; e != a {
t.Errorf("expect %v retry mode, got %v", e, a)
}
if e, a := c.expectClientMaxAttempts, client.options.Retryer.MaxAttempts(); e != a {
t.Errorf("expect %v max attempts, got %v", e, a)
}
_, _, err := client.invokeOperation(context.Background(), "mockOperation", struct{}{},
[]func(*Options){
func(o *Options) {
if c.opRetryMaxAttempts == nil {
return
}
o.RetryMaxAttempts = *c.opRetryMaxAttempts
},
},
func(s *middleware.Stack, o Options) error {
s.Initialize.Clear()
s.Serialize.Clear()
s.Build.Clear()
s.Finalize.Clear()
s.Deserialize.Clear()
if e, a := c.expectOpMaxAttempts, o.Retryer.MaxAttempts(); e != a {
t.Errorf("expect %v op max attempts, got %v", e, a)
}
return nil
})
if err != nil {
t.Fatalf("expect no operation error, got %v", err)
}
})
}
}
| 124 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Accepts an invitation to a resource share from another Amazon Web Services
// account. After you accept the invitation, the resources included in the resource
// share are available to interact with in the relevant Amazon Web Services
// Management Consoles and tools.
func (c *Client) AcceptResourceShareInvitation(ctx context.Context, params *AcceptResourceShareInvitationInput, optFns ...func(*Options)) (*AcceptResourceShareInvitationOutput, error) {
if params == nil {
params = &AcceptResourceShareInvitationInput{}
}
result, metadata, err := c.invokeOperation(ctx, "AcceptResourceShareInvitation", params, optFns, c.addOperationAcceptResourceShareInvitationMiddlewares)
if err != nil {
return nil, err
}
out := result.(*AcceptResourceShareInvitationOutput)
out.ResultMetadata = metadata
return out, nil
}
type AcceptResourceShareInvitationInput struct {
// The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the invitation that you want to accept.
//
// This member is required.
ResourceShareInvitationArn *string
// Specifies a unique, case-sensitive identifier that you provide to ensure the
// idempotency of the request. This lets you safely retry the request without
// accidentally performing the same operation a second time. Passing the same value
// to a later call to an operation requires that you also pass the same value for
// all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier)
// . If you don't provide this value, then Amazon Web Services generates a random
// one for you. If you retry the operation with the same ClientToken , but with
// different parameters, the retry fails with an IdempotentParameterMismatch error.
ClientToken *string
noSmithyDocumentSerde
}
type AcceptResourceShareInvitationOutput struct {
// The idempotency identifier associated with this request. If you want to repeat
// the same operation in an idempotent manner then you must include this value in
// the clientToken request parameter of that later call. All other parameters must
// also have the same values that you used in the first call.
ClientToken *string
// An object that contains information about the specified invitation.
ResourceShareInvitation *types.ResourceShareInvitation
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationAcceptResourceShareInvitationMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpAcceptResourceShareInvitation{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpAcceptResourceShareInvitation{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpAcceptResourceShareInvitationValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opAcceptResourceShareInvitation(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opAcceptResourceShareInvitation(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "AcceptResourceShareInvitation",
}
}
| 145 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Adds the specified list of principals and list of resources to a resource
// share. Principals that already have access to this resource share immediately
// receive access to the added resources. Newly added principals immediately
// receive access to the resources shared in this resource share.
func (c *Client) AssociateResourceShare(ctx context.Context, params *AssociateResourceShareInput, optFns ...func(*Options)) (*AssociateResourceShareOutput, error) {
if params == nil {
params = &AssociateResourceShareInput{}
}
result, metadata, err := c.invokeOperation(ctx, "AssociateResourceShare", params, optFns, c.addOperationAssociateResourceShareMiddlewares)
if err != nil {
return nil, err
}
out := result.(*AssociateResourceShareOutput)
out.ResultMetadata = metadata
return out, nil
}
type AssociateResourceShareInput struct {
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the resource share that you want to add principals or resources to.
//
// This member is required.
ResourceShareArn *string
// Specifies a unique, case-sensitive identifier that you provide to ensure the
// idempotency of the request. This lets you safely retry the request without
// accidentally performing the same operation a second time. Passing the same value
// to a later call to an operation requires that you also pass the same value for
// all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier)
// . If you don't provide this value, then Amazon Web Services generates a random
// one for you. If you retry the operation with the same ClientToken , but with
// different parameters, the retry fails with an IdempotentParameterMismatch error.
ClientToken *string
// Specifies a list of principals to whom you want to the resource share. This can
// be null if you want to add only resources. What the principals can do with the
// resources in the share is determined by the RAM permissions that you associate
// with the resource share. See AssociateResourceSharePermission . You can include
// the following values:
// - An Amazon Web Services account ID, for example: 123456789012
// - An Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of an organization in Organizations, for example:
// organizations::123456789012:organization/o-exampleorgid
// - An ARN of an organizational unit (OU) in Organizations, for example:
// organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
// - An ARN of an IAM role, for example: iam::123456789012:role/rolename
// - An ARN of an IAM user, for example: iam::123456789012user/username
// Not all resource types can be shared with IAM roles and users. For more
// information, see Sharing with IAM roles and users (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types)
// in the Resource Access Manager User Guide.
Principals []string
// Specifies a list of Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the resources that you want to share. This can be null if you want to add
// only principals.
ResourceArns []string
noSmithyDocumentSerde
}
type AssociateResourceShareOutput struct {
// The idempotency identifier associated with this request. If you want to repeat
// the same operation in an idempotent manner then you must include this value in
// the clientToken request parameter of that later call. All other parameters must
// also have the same values that you used in the first call.
ClientToken *string
// An array of objects that contain information about the associations.
ResourceShareAssociations []types.ResourceShareAssociation
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationAssociateResourceShareMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpAssociateResourceShare{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpAssociateResourceShare{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpAssociateResourceShareValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opAssociateResourceShare(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opAssociateResourceShare(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "AssociateResourceShare",
}
}
| 168 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Adds or replaces the RAM permission for a resource type included in a resource
// share. You can have exactly one permission associated with each resource type in
// the resource share. You can add a new RAM permission only if there are currently
// no resources of that resource type currently in the resource share.
func (c *Client) AssociateResourceSharePermission(ctx context.Context, params *AssociateResourceSharePermissionInput, optFns ...func(*Options)) (*AssociateResourceSharePermissionOutput, error) {
if params == nil {
params = &AssociateResourceSharePermissionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "AssociateResourceSharePermission", params, optFns, c.addOperationAssociateResourceSharePermissionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*AssociateResourceSharePermissionOutput)
out.ResultMetadata = metadata
return out, nil
}
type AssociateResourceSharePermissionInput struct {
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the RAM permission to associate with the resource share. To find the ARN for
// a permission, use either the ListPermissions operation or go to the Permissions
// library (https://console.aws.amazon.com/ram/home#Permissions:) page in the RAM
// console and then choose the name of the permission. The ARN is displayed on the
// detail page.
//
// This member is required.
PermissionArn *string
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the resource share to which you want to add or replace permissions.
//
// This member is required.
ResourceShareArn *string
// Specifies a unique, case-sensitive identifier that you provide to ensure the
// idempotency of the request. This lets you safely retry the request without
// accidentally performing the same operation a second time. Passing the same value
// to a later call to an operation requires that you also pass the same value for
// all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier)
// . If you don't provide this value, then Amazon Web Services generates a random
// one for you. If you retry the operation with the same ClientToken , but with
// different parameters, the retry fails with an IdempotentParameterMismatch error.
ClientToken *string
// Specifies the version of the RAM permission to associate with the resource
// share. You can specify only the version that is currently set as the default
// version for the permission. If you also set the replace pararameter to true ,
// then this operation updates an outdated version of the permission to the current
// default version. You don't need to specify this parameter because the default
// behavior is to use the version that is currently set as the default version for
// the permission. This parameter is supported for backwards compatibility.
PermissionVersion *int32
// Specifies whether the specified permission should replace the existing
// permission associated with the resource share. Use true to replace the current
// permissions. Use false to add the permission to a resource share that currently
// doesn't have a permission. The default value is false . A resource share can
// have only one permission per resource type. If a resource share already has a
// permission for the specified resource type and you don't set replace to true
// then the operation returns an error. This helps prevent accidental overwriting
// of a permission.
Replace *bool
noSmithyDocumentSerde
}
type AssociateResourceSharePermissionOutput struct {
// The idempotency identifier associated with this request. If you want to repeat
// the same operation in an idempotent manner then you must include this value in
// the clientToken request parameter of that later call. All other parameters must
// also have the same values that you used in the first call.
ClientToken *string
// A return value of true indicates that the request succeeded. A value of false
// indicates that the request failed.
ReturnValue *bool
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationAssociateResourceSharePermissionMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpAssociateResourceSharePermission{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpAssociateResourceSharePermission{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpAssociateResourceSharePermissionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opAssociateResourceSharePermission(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opAssociateResourceSharePermission(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "AssociateResourceSharePermission",
}
}
| 174 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates a customer managed permission for a specified resource type that you
// can attach to resource shares. It is created in the Amazon Web Services Region
// in which you call the operation.
func (c *Client) CreatePermission(ctx context.Context, params *CreatePermissionInput, optFns ...func(*Options)) (*CreatePermissionOutput, error) {
if params == nil {
params = &CreatePermissionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreatePermission", params, optFns, c.addOperationCreatePermissionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreatePermissionOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreatePermissionInput struct {
// Specifies the name of the customer managed permission. The name must be unique
// within the Amazon Web Services Region.
//
// This member is required.
Name *string
// A string in JSON format string that contains the following elements of a
// resource-based policy:
// - Effect: must be set to ALLOW .
// - Action: specifies the actions that are allowed by this customer managed
// permission. The list must contain only actions that are supported by the
// specified resource type. For a list of all actions supported by each resource
// type, see Actions, resources, and condition keys for Amazon Web Services
// services (https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html)
// in the Identity and Access Management User Guide.
// - Condition: (optional) specifies conditional parameters that must evaluate
// to true when a user attempts an action for that action to be allowed. For more
// information about the Condition element, see IAM policies: Condition element (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html)
// in the Identity and Access Management User Guide.
// This template can't include either the Resource or Principal elements. Those
// are both filled in by RAM when it instantiates the resource-based policy on each
// resource shared using this managed permission. The Resource comes from the ARN
// of the specific resource that you are sharing. The Principal comes from the
// list of identities added to the resource share.
//
// This member is required.
PolicyTemplate *string
// Specifies the name of the resource type that this customer managed permission
// applies to. The format is : and is not case sensitive. For example, to specify
// an Amazon EC2 Subnet, you can use the string ec2:subnet . To see the list of
// valid values for this parameter, query the ListResourceTypes operation.
//
// This member is required.
ResourceType *string
// Specifies a unique, case-sensitive identifier that you provide to ensure the
// idempotency of the request. This lets you safely retry the request without
// accidentally performing the same operation a second time. Passing the same value
// to a later call to an operation requires that you also pass the same value for
// all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier)
// . If you don't provide this value, then Amazon Web Services generates a random
// one for you. If you retry the operation with the same ClientToken , but with
// different parameters, the retry fails with an IdempotentParameterMismatch error.
ClientToken *string
// Specifies a list of one or more tag key and value pairs to attach to the
// permission.
Tags []types.Tag
noSmithyDocumentSerde
}
type CreatePermissionOutput struct {
// The idempotency identifier associated with this request. If you want to repeat
// the same operation in an idempotent manner then you must include this value in
// the clientToken request parameter of that later call. All other parameters must
// also have the same values that you used in the first call.
ClientToken *string
// A structure with information about this customer managed permission.
Permission *types.ResourceSharePermissionSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreatePermissionMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreatePermission{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreatePermission{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpCreatePermissionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreatePermission(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreatePermission(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "CreatePermission",
}
}
| 178 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates a new version of the specified customer managed permission. The new
// version is automatically set as the default version of the customer managed
// permission. New resource shares automatically use the default permission.
// Existing resource shares continue to use their original permission versions, but
// you can use ReplacePermissionAssociations to update them. If the specified
// customer managed permission already has the maximum of 5 versions, then you must
// delete one of the existing versions before you can create a new one.
func (c *Client) CreatePermissionVersion(ctx context.Context, params *CreatePermissionVersionInput, optFns ...func(*Options)) (*CreatePermissionVersionOutput, error) {
if params == nil {
params = &CreatePermissionVersionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreatePermissionVersion", params, optFns, c.addOperationCreatePermissionVersionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreatePermissionVersionOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreatePermissionVersionInput struct {
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the customer managed permission you're creating a new version for.
//
// This member is required.
PermissionArn *string
// A string in JSON format string that contains the following elements of a
// resource-based policy:
// - Effect: must be set to ALLOW .
// - Action: specifies the actions that are allowed by this customer managed
// permission. The list must contain only actions that are supported by the
// specified resource type. For a list of all actions supported by each resource
// type, see Actions, resources, and condition keys for Amazon Web Services
// services (https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html)
// in the Identity and Access Management User Guide.
// - Condition: (optional) specifies conditional parameters that must evaluate
// to true when a user attempts an action for that action to be allowed. For more
// information about the Condition element, see IAM policies: Condition element (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html)
// in the Identity and Access Management User Guide.
// This template can't include either the Resource or Principal elements. Those
// are both filled in by RAM when it instantiates the resource-based policy on each
// resource shared using this managed permission. The Resource comes from the ARN
// of the specific resource that you are sharing. The Principal comes from the
// list of identities added to the resource share.
//
// This member is required.
PolicyTemplate *string
// Specifies a unique, case-sensitive identifier that you provide to ensure the
// idempotency of the request. This lets you safely retry the request without
// accidentally performing the same operation a second time. Passing the same value
// to a later call to an operation requires that you also pass the same value for
// all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier)
// . If you don't provide this value, then Amazon Web Services generates a random
// one for you. If you retry the operation with the same ClientToken , but with
// different parameters, the retry fails with an IdempotentParameterMismatch error.
ClientToken *string
noSmithyDocumentSerde
}
type CreatePermissionVersionOutput struct {
// The idempotency identifier associated with this request. If you want to repeat
// the same operation in an idempotent manner then you must include this value in
// the clientToken request parameter of that later call. All other parameters must
// also have the same values that you used in the first call.
ClientToken *string
// Information about a RAM managed permission.
Permission *types.ResourceSharePermissionDetail
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreatePermissionVersionMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreatePermissionVersion{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreatePermissionVersion{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpCreatePermissionVersionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreatePermissionVersion(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreatePermissionVersion(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "CreatePermissionVersion",
}
}
| 170 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Creates a resource share. You can provide a list of the Amazon Resource Names
// (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// for the resources that you want to share, a list of principals you want to share
// the resources with, and the permissions to grant those principals. Sharing a
// resource makes it available for use by principals outside of the Amazon Web
// Services account that created the resource. Sharing doesn't change any
// permissions or quotas that apply to the resource in the account that created it.
func (c *Client) CreateResourceShare(ctx context.Context, params *CreateResourceShareInput, optFns ...func(*Options)) (*CreateResourceShareOutput, error) {
if params == nil {
params = &CreateResourceShareInput{}
}
result, metadata, err := c.invokeOperation(ctx, "CreateResourceShare", params, optFns, c.addOperationCreateResourceShareMiddlewares)
if err != nil {
return nil, err
}
out := result.(*CreateResourceShareOutput)
out.ResultMetadata = metadata
return out, nil
}
type CreateResourceShareInput struct {
// Specifies the name of the resource share.
//
// This member is required.
Name *string
// Specifies whether principals outside your organization in Organizations can be
// associated with a resource share. A value of true lets you share with
// individual Amazon Web Services accounts that are not in your organization. A
// value of false only has meaning if your account is a member of an Amazon Web
// Services Organization. The default value is true .
AllowExternalPrincipals *bool
// Specifies a unique, case-sensitive identifier that you provide to ensure the
// idempotency of the request. This lets you safely retry the request without
// accidentally performing the same operation a second time. Passing the same value
// to a later call to an operation requires that you also pass the same value for
// all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier)
// . If you don't provide this value, then Amazon Web Services generates a random
// one for you. If you retry the operation with the same ClientToken , but with
// different parameters, the retry fails with an IdempotentParameterMismatch error.
ClientToken *string
// Specifies the Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the RAM permission to associate with the resource share. If you do not
// specify an ARN for the permission, RAM automatically attaches the default
// version of the permission for each resource type. You can associate only one
// permission with each resource type included in the resource share.
PermissionArns []string
// Specifies a list of one or more principals to associate with the resource
// share. You can include the following values:
// - An Amazon Web Services account ID, for example: 123456789012
// - An Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of an organization in Organizations, for example:
// organizations::123456789012:organization/o-exampleorgid
// - An ARN of an organizational unit (OU) in Organizations, for example:
// organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
// - An ARN of an IAM role, for example: iam::123456789012:role/rolename
// - An ARN of an IAM user, for example: iam::123456789012user/username
// Not all resource types can be shared with IAM roles and users. For more
// information, see Sharing with IAM roles and users (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types)
// in the Resource Access Manager User Guide.
Principals []string
// Specifies a list of one or more ARNs of the resources to associate with the
// resource share.
ResourceArns []string
// Specifies one or more tags to attach to the resource share itself. It doesn't
// attach the tags to the resources associated with the resource share.
Tags []types.Tag
noSmithyDocumentSerde
}
type CreateResourceShareOutput struct {
// The idempotency identifier associated with this request. If you want to repeat
// the same operation in an idempotent manner then you must include this value in
// the clientToken request parameter of that later call. All other parameters must
// also have the same values that you used in the first call.
ClientToken *string
// An object with information about the new resource share.
ResourceShare *types.ResourceShare
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationCreateResourceShareMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpCreateResourceShare{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpCreateResourceShare{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpCreateResourceShareValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateResourceShare(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opCreateResourceShare(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "CreateResourceShare",
}
}
| 184 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Deletes the specified customer managed permission in the Amazon Web Services
// Region in which you call this operation. You can delete a customer managed
// permission only if it isn't attached to any resource share. The operation
// deletes all versions associated with the customer managed permission.
func (c *Client) DeletePermission(ctx context.Context, params *DeletePermissionInput, optFns ...func(*Options)) (*DeletePermissionOutput, error) {
if params == nil {
params = &DeletePermissionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DeletePermission", params, optFns, c.addOperationDeletePermissionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DeletePermissionOutput)
out.ResultMetadata = metadata
return out, nil
}
type DeletePermissionInput struct {
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the customer managed permission that you want to delete.
//
// This member is required.
PermissionArn *string
// Specifies a unique, case-sensitive identifier that you provide to ensure the
// idempotency of the request. This lets you safely retry the request without
// accidentally performing the same operation a second time. Passing the same value
// to a later call to an operation requires that you also pass the same value for
// all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier)
// . If you don't provide this value, then Amazon Web Services generates a random
// one for you. If you retry the operation with the same ClientToken , but with
// different parameters, the retry fails with an IdempotentParameterMismatch error.
ClientToken *string
noSmithyDocumentSerde
}
type DeletePermissionOutput struct {
// The idempotency identifier associated with this request. If you want to repeat
// the same operation in an idempotent manner then you must include this value in
// the clientToken request parameter of that later call. All other parameters must
// also have the same values that you used in the first call.
ClientToken *string
// This operation is performed asynchronously, and this response parameter
// indicates the current status.
PermissionStatus types.PermissionStatus
// A boolean that indicates whether the delete operations succeeded.
ReturnValue *bool
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDeletePermissionMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpDeletePermission{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDeletePermission{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpDeletePermissionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeletePermission(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDeletePermission(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "DeletePermission",
}
}
| 149 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Deletes one version of a customer managed permission. The version you specify
// must not be attached to any resource share and must not be the default version
// for the permission. If a customer managed permission has the maximum of 5
// versions, then you must delete at least one version before you can create
// another.
func (c *Client) DeletePermissionVersion(ctx context.Context, params *DeletePermissionVersionInput, optFns ...func(*Options)) (*DeletePermissionVersionOutput, error) {
if params == nil {
params = &DeletePermissionVersionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DeletePermissionVersion", params, optFns, c.addOperationDeletePermissionVersionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DeletePermissionVersionOutput)
out.ResultMetadata = metadata
return out, nil
}
type DeletePermissionVersionInput struct {
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the permission with the version you want to delete.
//
// This member is required.
PermissionArn *string
// Specifies the version number to delete. You can't delete the default version
// for a customer managed permission. You can't delete a version if it's the only
// version of the permission. You must either first create another version, or
// delete the permission completely. You can't delete a version if it is attached
// to any resource shares. If the version is the default, you must first use
// SetDefaultPermissionVersion to set a different version as the default for the
// customer managed permission, and then use AssociateResourceSharePermission to
// update your resource shares to use the new default version.
//
// This member is required.
PermissionVersion *int32
// Specifies a unique, case-sensitive identifier that you provide to ensure the
// idempotency of the request. This lets you safely retry the request without
// accidentally performing the same operation a second time. Passing the same value
// to a later call to an operation requires that you also pass the same value for
// all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier)
// . If you don't provide this value, then Amazon Web Services generates a random
// one for you. If you retry the operation with the same ClientToken , but with
// different parameters, the retry fails with an IdempotentParameterMismatch error.
ClientToken *string
noSmithyDocumentSerde
}
type DeletePermissionVersionOutput struct {
// The idempotency identifier associated with this request. If you want to repeat
// the same operation in an idempotent manner then you must include this value in
// the clientToken request parameter of that later call. All other parameters must
// also have the same values that you used in the first call.
ClientToken *string
// This operation is performed asynchronously, and this response parameter
// indicates the current status.
PermissionStatus types.PermissionStatus
// A boolean value that indicates whether the operation is successful.
ReturnValue *bool
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDeletePermissionVersionMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpDeletePermissionVersion{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDeletePermissionVersion{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpDeletePermissionVersionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeletePermissionVersion(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDeletePermissionVersion(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "DeletePermissionVersion",
}
}
| 162 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Deletes the specified resource share. This doesn't delete any of the resources
// that were associated with the resource share; it only stops the sharing of those
// resources through this resource share.
func (c *Client) DeleteResourceShare(ctx context.Context, params *DeleteResourceShareInput, optFns ...func(*Options)) (*DeleteResourceShareOutput, error) {
if params == nil {
params = &DeleteResourceShareInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DeleteResourceShare", params, optFns, c.addOperationDeleteResourceShareMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DeleteResourceShareOutput)
out.ResultMetadata = metadata
return out, nil
}
type DeleteResourceShareInput struct {
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the resource share to delete.
//
// This member is required.
ResourceShareArn *string
// Specifies a unique, case-sensitive identifier that you provide to ensure the
// idempotency of the request. This lets you safely retry the request without
// accidentally performing the same operation a second time. Passing the same value
// to a later call to an operation requires that you also pass the same value for
// all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier)
// . If you don't provide this value, then Amazon Web Services generates a random
// one for you. If you retry the operation with the same ClientToken , but with
// different parameters, the retry fails with an IdempotentParameterMismatch error.
ClientToken *string
noSmithyDocumentSerde
}
type DeleteResourceShareOutput struct {
// The idempotency identifier associated with this request. If you want to repeat
// the same operation in an idempotent manner then you must include this value in
// the clientToken request parameter of that later call. All other parameters must
// also have the same values that you used in the first call.
ClientToken *string
// A return value of true indicates that the request succeeded. A value of false
// indicates that the request failed.
ReturnValue *bool
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDeleteResourceShareMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpDeleteResourceShare{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDeleteResourceShare{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpDeleteResourceShareValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDeleteResourceShare(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDeleteResourceShare(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "DeleteResourceShare",
}
}
| 144 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Removes the specified principals or resources from participating in the
// specified resource share.
func (c *Client) DisassociateResourceShare(ctx context.Context, params *DisassociateResourceShareInput, optFns ...func(*Options)) (*DisassociateResourceShareOutput, error) {
if params == nil {
params = &DisassociateResourceShareInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DisassociateResourceShare", params, optFns, c.addOperationDisassociateResourceShareMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DisassociateResourceShareOutput)
out.ResultMetadata = metadata
return out, nil
}
type DisassociateResourceShareInput struct {
// Specifies Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the resource share that you want to remove resources or principals from.
//
// This member is required.
ResourceShareArn *string
// Specifies a unique, case-sensitive identifier that you provide to ensure the
// idempotency of the request. This lets you safely retry the request without
// accidentally performing the same operation a second time. Passing the same value
// to a later call to an operation requires that you also pass the same value for
// all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier)
// . If you don't provide this value, then Amazon Web Services generates a random
// one for you. If you retry the operation with the same ClientToken , but with
// different parameters, the retry fails with an IdempotentParameterMismatch error.
ClientToken *string
// Specifies a list of one or more principals that no longer are to have access to
// the resources in this resource share. You can include the following values:
// - An Amazon Web Services account ID, for example: 123456789012
// - An Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of an organization in Organizations, for example:
// organizations::123456789012:organization/o-exampleorgid
// - An ARN of an organizational unit (OU) in Organizations, for example:
// organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
// - An ARN of an IAM role, for example: iam::123456789012:role/rolename
// - An ARN of an IAM user, for example: iam::123456789012user/username
// Not all resource types can be shared with IAM roles and users. For more
// information, see Sharing with IAM roles and users (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types)
// in the Resource Access Manager User Guide.
Principals []string
// Specifies a list of Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// for one or more resources that you want to remove from the resource share. After
// the operation runs, these resources are no longer shared with principals
// associated with the resource share.
ResourceArns []string
noSmithyDocumentSerde
}
type DisassociateResourceShareOutput struct {
// The idempotency identifier associated with this request. If you want to repeat
// the same operation in an idempotent manner then you must include this value in
// the clientToken request parameter of that later call. All other parameters must
// also have the same values that you used in the first call.
ClientToken *string
// An array of objects with information about the updated associations for this
// resource share.
ResourceShareAssociations []types.ResourceShareAssociation
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDisassociateResourceShareMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpDisassociateResourceShare{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDisassociateResourceShare{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpDisassociateResourceShareValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDisassociateResourceShare(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDisassociateResourceShare(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "DisassociateResourceShare",
}
}
| 165 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Removes a managed permission from a resource share. Permission changes take
// effect immediately. You can remove a managed permission from a resource share
// only if there are currently no resources of the relevant resource type currently
// attached to the resource share.
func (c *Client) DisassociateResourceSharePermission(ctx context.Context, params *DisassociateResourceSharePermissionInput, optFns ...func(*Options)) (*DisassociateResourceSharePermissionOutput, error) {
if params == nil {
params = &DisassociateResourceSharePermissionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DisassociateResourceSharePermission", params, optFns, c.addOperationDisassociateResourceSharePermissionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DisassociateResourceSharePermissionOutput)
out.ResultMetadata = metadata
return out, nil
}
type DisassociateResourceSharePermissionInput struct {
// The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the managed permission to disassociate from the resource share. Changes to
// permissions take effect immediately.
//
// This member is required.
PermissionArn *string
// The Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the resource share that you want to remove the managed permission from.
//
// This member is required.
ResourceShareArn *string
// Specifies a unique, case-sensitive identifier that you provide to ensure the
// idempotency of the request. This lets you safely retry the request without
// accidentally performing the same operation a second time. Passing the same value
// to a later call to an operation requires that you also pass the same value for
// all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier)
// . If you don't provide this value, then Amazon Web Services generates a random
// one for you. If you retry the operation with the same ClientToken , but with
// different parameters, the retry fails with an IdempotentParameterMismatch error.
ClientToken *string
noSmithyDocumentSerde
}
type DisassociateResourceSharePermissionOutput struct {
// The idempotency identifier associated with this request. If you want to repeat
// the same operation in an idempotent manner then you must include this value in
// the clientToken request parameter of that later call. All other parameters must
// also have the same values that you used in the first call.
ClientToken *string
// A return value of true indicates that the request succeeded. A value of false
// indicates that the request failed.
ReturnValue *bool
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDisassociateResourceSharePermissionMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpDisassociateResourceSharePermission{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpDisassociateResourceSharePermission{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpDisassociateResourceSharePermissionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDisassociateResourceSharePermission(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opDisassociateResourceSharePermission(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "DisassociateResourceSharePermission",
}
}
| 152 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Enables resource sharing within your organization in Organizations. This
// operation creates a service-linked role called
// AWSServiceRoleForResourceAccessManager that has the IAM managed policy named
// AWSResourceAccessManagerServiceRolePolicy attached. This role permits RAM to
// retrieve information about the organization and its structure. This lets you
// share resources with all of the accounts in the calling account's organization
// by specifying the organization ID, or all of the accounts in an organizational
// unit (OU) by specifying the OU ID. Until you enable sharing within the
// organization, you can specify only individual Amazon Web Services accounts, or
// for supported resource types, IAM roles and users. You must call this operation
// from an IAM role or user in the organization's management account.
func (c *Client) EnableSharingWithAwsOrganization(ctx context.Context, params *EnableSharingWithAwsOrganizationInput, optFns ...func(*Options)) (*EnableSharingWithAwsOrganizationOutput, error) {
if params == nil {
params = &EnableSharingWithAwsOrganizationInput{}
}
result, metadata, err := c.invokeOperation(ctx, "EnableSharingWithAwsOrganization", params, optFns, c.addOperationEnableSharingWithAwsOrganizationMiddlewares)
if err != nil {
return nil, err
}
out := result.(*EnableSharingWithAwsOrganizationOutput)
out.ResultMetadata = metadata
return out, nil
}
type EnableSharingWithAwsOrganizationInput struct {
noSmithyDocumentSerde
}
type EnableSharingWithAwsOrganizationOutput struct {
// A return value of true indicates that the request succeeded. A value of false
// indicates that the request failed.
ReturnValue *bool
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationEnableSharingWithAwsOrganizationMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpEnableSharingWithAwsOrganization{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpEnableSharingWithAwsOrganization{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opEnableSharingWithAwsOrganization(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opEnableSharingWithAwsOrganization(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "EnableSharingWithAwsOrganization",
}
}
| 126 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Retrieves the contents of a managed permission in JSON format.
func (c *Client) GetPermission(ctx context.Context, params *GetPermissionInput, optFns ...func(*Options)) (*GetPermissionOutput, error) {
if params == nil {
params = &GetPermissionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetPermission", params, optFns, c.addOperationGetPermissionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetPermissionOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetPermissionInput struct {
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the permission whose contents you want to retrieve. To find the ARN for a
// permission, use either the ListPermissions operation or go to the Permissions
// library (https://console.aws.amazon.com/ram/home#Permissions:) page in the RAM
// console and then choose the name of the permission. The ARN is displayed on the
// detail page.
//
// This member is required.
PermissionArn *string
// Specifies the version number of the RAM permission to retrieve. If you don't
// specify this parameter, the operation retrieves the default version. To see the
// list of available versions, use ListPermissionVersions .
PermissionVersion *int32
noSmithyDocumentSerde
}
type GetPermissionOutput struct {
// An object with details about the permission.
Permission *types.ResourceSharePermissionDetail
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetPermissionMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetPermission{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetPermission{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpGetPermissionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetPermission(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opGetPermission(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "GetPermission",
}
}
| 135 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Retrieves the resource policies for the specified resources that you own and
// have shared.
func (c *Client) GetResourcePolicies(ctx context.Context, params *GetResourcePoliciesInput, optFns ...func(*Options)) (*GetResourcePoliciesOutput, error) {
if params == nil {
params = &GetResourcePoliciesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetResourcePolicies", params, optFns, c.addOperationGetResourcePoliciesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetResourcePoliciesOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetResourcePoliciesInput struct {
// Specifies the Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the resources whose policies you want to retrieve.
//
// This member is required.
ResourceArns []string
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
MaxResults *int32
// Specifies that you want to receive the next page of results. Valid only if you
// received a NextToken response in the previous request. If you did, it indicates
// that more output is available. Set this parameter to the value provided by the
// previous call's NextToken response to request the next page of results.
NextToken *string
// Specifies the principal.
Principal *string
noSmithyDocumentSerde
}
type GetResourcePoliciesOutput struct {
// If present, this value indicates that more output is available than is included
// in the current response. Use this value in the NextToken request parameter in a
// subsequent call to the operation to get the next part of the output. You should
// repeat this until the NextToken response element comes back as null . This
// indicates that this is the last page of results.
NextToken *string
// An array of resource policy documents in JSON format.
Policies []string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetResourcePoliciesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetResourcePolicies{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetResourcePolicies{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpGetResourcePoliciesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetResourcePolicies(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// GetResourcePoliciesAPIClient is a client that implements the
// GetResourcePolicies operation.
type GetResourcePoliciesAPIClient interface {
GetResourcePolicies(context.Context, *GetResourcePoliciesInput, ...func(*Options)) (*GetResourcePoliciesOutput, error)
}
var _ GetResourcePoliciesAPIClient = (*Client)(nil)
// GetResourcePoliciesPaginatorOptions is the paginator options for
// GetResourcePolicies
type GetResourcePoliciesPaginatorOptions struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// GetResourcePoliciesPaginator is a paginator for GetResourcePolicies
type GetResourcePoliciesPaginator struct {
options GetResourcePoliciesPaginatorOptions
client GetResourcePoliciesAPIClient
params *GetResourcePoliciesInput
nextToken *string
firstPage bool
}
// NewGetResourcePoliciesPaginator returns a new GetResourcePoliciesPaginator
func NewGetResourcePoliciesPaginator(client GetResourcePoliciesAPIClient, params *GetResourcePoliciesInput, optFns ...func(*GetResourcePoliciesPaginatorOptions)) *GetResourcePoliciesPaginator {
if params == nil {
params = &GetResourcePoliciesInput{}
}
options := GetResourcePoliciesPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &GetResourcePoliciesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *GetResourcePoliciesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next GetResourcePolicies page.
func (p *GetResourcePoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourcePoliciesOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.GetResourcePolicies(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opGetResourcePolicies(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "GetResourcePolicies",
}
}
| 253 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Retrieves the lists of resources and principals that associated for resource
// shares that you own.
func (c *Client) GetResourceShareAssociations(ctx context.Context, params *GetResourceShareAssociationsInput, optFns ...func(*Options)) (*GetResourceShareAssociationsOutput, error) {
if params == nil {
params = &GetResourceShareAssociationsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetResourceShareAssociations", params, optFns, c.addOperationGetResourceShareAssociationsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetResourceShareAssociationsOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetResourceShareAssociationsInput struct {
// Specifies whether you want to retrieve the associations that involve a
// specified resource or principal.
// - PRINCIPAL – list the principals whose associations you want to see.
// - RESOURCE – list the resources whose associations you want to see.
//
// This member is required.
AssociationType types.ResourceShareAssociationType
// Specifies that you want to retrieve only associations that have this status.
AssociationStatus types.ResourceShareAssociationStatus
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
MaxResults *int32
// Specifies that you want to receive the next page of results. Valid only if you
// received a NextToken response in the previous request. If you did, it indicates
// that more output is available. Set this parameter to the value provided by the
// previous call's NextToken response to request the next page of results.
NextToken *string
// Specifies the ID of the principal whose resource shares you want to retrieve.
// This can be an Amazon Web Services account ID, an organization ID, an
// organizational unit ID, or the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of an individual IAM user or role. You cannot specify this parameter if the
// association type is RESOURCE .
Principal *string
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of a resource whose resource shares you want to retrieve. You cannot specify
// this parameter if the association type is PRINCIPAL .
ResourceArn *string
// Specifies a list of Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the resource share whose associations you want to retrieve.
ResourceShareArns []string
noSmithyDocumentSerde
}
type GetResourceShareAssociationsOutput struct {
// If present, this value indicates that more output is available than is included
// in the current response. Use this value in the NextToken request parameter in a
// subsequent call to the operation to get the next part of the output. You should
// repeat this until the NextToken response element comes back as null . This
// indicates that this is the last page of results.
NextToken *string
// An array of objects that contain the details about the associations.
ResourceShareAssociations []types.ResourceShareAssociation
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetResourceShareAssociationsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetResourceShareAssociations{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetResourceShareAssociations{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpGetResourceShareAssociationsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetResourceShareAssociations(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// GetResourceShareAssociationsAPIClient is a client that implements the
// GetResourceShareAssociations operation.
type GetResourceShareAssociationsAPIClient interface {
GetResourceShareAssociations(context.Context, *GetResourceShareAssociationsInput, ...func(*Options)) (*GetResourceShareAssociationsOutput, error)
}
var _ GetResourceShareAssociationsAPIClient = (*Client)(nil)
// GetResourceShareAssociationsPaginatorOptions is the paginator options for
// GetResourceShareAssociations
type GetResourceShareAssociationsPaginatorOptions struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// GetResourceShareAssociationsPaginator is a paginator for
// GetResourceShareAssociations
type GetResourceShareAssociationsPaginator struct {
options GetResourceShareAssociationsPaginatorOptions
client GetResourceShareAssociationsAPIClient
params *GetResourceShareAssociationsInput
nextToken *string
firstPage bool
}
// NewGetResourceShareAssociationsPaginator returns a new
// GetResourceShareAssociationsPaginator
func NewGetResourceShareAssociationsPaginator(client GetResourceShareAssociationsAPIClient, params *GetResourceShareAssociationsInput, optFns ...func(*GetResourceShareAssociationsPaginatorOptions)) *GetResourceShareAssociationsPaginator {
if params == nil {
params = &GetResourceShareAssociationsInput{}
}
options := GetResourceShareAssociationsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &GetResourceShareAssociationsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *GetResourceShareAssociationsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next GetResourceShareAssociations page.
func (p *GetResourceShareAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceShareAssociationsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.GetResourceShareAssociations(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opGetResourceShareAssociations(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "GetResourceShareAssociations",
}
}
| 274 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Retrieves details about invitations that you have received for resource shares.
func (c *Client) GetResourceShareInvitations(ctx context.Context, params *GetResourceShareInvitationsInput, optFns ...func(*Options)) (*GetResourceShareInvitationsOutput, error) {
if params == nil {
params = &GetResourceShareInvitationsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetResourceShareInvitations", params, optFns, c.addOperationGetResourceShareInvitationsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetResourceShareInvitationsOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetResourceShareInvitationsInput struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
MaxResults *int32
// Specifies that you want to receive the next page of results. Valid only if you
// received a NextToken response in the previous request. If you did, it indicates
// that more output is available. Set this parameter to the value provided by the
// previous call's NextToken response to request the next page of results.
NextToken *string
// Specifies that you want details about invitations only for the resource shares
// described by this list of Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
ResourceShareArns []string
// Specifies the Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the resource share invitations you want information about.
ResourceShareInvitationArns []string
noSmithyDocumentSerde
}
type GetResourceShareInvitationsOutput struct {
// If present, this value indicates that more output is available than is included
// in the current response. Use this value in the NextToken request parameter in a
// subsequent call to the operation to get the next part of the output. You should
// repeat this until the NextToken response element comes back as null . This
// indicates that this is the last page of results.
NextToken *string
// An array of objects that contain the details about the invitations.
ResourceShareInvitations []types.ResourceShareInvitation
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetResourceShareInvitationsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetResourceShareInvitations{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetResourceShareInvitations{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetResourceShareInvitations(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// GetResourceShareInvitationsAPIClient is a client that implements the
// GetResourceShareInvitations operation.
type GetResourceShareInvitationsAPIClient interface {
GetResourceShareInvitations(context.Context, *GetResourceShareInvitationsInput, ...func(*Options)) (*GetResourceShareInvitationsOutput, error)
}
var _ GetResourceShareInvitationsAPIClient = (*Client)(nil)
// GetResourceShareInvitationsPaginatorOptions is the paginator options for
// GetResourceShareInvitations
type GetResourceShareInvitationsPaginatorOptions struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// GetResourceShareInvitationsPaginator is a paginator for
// GetResourceShareInvitations
type GetResourceShareInvitationsPaginator struct {
options GetResourceShareInvitationsPaginatorOptions
client GetResourceShareInvitationsAPIClient
params *GetResourceShareInvitationsInput
nextToken *string
firstPage bool
}
// NewGetResourceShareInvitationsPaginator returns a new
// GetResourceShareInvitationsPaginator
func NewGetResourceShareInvitationsPaginator(client GetResourceShareInvitationsAPIClient, params *GetResourceShareInvitationsInput, optFns ...func(*GetResourceShareInvitationsPaginatorOptions)) *GetResourceShareInvitationsPaginator {
if params == nil {
params = &GetResourceShareInvitationsInput{}
}
options := GetResourceShareInvitationsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &GetResourceShareInvitationsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *GetResourceShareInvitationsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next GetResourceShareInvitations page.
func (p *GetResourceShareInvitationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceShareInvitationsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.GetResourceShareInvitations(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opGetResourceShareInvitations(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "GetResourceShareInvitations",
}
}
| 251 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Retrieves details about the resource shares that you own or that are shared
// with you.
func (c *Client) GetResourceShares(ctx context.Context, params *GetResourceSharesInput, optFns ...func(*Options)) (*GetResourceSharesOutput, error) {
if params == nil {
params = &GetResourceSharesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "GetResourceShares", params, optFns, c.addOperationGetResourceSharesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*GetResourceSharesOutput)
out.ResultMetadata = metadata
return out, nil
}
type GetResourceSharesInput struct {
// Specifies that you want to retrieve details of only those resource shares that
// match the following:
// - SELF – resource shares that your account shares with other accounts
// - OTHER-ACCOUNTS – resource shares that other accounts share with your account
//
// This member is required.
ResourceOwner types.ResourceOwner
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
MaxResults *int32
// Specifies the name of an individual resource share that you want to retrieve
// details about.
Name *string
// Specifies that you want to receive the next page of results. Valid only if you
// received a NextToken response in the previous request. If you did, it indicates
// that more output is available. Set this parameter to the value provided by the
// previous call's NextToken response to request the next page of results.
NextToken *string
// Specifies that you want to retrieve details of only those resource shares that
// use the managed permission with this Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// .
PermissionArn *string
// Specifies that you want to retrieve details for only those resource shares that
// use the specified version of the managed permission.
PermissionVersion *int32
// Specifies the Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of individual resource shares that you want information about.
ResourceShareArns []string
// Specifies that you want to retrieve details of only those resource shares that
// have this status.
ResourceShareStatus types.ResourceShareStatus
// Specifies that you want to retrieve details of only those resource shares that
// match the specified tag keys and values.
TagFilters []types.TagFilter
noSmithyDocumentSerde
}
type GetResourceSharesOutput struct {
// If present, this value indicates that more output is available than is included
// in the current response. Use this value in the NextToken request parameter in a
// subsequent call to the operation to get the next part of the output. You should
// repeat this until the NextToken response element comes back as null . This
// indicates that this is the last page of results.
NextToken *string
// An array of objects that contain the information about the resource shares.
ResourceShares []types.ResourceShare
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationGetResourceSharesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpGetResourceShares{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetResourceShares{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpGetResourceSharesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetResourceShares(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// GetResourceSharesAPIClient is a client that implements the GetResourceShares
// operation.
type GetResourceSharesAPIClient interface {
GetResourceShares(context.Context, *GetResourceSharesInput, ...func(*Options)) (*GetResourceSharesOutput, error)
}
var _ GetResourceSharesAPIClient = (*Client)(nil)
// GetResourceSharesPaginatorOptions is the paginator options for GetResourceShares
type GetResourceSharesPaginatorOptions struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// GetResourceSharesPaginator is a paginator for GetResourceShares
type GetResourceSharesPaginator struct {
options GetResourceSharesPaginatorOptions
client GetResourceSharesAPIClient
params *GetResourceSharesInput
nextToken *string
firstPage bool
}
// NewGetResourceSharesPaginator returns a new GetResourceSharesPaginator
func NewGetResourceSharesPaginator(client GetResourceSharesAPIClient, params *GetResourceSharesInput, optFns ...func(*GetResourceSharesPaginatorOptions)) *GetResourceSharesPaginator {
if params == nil {
params = &GetResourceSharesInput{}
}
options := GetResourceSharesPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &GetResourceSharesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *GetResourceSharesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next GetResourceShares page.
func (p *GetResourceSharesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetResourceSharesOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.GetResourceShares(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opGetResourceShares(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "GetResourceShares",
}
}
| 277 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists the resources in a resource share that is shared with you but for which
// the invitation is still PENDING . That means that you haven't accepted or
// rejected the invitation and the invitation hasn't expired.
func (c *Client) ListPendingInvitationResources(ctx context.Context, params *ListPendingInvitationResourcesInput, optFns ...func(*Options)) (*ListPendingInvitationResourcesOutput, error) {
if params == nil {
params = &ListPendingInvitationResourcesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListPendingInvitationResources", params, optFns, c.addOperationListPendingInvitationResourcesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListPendingInvitationResourcesOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListPendingInvitationResourcesInput struct {
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the invitation. You can use GetResourceShareInvitations to find the ARN of
// the invitation.
//
// This member is required.
ResourceShareInvitationArn *string
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
MaxResults *int32
// Specifies that you want to receive the next page of results. Valid only if you
// received a NextToken response in the previous request. If you did, it indicates
// that more output is available. Set this parameter to the value provided by the
// previous call's NextToken response to request the next page of results.
NextToken *string
// Specifies that you want the results to include only resources that have the
// specified scope.
// - ALL – the results include both global and regional resources or resource
// types.
// - GLOBAL – the results include only global resources or resource types.
// - REGIONAL – the results include only regional resources or resource types.
// The default value is ALL .
ResourceRegionScope types.ResourceRegionScopeFilter
noSmithyDocumentSerde
}
type ListPendingInvitationResourcesOutput struct {
// If present, this value indicates that more output is available than is included
// in the current response. Use this value in the NextToken request parameter in a
// subsequent call to the operation to get the next part of the output. You should
// repeat this until the NextToken response element comes back as null . This
// indicates that this is the last page of results.
NextToken *string
// An array of objects that contain the information about the resources included
// the specified resource share.
Resources []types.Resource
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListPendingInvitationResourcesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListPendingInvitationResources{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListPendingInvitationResources{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListPendingInvitationResourcesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListPendingInvitationResources(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListPendingInvitationResourcesAPIClient is a client that implements the
// ListPendingInvitationResources operation.
type ListPendingInvitationResourcesAPIClient interface {
ListPendingInvitationResources(context.Context, *ListPendingInvitationResourcesInput, ...func(*Options)) (*ListPendingInvitationResourcesOutput, error)
}
var _ ListPendingInvitationResourcesAPIClient = (*Client)(nil)
// ListPendingInvitationResourcesPaginatorOptions is the paginator options for
// ListPendingInvitationResources
type ListPendingInvitationResourcesPaginatorOptions struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListPendingInvitationResourcesPaginator is a paginator for
// ListPendingInvitationResources
type ListPendingInvitationResourcesPaginator struct {
options ListPendingInvitationResourcesPaginatorOptions
client ListPendingInvitationResourcesAPIClient
params *ListPendingInvitationResourcesInput
nextToken *string
firstPage bool
}
// NewListPendingInvitationResourcesPaginator returns a new
// ListPendingInvitationResourcesPaginator
func NewListPendingInvitationResourcesPaginator(client ListPendingInvitationResourcesAPIClient, params *ListPendingInvitationResourcesInput, optFns ...func(*ListPendingInvitationResourcesPaginatorOptions)) *ListPendingInvitationResourcesPaginator {
if params == nil {
params = &ListPendingInvitationResourcesInput{}
}
options := ListPendingInvitationResourcesPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListPendingInvitationResourcesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListPendingInvitationResourcesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListPendingInvitationResources page.
func (p *ListPendingInvitationResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPendingInvitationResourcesOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListPendingInvitationResources(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListPendingInvitationResources(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "ListPendingInvitationResources",
}
}
| 265 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists information about the managed permission and its associations to any
// resource shares that use this managed permission. This lets you see which
// resource shares use which versions of the specified managed permission.
func (c *Client) ListPermissionAssociations(ctx context.Context, params *ListPermissionAssociationsInput, optFns ...func(*Options)) (*ListPermissionAssociationsOutput, error) {
if params == nil {
params = &ListPermissionAssociationsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListPermissionAssociations", params, optFns, c.addOperationListPermissionAssociationsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListPermissionAssociationsOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListPermissionAssociationsInput struct {
// Specifies that you want to list only those associations with resource shares
// that match this status.
AssociationStatus types.ResourceShareAssociationStatus
// When true , specifies that you want to list only those associations with
// resource shares that use the default version of the specified managed
// permission. When false (the default value), lists associations with resource
// shares that use any version of the specified managed permission.
DefaultVersion *bool
// Specifies that you want to list only those associations with resource shares
// that have a featureSet with this value.
FeatureSet types.PermissionFeatureSet
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
MaxResults *int32
// Specifies that you want to receive the next page of results. Valid only if you
// received a NextToken response in the previous request. If you did, it indicates
// that more output is available. Set this parameter to the value provided by the
// previous call's NextToken response to request the next page of results.
NextToken *string
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the managed permission.
PermissionArn *string
// Specifies that you want to list only those associations with resource shares
// that use this version of the managed permission. If you don't provide a value
// for this parameter, then the operation returns information about associations
// with resource shares that use any version of the managed permission.
PermissionVersion *int32
// Specifies that you want to list only those associations with resource shares
// that include at least one resource of this resource type.
ResourceType *string
noSmithyDocumentSerde
}
type ListPermissionAssociationsOutput struct {
// If present, this value indicates that more output is available than is included
// in the current response. Use this value in the NextToken request parameter in a
// subsequent call to the operation to get the next part of the output. You should
// repeat this until the NextToken response element comes back as null . This
// indicates that this is the last page of results.
NextToken *string
// A structure with information about this customer managed permission.
Permissions []types.AssociatedPermission
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListPermissionAssociationsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListPermissionAssociations{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListPermissionAssociations{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListPermissionAssociations(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListPermissionAssociationsAPIClient is a client that implements the
// ListPermissionAssociations operation.
type ListPermissionAssociationsAPIClient interface {
ListPermissionAssociations(context.Context, *ListPermissionAssociationsInput, ...func(*Options)) (*ListPermissionAssociationsOutput, error)
}
var _ ListPermissionAssociationsAPIClient = (*Client)(nil)
// ListPermissionAssociationsPaginatorOptions is the paginator options for
// ListPermissionAssociations
type ListPermissionAssociationsPaginatorOptions struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListPermissionAssociationsPaginator is a paginator for
// ListPermissionAssociations
type ListPermissionAssociationsPaginator struct {
options ListPermissionAssociationsPaginatorOptions
client ListPermissionAssociationsAPIClient
params *ListPermissionAssociationsInput
nextToken *string
firstPage bool
}
// NewListPermissionAssociationsPaginator returns a new
// ListPermissionAssociationsPaginator
func NewListPermissionAssociationsPaginator(client ListPermissionAssociationsAPIClient, params *ListPermissionAssociationsInput, optFns ...func(*ListPermissionAssociationsPaginatorOptions)) *ListPermissionAssociationsPaginator {
if params == nil {
params = &ListPermissionAssociationsInput{}
}
options := ListPermissionAssociationsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListPermissionAssociationsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListPermissionAssociationsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListPermissionAssociations page.
func (p *ListPermissionAssociationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPermissionAssociationsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListPermissionAssociations(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListPermissionAssociations(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "ListPermissionAssociations",
}
}
| 273 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Retrieves a list of available RAM permissions that you can use for the
// supported resource types.
func (c *Client) ListPermissions(ctx context.Context, params *ListPermissionsInput, optFns ...func(*Options)) (*ListPermissionsOutput, error) {
if params == nil {
params = &ListPermissionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListPermissions", params, optFns, c.addOperationListPermissionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListPermissionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListPermissionsInput struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
MaxResults *int32
// Specifies that you want to receive the next page of results. Valid only if you
// received a NextToken response in the previous request. If you did, it indicates
// that more output is available. Set this parameter to the value provided by the
// previous call's NextToken response to request the next page of results.
NextToken *string
// Specifies that you want to list only permissions of this type:
// - AWS – returns only Amazon Web Services managed permissions.
// - LOCAL – returns only customer managed permissions
// - ALL – returns both Amazon Web Services managed permissions and customer
// managed permissions.
// If you don't specify this parameter, the default is All .
PermissionType types.PermissionTypeFilter
// Specifies that you want to list only those permissions that apply to the
// specified resource type. This parameter is not case sensitive. For example, to
// list only permissions that apply to Amazon EC2 subnets, specify ec2:subnet . You
// can use the ListResourceTypes operation to get the specific string required.
ResourceType *string
noSmithyDocumentSerde
}
type ListPermissionsOutput struct {
// If present, this value indicates that more output is available than is included
// in the current response. Use this value in the NextToken request parameter in a
// subsequent call to the operation to get the next part of the output. You should
// repeat this until the NextToken response element comes back as null . This
// indicates that this is the last page of results.
NextToken *string
// An array of objects with information about the permissions.
Permissions []types.ResourceSharePermissionSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListPermissionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListPermissions{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListPermissions{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListPermissions(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListPermissionsAPIClient is a client that implements the ListPermissions
// operation.
type ListPermissionsAPIClient interface {
ListPermissions(context.Context, *ListPermissionsInput, ...func(*Options)) (*ListPermissionsOutput, error)
}
var _ ListPermissionsAPIClient = (*Client)(nil)
// ListPermissionsPaginatorOptions is the paginator options for ListPermissions
type ListPermissionsPaginatorOptions struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListPermissionsPaginator is a paginator for ListPermissions
type ListPermissionsPaginator struct {
options ListPermissionsPaginatorOptions
client ListPermissionsAPIClient
params *ListPermissionsInput
nextToken *string
firstPage bool
}
// NewListPermissionsPaginator returns a new ListPermissionsPaginator
func NewListPermissionsPaginator(client ListPermissionsAPIClient, params *ListPermissionsInput, optFns ...func(*ListPermissionsPaginatorOptions)) *ListPermissionsPaginator {
if params == nil {
params = &ListPermissionsInput{}
}
options := ListPermissionsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListPermissionsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListPermissionsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListPermissions page.
func (p *ListPermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPermissionsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListPermissions(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListPermissions(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "ListPermissions",
}
}
| 255 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists the available versions of the specified RAM permission.
func (c *Client) ListPermissionVersions(ctx context.Context, params *ListPermissionVersionsInput, optFns ...func(*Options)) (*ListPermissionVersionsOutput, error) {
if params == nil {
params = &ListPermissionVersionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListPermissionVersions", params, optFns, c.addOperationListPermissionVersionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListPermissionVersionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListPermissionVersionsInput struct {
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the RAM permission whose versions you want to list. You can use the
// permissionVersion parameter on the AssociateResourceSharePermission operation
// to specify a non-default version to attach.
//
// This member is required.
PermissionArn *string
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
MaxResults *int32
// Specifies that you want to receive the next page of results. Valid only if you
// received a NextToken response in the previous request. If you did, it indicates
// that more output is available. Set this parameter to the value provided by the
// previous call's NextToken response to request the next page of results.
NextToken *string
noSmithyDocumentSerde
}
type ListPermissionVersionsOutput struct {
// If present, this value indicates that more output is available than is included
// in the current response. Use this value in the NextToken request parameter in a
// subsequent call to the operation to get the next part of the output. You should
// repeat this until the NextToken response element comes back as null . This
// indicates that this is the last page of results.
NextToken *string
// An array of objects that contain details for each of the available versions.
Permissions []types.ResourceSharePermissionSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListPermissionVersionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListPermissionVersions{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListPermissionVersions{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListPermissionVersionsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListPermissionVersions(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListPermissionVersionsAPIClient is a client that implements the
// ListPermissionVersions operation.
type ListPermissionVersionsAPIClient interface {
ListPermissionVersions(context.Context, *ListPermissionVersionsInput, ...func(*Options)) (*ListPermissionVersionsOutput, error)
}
var _ ListPermissionVersionsAPIClient = (*Client)(nil)
// ListPermissionVersionsPaginatorOptions is the paginator options for
// ListPermissionVersions
type ListPermissionVersionsPaginatorOptions struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListPermissionVersionsPaginator is a paginator for ListPermissionVersions
type ListPermissionVersionsPaginator struct {
options ListPermissionVersionsPaginatorOptions
client ListPermissionVersionsAPIClient
params *ListPermissionVersionsInput
nextToken *string
firstPage bool
}
// NewListPermissionVersionsPaginator returns a new ListPermissionVersionsPaginator
func NewListPermissionVersionsPaginator(client ListPermissionVersionsAPIClient, params *ListPermissionVersionsInput, optFns ...func(*ListPermissionVersionsPaginatorOptions)) *ListPermissionVersionsPaginator {
if params == nil {
params = &ListPermissionVersionsInput{}
}
options := ListPermissionVersionsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListPermissionVersionsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListPermissionVersionsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListPermissionVersions page.
func (p *ListPermissionVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPermissionVersionsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListPermissionVersions(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListPermissionVersions(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "ListPermissionVersions",
}
}
| 252 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists the principals that you are sharing resources with or that are sharing
// resources with you.
func (c *Client) ListPrincipals(ctx context.Context, params *ListPrincipalsInput, optFns ...func(*Options)) (*ListPrincipalsOutput, error) {
if params == nil {
params = &ListPrincipalsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListPrincipals", params, optFns, c.addOperationListPrincipalsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListPrincipalsOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListPrincipalsInput struct {
// Specifies that you want to list information for only resource shares that match
// the following:
// - SELF – principals that your account is sharing resources with
// - OTHER-ACCOUNTS – principals that are sharing resources with your account
//
// This member is required.
ResourceOwner types.ResourceOwner
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
MaxResults *int32
// Specifies that you want to receive the next page of results. Valid only if you
// received a NextToken response in the previous request. If you did, it indicates
// that more output is available. Set this parameter to the value provided by the
// previous call's NextToken response to request the next page of results.
NextToken *string
// Specifies that you want to list information for only the listed principals. You
// can include the following values:
// - An Amazon Web Services account ID, for example: 123456789012
// - An Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of an organization in Organizations, for example:
// organizations::123456789012:organization/o-exampleorgid
// - An ARN of an organizational unit (OU) in Organizations, for example:
// organizations::123456789012:ou/o-exampleorgid/ou-examplerootid-exampleouid123
// - An ARN of an IAM role, for example: iam::123456789012:role/rolename
// - An ARN of an IAM user, for example: iam::123456789012user/username
// Not all resource types can be shared with IAM roles and users. For more
// information, see Sharing with IAM roles and users (https://docs.aws.amazon.com/ram/latest/userguide/permissions.html#permissions-rbp-supported-resource-types)
// in the Resource Access Manager User Guide.
Principals []string
// Specifies that you want to list principal information for the resource share
// with the specified Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// .
ResourceArn *string
// Specifies that you want to list information for only principals associated with
// the resource shares specified by a list the Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// .
ResourceShareArns []string
// Specifies that you want to list information for only principals associated with
// resource shares that include the specified resource type. For a list of valid
// values, query the ListResourceTypes operation.
ResourceType *string
noSmithyDocumentSerde
}
type ListPrincipalsOutput struct {
// If present, this value indicates that more output is available than is included
// in the current response. Use this value in the NextToken request parameter in a
// subsequent call to the operation to get the next part of the output. You should
// repeat this until the NextToken response element comes back as null . This
// indicates that this is the last page of results.
NextToken *string
// An array of objects that contain the details about the principals.
Principals []types.Principal
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListPrincipalsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListPrincipals{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListPrincipals{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListPrincipalsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListPrincipals(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListPrincipalsAPIClient is a client that implements the ListPrincipals
// operation.
type ListPrincipalsAPIClient interface {
ListPrincipals(context.Context, *ListPrincipalsInput, ...func(*Options)) (*ListPrincipalsOutput, error)
}
var _ ListPrincipalsAPIClient = (*Client)(nil)
// ListPrincipalsPaginatorOptions is the paginator options for ListPrincipals
type ListPrincipalsPaginatorOptions struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListPrincipalsPaginator is a paginator for ListPrincipals
type ListPrincipalsPaginator struct {
options ListPrincipalsPaginatorOptions
client ListPrincipalsAPIClient
params *ListPrincipalsInput
nextToken *string
firstPage bool
}
// NewListPrincipalsPaginator returns a new ListPrincipalsPaginator
func NewListPrincipalsPaginator(client ListPrincipalsAPIClient, params *ListPrincipalsInput, optFns ...func(*ListPrincipalsPaginatorOptions)) *ListPrincipalsPaginator {
if params == nil {
params = &ListPrincipalsInput{}
}
options := ListPrincipalsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListPrincipalsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListPrincipalsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListPrincipals page.
func (p *ListPrincipalsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPrincipalsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListPrincipals(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListPrincipals(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "ListPrincipals",
}
}
| 282 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Retrieves the current status of the asynchronous tasks performed by RAM when
// you perform the ReplacePermissionAssociationsWork operation.
func (c *Client) ListReplacePermissionAssociationsWork(ctx context.Context, params *ListReplacePermissionAssociationsWorkInput, optFns ...func(*Options)) (*ListReplacePermissionAssociationsWorkOutput, error) {
if params == nil {
params = &ListReplacePermissionAssociationsWorkInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListReplacePermissionAssociationsWork", params, optFns, c.addOperationListReplacePermissionAssociationsWorkMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListReplacePermissionAssociationsWorkOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListReplacePermissionAssociationsWorkInput struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
MaxResults *int32
// Specifies that you want to receive the next page of results. Valid only if you
// received a NextToken response in the previous request. If you did, it indicates
// that more output is available. Set this parameter to the value provided by the
// previous call's NextToken response to request the next page of results.
NextToken *string
// Specifies that you want to see only the details about requests with a status
// that matches this value.
Status types.ReplacePermissionAssociationsWorkStatus
// A list of IDs. These values come from the id field of the
// replacePermissionAssociationsWork structure returned by the
// ReplacePermissionAssociations operation.
WorkIds []string
noSmithyDocumentSerde
}
type ListReplacePermissionAssociationsWorkOutput struct {
// If present, this value indicates that more output is available than is included
// in the current response. Use this value in the NextToken request parameter in a
// subsequent call to the operation to get the next part of the output. You should
// repeat this until the NextToken response element comes back as null . This
// indicates that this is the last page of results.
NextToken *string
// An array of data structures that provide details of the matching work IDs.
ReplacePermissionAssociationsWorks []types.ReplacePermissionAssociationsWork
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListReplacePermissionAssociationsWorkMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListReplacePermissionAssociationsWork{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListReplacePermissionAssociationsWork{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListReplacePermissionAssociationsWork(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListReplacePermissionAssociationsWorkAPIClient is a client that implements the
// ListReplacePermissionAssociationsWork operation.
type ListReplacePermissionAssociationsWorkAPIClient interface {
ListReplacePermissionAssociationsWork(context.Context, *ListReplacePermissionAssociationsWorkInput, ...func(*Options)) (*ListReplacePermissionAssociationsWorkOutput, error)
}
var _ ListReplacePermissionAssociationsWorkAPIClient = (*Client)(nil)
// ListReplacePermissionAssociationsWorkPaginatorOptions is the paginator options
// for ListReplacePermissionAssociationsWork
type ListReplacePermissionAssociationsWorkPaginatorOptions struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListReplacePermissionAssociationsWorkPaginator is a paginator for
// ListReplacePermissionAssociationsWork
type ListReplacePermissionAssociationsWorkPaginator struct {
options ListReplacePermissionAssociationsWorkPaginatorOptions
client ListReplacePermissionAssociationsWorkAPIClient
params *ListReplacePermissionAssociationsWorkInput
nextToken *string
firstPage bool
}
// NewListReplacePermissionAssociationsWorkPaginator returns a new
// ListReplacePermissionAssociationsWorkPaginator
func NewListReplacePermissionAssociationsWorkPaginator(client ListReplacePermissionAssociationsWorkAPIClient, params *ListReplacePermissionAssociationsWorkInput, optFns ...func(*ListReplacePermissionAssociationsWorkPaginatorOptions)) *ListReplacePermissionAssociationsWorkPaginator {
if params == nil {
params = &ListReplacePermissionAssociationsWorkInput{}
}
options := ListReplacePermissionAssociationsWorkPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListReplacePermissionAssociationsWorkPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListReplacePermissionAssociationsWorkPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListReplacePermissionAssociationsWork page.
func (p *ListReplacePermissionAssociationsWorkPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListReplacePermissionAssociationsWorkOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListReplacePermissionAssociationsWork(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListReplacePermissionAssociationsWork(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "ListReplacePermissionAssociationsWork",
}
}
| 253 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists the resources that you added to a resource share or the resources that
// are shared with you.
func (c *Client) ListResources(ctx context.Context, params *ListResourcesInput, optFns ...func(*Options)) (*ListResourcesOutput, error) {
if params == nil {
params = &ListResourcesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListResources", params, optFns, c.addOperationListResourcesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListResourcesOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListResourcesInput struct {
// Specifies that you want to list only the resource shares that match the
// following:
// - SELF – resources that your account shares with other accounts
// - OTHER-ACCOUNTS – resources that other accounts share with your account
//
// This member is required.
ResourceOwner types.ResourceOwner
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
MaxResults *int32
// Specifies that you want to receive the next page of results. Valid only if you
// received a NextToken response in the previous request. If you did, it indicates
// that more output is available. Set this parameter to the value provided by the
// previous call's NextToken response to request the next page of results.
NextToken *string
// Specifies that you want to list only the resource shares that are associated
// with the specified principal.
Principal *string
// Specifies that you want to list only the resource shares that include resources
// with the specified Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// .
ResourceArns []string
// Specifies that you want the results to include only resources that have the
// specified scope.
// - ALL – the results include both global and regional resources or resource
// types.
// - GLOBAL – the results include only global resources or resource types.
// - REGIONAL – the results include only regional resources or resource types.
// The default value is ALL .
ResourceRegionScope types.ResourceRegionScopeFilter
// Specifies that you want to list only resources in the resource shares
// identified by the specified Amazon Resource Names (ARNs) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// .
ResourceShareArns []string
// Specifies that you want to list only the resource shares that include resources
// of the specified resource type. For valid values, query the ListResourceTypes
// operation.
ResourceType *string
noSmithyDocumentSerde
}
type ListResourcesOutput struct {
// If present, this value indicates that more output is available than is included
// in the current response. Use this value in the NextToken request parameter in a
// subsequent call to the operation to get the next part of the output. You should
// repeat this until the NextToken response element comes back as null . This
// indicates that this is the last page of results.
NextToken *string
// An array of objects that contain information about the resources.
Resources []types.Resource
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListResourcesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListResources{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListResources{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListResourcesValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListResources(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListResourcesAPIClient is a client that implements the ListResources operation.
type ListResourcesAPIClient interface {
ListResources(context.Context, *ListResourcesInput, ...func(*Options)) (*ListResourcesOutput, error)
}
var _ ListResourcesAPIClient = (*Client)(nil)
// ListResourcesPaginatorOptions is the paginator options for ListResources
type ListResourcesPaginatorOptions struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListResourcesPaginator is a paginator for ListResources
type ListResourcesPaginator struct {
options ListResourcesPaginatorOptions
client ListResourcesAPIClient
params *ListResourcesInput
nextToken *string
firstPage bool
}
// NewListResourcesPaginator returns a new ListResourcesPaginator
func NewListResourcesPaginator(client ListResourcesAPIClient, params *ListResourcesInput, optFns ...func(*ListResourcesPaginatorOptions)) *ListResourcesPaginator {
if params == nil {
params = &ListResourcesInput{}
}
options := ListResourcesPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListResourcesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListResourcesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListResources page.
func (p *ListResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourcesOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListResources(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListResources(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "ListResources",
}
}
| 279 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists the RAM permissions that are associated with a resource share.
func (c *Client) ListResourceSharePermissions(ctx context.Context, params *ListResourceSharePermissionsInput, optFns ...func(*Options)) (*ListResourceSharePermissionsOutput, error) {
if params == nil {
params = &ListResourceSharePermissionsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListResourceSharePermissions", params, optFns, c.addOperationListResourceSharePermissionsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListResourceSharePermissionsOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListResourceSharePermissionsInput struct {
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the resource share for which you want to retrieve the associated permissions.
//
// This member is required.
ResourceShareArn *string
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
MaxResults *int32
// Specifies that you want to receive the next page of results. Valid only if you
// received a NextToken response in the previous request. If you did, it indicates
// that more output is available. Set this parameter to the value provided by the
// previous call's NextToken response to request the next page of results.
NextToken *string
noSmithyDocumentSerde
}
type ListResourceSharePermissionsOutput struct {
// If present, this value indicates that more output is available than is included
// in the current response. Use this value in the NextToken request parameter in a
// subsequent call to the operation to get the next part of the output. You should
// repeat this until the NextToken response element comes back as null . This
// indicates that this is the last page of results.
NextToken *string
// An array of objects that describe the permissions associated with the resource
// share.
Permissions []types.ResourceSharePermissionSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListResourceSharePermissionsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListResourceSharePermissions{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListResourceSharePermissions{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpListResourceSharePermissionsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListResourceSharePermissions(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListResourceSharePermissionsAPIClient is a client that implements the
// ListResourceSharePermissions operation.
type ListResourceSharePermissionsAPIClient interface {
ListResourceSharePermissions(context.Context, *ListResourceSharePermissionsInput, ...func(*Options)) (*ListResourceSharePermissionsOutput, error)
}
var _ ListResourceSharePermissionsAPIClient = (*Client)(nil)
// ListResourceSharePermissionsPaginatorOptions is the paginator options for
// ListResourceSharePermissions
type ListResourceSharePermissionsPaginatorOptions struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListResourceSharePermissionsPaginator is a paginator for
// ListResourceSharePermissions
type ListResourceSharePermissionsPaginator struct {
options ListResourceSharePermissionsPaginatorOptions
client ListResourceSharePermissionsAPIClient
params *ListResourceSharePermissionsInput
nextToken *string
firstPage bool
}
// NewListResourceSharePermissionsPaginator returns a new
// ListResourceSharePermissionsPaginator
func NewListResourceSharePermissionsPaginator(client ListResourceSharePermissionsAPIClient, params *ListResourceSharePermissionsInput, optFns ...func(*ListResourceSharePermissionsPaginatorOptions)) *ListResourceSharePermissionsPaginator {
if params == nil {
params = &ListResourceSharePermissionsInput{}
}
options := ListResourceSharePermissionsPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListResourceSharePermissionsPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListResourceSharePermissionsPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListResourceSharePermissions page.
func (p *ListResourceSharePermissionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourceSharePermissionsOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListResourceSharePermissions(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListResourceSharePermissions(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "ListResourceSharePermissions",
}
}
| 253 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Lists the resource types that can be shared by RAM.
func (c *Client) ListResourceTypes(ctx context.Context, params *ListResourceTypesInput, optFns ...func(*Options)) (*ListResourceTypesOutput, error) {
if params == nil {
params = &ListResourceTypesInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ListResourceTypes", params, optFns, c.addOperationListResourceTypesMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ListResourceTypesOutput)
out.ResultMetadata = metadata
return out, nil
}
type ListResourceTypesInput struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
MaxResults *int32
// Specifies that you want to receive the next page of results. Valid only if you
// received a NextToken response in the previous request. If you did, it indicates
// that more output is available. Set this parameter to the value provided by the
// previous call's NextToken response to request the next page of results.
NextToken *string
// Specifies that you want the results to include only resources that have the
// specified scope.
// - ALL – the results include both global and regional resources or resource
// types.
// - GLOBAL – the results include only global resources or resource types.
// - REGIONAL – the results include only regional resources or resource types.
// The default value is ALL .
ResourceRegionScope types.ResourceRegionScopeFilter
noSmithyDocumentSerde
}
type ListResourceTypesOutput struct {
// If present, this value indicates that more output is available than is included
// in the current response. Use this value in the NextToken request parameter in a
// subsequent call to the operation to get the next part of the output. You should
// repeat this until the NextToken response element comes back as null . This
// indicates that this is the last page of results.
NextToken *string
// An array of objects that contain information about the resource types that can
// be shared using RAM.
ResourceTypes []types.ServiceNameAndResourceType
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationListResourceTypesMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpListResourceTypes{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListResourceTypes{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListResourceTypes(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// ListResourceTypesAPIClient is a client that implements the ListResourceTypes
// operation.
type ListResourceTypesAPIClient interface {
ListResourceTypes(context.Context, *ListResourceTypesInput, ...func(*Options)) (*ListResourceTypesOutput, error)
}
var _ ListResourceTypesAPIClient = (*Client)(nil)
// ListResourceTypesPaginatorOptions is the paginator options for ListResourceTypes
type ListResourceTypesPaginatorOptions struct {
// Specifies the total number of results that you want included on each page of
// the response. If you do not include this parameter, it defaults to a value that
// is specific to the operation. If additional items exist beyond the number you
// specify, the NextToken response element is returned with a value (not null).
// Include the specified value as the NextToken request parameter in the next call
// to the operation to get the next part of the results. Note that the service
// might return fewer results than the maximum even when there are more results
// available. You should check NextToken after every operation to ensure that you
// receive all of the results.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// ListResourceTypesPaginator is a paginator for ListResourceTypes
type ListResourceTypesPaginator struct {
options ListResourceTypesPaginatorOptions
client ListResourceTypesAPIClient
params *ListResourceTypesInput
nextToken *string
firstPage bool
}
// NewListResourceTypesPaginator returns a new ListResourceTypesPaginator
func NewListResourceTypesPaginator(client ListResourceTypesAPIClient, params *ListResourceTypesInput, optFns ...func(*ListResourceTypesPaginatorOptions)) *ListResourceTypesPaginator {
if params == nil {
params = &ListResourceTypesInput{}
}
options := ListResourceTypesPaginatorOptions{}
if params.MaxResults != nil {
options.Limit = *params.MaxResults
}
for _, fn := range optFns {
fn(&options)
}
return &ListResourceTypesPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.NextToken,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListResourceTypesPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next ListResourceTypes page.
func (p *ListResourceTypesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourceTypesOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.NextToken = p.nextToken
var limit *int32
if p.options.Limit > 0 {
limit = &p.options.Limit
}
params.MaxResults = limit
result, err := p.client.ListResourceTypes(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.NextToken
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opListResourceTypes(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "ListResourceTypes",
}
}
| 250 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// When you attach a resource-based policy to a resource, RAM automatically
// creates a resource share of featureSet = CREATED_FROM_POLICY with a managed
// permission that has the same IAM permissions as the original resource-based
// policy. However, this type of managed permission is visible to only the resource
// share owner, and the associated resource share can't be modified by using RAM.
// This operation creates a separate, fully manageable customer managed permission
// that has the same IAM permissions as the original resource-based policy. You can
// associate this customer managed permission to any resource shares. Before you
// use PromoteResourceShareCreatedFromPolicy , you should first run this operation
// to ensure that you have an appropriate customer managed permission that can be
// associated with the promoted resource share.
// - The original CREATED_FROM_POLICY policy isn't deleted, and resource shares
// using that original policy aren't automatically updated.
// - You can't modify a CREATED_FROM_POLICY resource share so you can't associate
// the new customer managed permission by using ReplacePermsissionAssociations .
// However, if you use PromoteResourceShareCreatedFromPolicy , that operation
// automatically associates the fully manageable customer managed permission to the
// newly promoted STANDARD resource share.
// - After you promote a resource share, if the original CREATED_FROM_POLICY
// managed permission has no other associations to A resource share, then RAM
// automatically deletes it.
func (c *Client) PromotePermissionCreatedFromPolicy(ctx context.Context, params *PromotePermissionCreatedFromPolicyInput, optFns ...func(*Options)) (*PromotePermissionCreatedFromPolicyOutput, error) {
if params == nil {
params = &PromotePermissionCreatedFromPolicyInput{}
}
result, metadata, err := c.invokeOperation(ctx, "PromotePermissionCreatedFromPolicy", params, optFns, c.addOperationPromotePermissionCreatedFromPolicyMiddlewares)
if err != nil {
return nil, err
}
out := result.(*PromotePermissionCreatedFromPolicyOutput)
out.ResultMetadata = metadata
return out, nil
}
type PromotePermissionCreatedFromPolicyInput struct {
// Specifies a name for the promoted customer managed permission.
//
// This member is required.
Name *string
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the CREATED_FROM_POLICY permission that you want to promote. You can get
// this Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// by calling the ListResourceSharePermissions operation.
//
// This member is required.
PermissionArn *string
// Specifies a unique, case-sensitive identifier that you provide to ensure the
// idempotency of the request. This lets you safely retry the request without
// accidentally performing the same operation a second time. Passing the same value
// to a later call to an operation requires that you also pass the same value for
// all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier)
// . If you don't provide this value, then Amazon Web Services generates a random
// one for you. If you retry the operation with the same ClientToken , but with
// different parameters, the retry fails with an IdempotentParameterMismatch error.
ClientToken *string
noSmithyDocumentSerde
}
type PromotePermissionCreatedFromPolicyOutput struct {
// The idempotency identifier associated with this request. If you want to repeat
// the same operation in an idempotent manner then you must include this value in
// the clientToken request parameter of that later call. All other parameters must
// also have the same values that you used in the first call.
ClientToken *string
// Information about an RAM permission.
Permission *types.ResourceSharePermissionSummary
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationPromotePermissionCreatedFromPolicyMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpPromotePermissionCreatedFromPolicy{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpPromotePermissionCreatedFromPolicy{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpPromotePermissionCreatedFromPolicyValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opPromotePermissionCreatedFromPolicy(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opPromotePermissionCreatedFromPolicy(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "PromotePermissionCreatedFromPolicy",
}
}
| 169 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// When you attach a resource-based policy to a resource, RAM automatically
// creates a resource share of featureSet = CREATED_FROM_POLICY with a managed
// permission that has the same IAM permissions as the original resource-based
// policy. However, this type of managed permission is visible to only the resource
// share owner, and the associated resource share can't be modified by using RAM.
// This operation promotes the resource share to a STANDARD resource share that is
// fully manageable in RAM. When you promote a resource share, you can then manage
// the resource share in RAM and it becomes visible to all of the principals you
// shared it with. Before you perform this operation, you should first run
// PromotePermissionCreatedFromPolicy to ensure that you have an appropriate
// customer managed permission that can be associated with this resource share
// after its is promoted. If this operation can't find a managed permission that
// exactly matches the existing CREATED_FROM_POLICY permission, then this
// operation fails.
func (c *Client) PromoteResourceShareCreatedFromPolicy(ctx context.Context, params *PromoteResourceShareCreatedFromPolicyInput, optFns ...func(*Options)) (*PromoteResourceShareCreatedFromPolicyOutput, error) {
if params == nil {
params = &PromoteResourceShareCreatedFromPolicyInput{}
}
result, metadata, err := c.invokeOperation(ctx, "PromoteResourceShareCreatedFromPolicy", params, optFns, c.addOperationPromoteResourceShareCreatedFromPolicyMiddlewares)
if err != nil {
return nil, err
}
out := result.(*PromoteResourceShareCreatedFromPolicyOutput)
out.ResultMetadata = metadata
return out, nil
}
type PromoteResourceShareCreatedFromPolicyInput struct {
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the resource share to promote.
//
// This member is required.
ResourceShareArn *string
noSmithyDocumentSerde
}
type PromoteResourceShareCreatedFromPolicyOutput struct {
// A return value of true indicates that the request succeeded. A value of false
// indicates that the request failed.
ReturnValue *bool
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationPromoteResourceShareCreatedFromPolicyMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpPromoteResourceShareCreatedFromPolicy{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpPromoteResourceShareCreatedFromPolicy{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpPromoteResourceShareCreatedFromPolicyValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opPromoteResourceShareCreatedFromPolicy(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opPromoteResourceShareCreatedFromPolicy(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "PromoteResourceShareCreatedFromPolicy",
}
}
| 139 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Rejects an invitation to a resource share from another Amazon Web Services
// account.
func (c *Client) RejectResourceShareInvitation(ctx context.Context, params *RejectResourceShareInvitationInput, optFns ...func(*Options)) (*RejectResourceShareInvitationOutput, error) {
if params == nil {
params = &RejectResourceShareInvitationInput{}
}
result, metadata, err := c.invokeOperation(ctx, "RejectResourceShareInvitation", params, optFns, c.addOperationRejectResourceShareInvitationMiddlewares)
if err != nil {
return nil, err
}
out := result.(*RejectResourceShareInvitationOutput)
out.ResultMetadata = metadata
return out, nil
}
type RejectResourceShareInvitationInput struct {
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the invitation that you want to reject.
//
// This member is required.
ResourceShareInvitationArn *string
// Specifies a unique, case-sensitive identifier that you provide to ensure the
// idempotency of the request. This lets you safely retry the request without
// accidentally performing the same operation a second time. Passing the same value
// to a later call to an operation requires that you also pass the same value for
// all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier)
// . If you don't provide this value, then Amazon Web Services generates a random
// one for you. If you retry the operation with the same ClientToken , but with
// different parameters, the retry fails with an IdempotentParameterMismatch error.
ClientToken *string
noSmithyDocumentSerde
}
type RejectResourceShareInvitationOutput struct {
// The idempotency identifier associated with this request. If you want to repeat
// the same operation in an idempotent manner then you must include this value in
// the clientToken request parameter of that later call. All other parameters must
// also have the same values that you used in the first call.
ClientToken *string
// An object that contains the details about the rejected invitation.
ResourceShareInvitation *types.ResourceShareInvitation
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationRejectResourceShareInvitationMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpRejectResourceShareInvitation{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpRejectResourceShareInvitation{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpRejectResourceShareInvitationValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opRejectResourceShareInvitation(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opRejectResourceShareInvitation(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "RejectResourceShareInvitation",
}
}
| 143 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/ram/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Updates all resource shares that use a managed permission to a different
// managed permission. This operation always applies the default version of the
// target managed permission. You can optionally specify that the update applies to
// only resource shares that currently use a specified version. This enables you to
// update to the latest version, without changing the which managed permission is
// used. You can use this operation to update all of your resource shares to use
// the current default version of the permission by specifying the same value for
// the fromPermissionArn and toPermissionArn parameters. You can use the optional
// fromPermissionVersion parameter to update only those resources that use a
// specified version of the managed permission to the new managed permission. To
// successfully perform this operation, you must have permission to update the
// resource-based policy on all affected resource types.
func (c *Client) ReplacePermissionAssociations(ctx context.Context, params *ReplacePermissionAssociationsInput, optFns ...func(*Options)) (*ReplacePermissionAssociationsOutput, error) {
if params == nil {
params = &ReplacePermissionAssociationsInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ReplacePermissionAssociations", params, optFns, c.addOperationReplacePermissionAssociationsMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ReplacePermissionAssociationsOutput)
out.ResultMetadata = metadata
return out, nil
}
type ReplacePermissionAssociationsInput struct {
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the managed permission that you want to replace.
//
// This member is required.
FromPermissionArn *string
// Specifies the ARN of the managed permission that you want to associate with
// resource shares in place of the one specified by fromPerssionArn and
// fromPermissionVersion . The operation always associates the version that is
// currently the default for the specified managed permission.
//
// This member is required.
ToPermissionArn *string
// Specifies a unique, case-sensitive identifier that you provide to ensure the
// idempotency of the request. This lets you safely retry the request without
// accidentally performing the same operation a second time. Passing the same value
// to a later call to an operation requires that you also pass the same value for
// all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier)
// . If you don't provide this value, then Amazon Web Services generates a random
// one for you. If you retry the operation with the same ClientToken , but with
// different parameters, the retry fails with an IdempotentParameterMismatch error.
ClientToken *string
// Specifies that you want to updated the permissions for only those resource
// shares that use the specified version of the managed permission.
FromPermissionVersion *int32
noSmithyDocumentSerde
}
type ReplacePermissionAssociationsOutput struct {
// The idempotency identifier associated with this request. If you want to repeat
// the same operation in an idempotent manner then you must include this value in
// the clientToken request parameter of that later call. All other parameters must
// also have the same values that you used in the first call.
ClientToken *string
// Specifies a data structure that you can use to track the asynchronous tasks
// that RAM performs to complete this operation. You can use the
// ListReplacePermissionAssociationsWork operation and pass the id value returned
// in this structure.
ReplacePermissionAssociationsWork *types.ReplacePermissionAssociationsWork
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationReplacePermissionAssociationsMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpReplacePermissionAssociations{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpReplacePermissionAssociations{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpReplacePermissionAssociationsValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opReplacePermissionAssociations(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opReplacePermissionAssociations(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "ReplacePermissionAssociations",
}
}
| 168 |
aws-sdk-go-v2 | aws | Go | // Code generated by smithy-go-codegen DO NOT EDIT.
package ram
import (
"context"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Designates the specified version number as the default version for the
// specified customer managed permission. New resource shares automatically use
// this new default permission. Existing resource shares continue to use their
// original permission version, but you can use ReplacePermissionAssociations to
// update them.
func (c *Client) SetDefaultPermissionVersion(ctx context.Context, params *SetDefaultPermissionVersionInput, optFns ...func(*Options)) (*SetDefaultPermissionVersionOutput, error) {
if params == nil {
params = &SetDefaultPermissionVersionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "SetDefaultPermissionVersion", params, optFns, c.addOperationSetDefaultPermissionVersionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*SetDefaultPermissionVersionOutput)
out.ResultMetadata = metadata
return out, nil
}
type SetDefaultPermissionVersionInput struct {
// Specifies the Amazon Resource Name (ARN) (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
// of the customer managed permission whose default version you want to change.
//
// This member is required.
PermissionArn *string
// Specifies the version number that you want to designate as the default for
// customer managed permission. To see a list of all available version numbers, use
// ListPermissionVersions .
//
// This member is required.
PermissionVersion *int32
// Specifies a unique, case-sensitive identifier that you provide to ensure the
// idempotency of the request. This lets you safely retry the request without
// accidentally performing the same operation a second time. Passing the same value
// to a later call to an operation requires that you also pass the same value for
// all other parameters. We recommend that you use a UUID type of value. (https://wikipedia.org/wiki/Universally_unique_identifier)
// . If you don't provide this value, then Amazon Web Services generates a random
// one for you. If you retry the operation with the same ClientToken , but with
// different parameters, the retry fails with an IdempotentParameterMismatch error.
ClientToken *string
noSmithyDocumentSerde
}
type SetDefaultPermissionVersionOutput struct {
// The idempotency identifier associated with this request. If you want to repeat
// the same operation in an idempotent manner then you must include this value in
// the clientToken request parameter of that later call. All other parameters must
// also have the same values that you used in the first call.
ClientToken *string
// A boolean value that indicates whether the operation was successful.
ReturnValue *bool
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationSetDefaultPermissionVersionMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsRestjson1_serializeOpSetDefaultPermissionVersion{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsRestjson1_deserializeOpSetDefaultPermissionVersion{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpSetDefaultPermissionVersionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opSetDefaultPermissionVersion(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opSetDefaultPermissionVersion(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "ram",
OperationName: "SetDefaultPermissionVersion",
}
}
| 152 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.