quicksight

package
v1.99.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 10, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package quicksight provides the client and types for making API requests to Amazon QuickSight.

Amazon QuickSight is a fully managed, serverless, cloud business intelligence service that makes it easy to extend data and insights to every user in your organization. This API interface reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.

See https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01 for more information on this service.

See quicksight package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/quicksight/

Using the Client

To contact Amazon QuickSight with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon QuickSight client QuickSight for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/quicksight/#New

Index

Constants

View Source 
const (
	// ExceptionResourceTypeUser is a ExceptionResourceType enum value
	ExceptionResourceTypeUser = "USER"

	// ExceptionResourceTypeGroup is a ExceptionResourceType enum value
	ExceptionResourceTypeGroup = "GROUP"

	// ExceptionResourceTypeNamespace is a ExceptionResourceType enum value
	ExceptionResourceTypeNamespace = "NAMESPACE"

	// ExceptionResourceTypeDataSource is a ExceptionResourceType enum value
	ExceptionResourceTypeDataSource = "DATA_SOURCE"

	// ExceptionResourceTypeDataSet is a ExceptionResourceType enum value
	ExceptionResourceTypeDataSet = "DATA_SET"

	// ExceptionResourceTypeVpcConnection is a ExceptionResourceType enum value
	ExceptionResourceTypeVpcConnection = "VPC_CONNECTION"

	// ExceptionResourceTypeIngestion is a ExceptionResourceType enum value
	ExceptionResourceTypeIngestion = "INGESTION"
)
View Source 
const (
	// IdentityTypeIam is a IdentityType enum value
	IdentityTypeIam = "IAM"

	// IdentityTypeQuicksight is a IdentityType enum value
	IdentityTypeQuicksight = "QUICKSIGHT"
)
View Source 
const (
	// UserRoleAdmin is a UserRole enum value
	UserRoleAdmin = "ADMIN"

	// UserRoleAuthor is a UserRole enum value
	UserRoleAuthor = "AUTHOR"

	// UserRoleReader is a UserRole enum value
	UserRoleReader = "READER"

	// UserRoleRestrictedAuthor is a UserRole enum value
	UserRoleRestrictedAuthor = "RESTRICTED_AUTHOR"

	// UserRoleRestrictedReader is a UserRole enum value
	UserRoleRestrictedReader = "RESTRICTED_READER"
)
View Source 
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// You don't have access to this. The provided credentials couldn't be validated.
	// You might not be authorized to carry out the request. Ensure 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 access keys.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeDomainNotWhitelistedException for service response error code
	// "DomainNotWhitelistedException".
	//
	// The domain specified is not on the allowlist. All domains for embedded dashboards
	// must be added to the approved list by an Amazon QuickSight admin.
	ErrCodeDomainNotWhitelistedException = "DomainNotWhitelistedException"

	// ErrCodeIdentityTypeNotSupportedException for service response error code
	// "IdentityTypeNotSupportedException".
	//
	// The identity type specified is not supported. Supported identity types include
	// IAM and QUICKSIGHT.
	ErrCodeIdentityTypeNotSupportedException = "IdentityTypeNotSupportedException"

	// ErrCodeInternalFailureException for service response error code
	// "InternalFailureException".
	//
	// An internal failure occurred.
	ErrCodeInternalFailureException = "InternalFailureException"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// The NextToken value isn't valid.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeInvalidParameterValueException for service response error code
	// "InvalidParameterValueException".
	//
	// One or more parameters don't have a valid value.
	ErrCodeInvalidParameterValueException = "InvalidParameterValueException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// A limit is exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodePreconditionNotMetException for service response error code
	// "PreconditionNotMetException".
	//
	// One or more preconditions aren't met.
	ErrCodePreconditionNotMetException = "PreconditionNotMetException"

	// ErrCodeResourceExistsException for service response error code
	// "ResourceExistsException".
	//
	// The resource specified doesn't exist.
	ErrCodeResourceExistsException = "ResourceExistsException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// One or more resources can't be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeResourceUnavailableException for service response error code
	// "ResourceUnavailableException".
	//
	// This resource is currently unavailable.
	ErrCodeResourceUnavailableException = "ResourceUnavailableException"

	// ErrCodeSessionLifetimeInMinutesInvalidException for service response error code
	// "SessionLifetimeInMinutesInvalidException".
	//
	// The number of minutes specified for the lifetime of a session is not valid.
	// The session lifetime must be from 15 to 600 minutes.
	ErrCodeSessionLifetimeInMinutesInvalidException = "SessionLifetimeInMinutesInvalidException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// Access is throttled.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeUnsupportedUserEditionException for service response error code
	// "UnsupportedUserEditionException".
	//
	// 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 QuickSight currently has Standard Edition and Enterprise Edition.
	// Not every operation and capability is available in every edition.
	ErrCodeUnsupportedUserEditionException = "UnsupportedUserEditionException"

	// ErrCodeUserNotFoundException for service response error code
	// "QuickSightUserNotFoundException".
	//
	// The user is not 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.
	ErrCodeUserNotFoundException = "QuickSightUserNotFoundException"
)
View Source 
const (
	ServiceName = "QuickSight" // Name of service.
	EndpointsID = "quicksight" // ID to lookup a service endpoint with.
	ServiceID   = "QuickSight" // ServiceID is a unique identifer of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateGroupInput 

type CreateGroupInput struct {

	// The ID for the AWS account that the group is in. Currently, you use the ID
	// for the AWS account that contains your Amazon QuickSight account.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`

	// A description for the group that you want to create.
	Description *string `min:"1" type:"string"`

	// A name for the group that you want to create.
	//
	// GroupName is a required field
	GroupName *string `min:"1" type:"string" required:"true"`

	// The namespace. Currently, you should set this to default.
	//
	// Namespace is a required field
	Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The request object for this operation.

func (CreateGroupInput) GoString 

func (s CreateGroupInput) GoString() string

GoString returns the string representation

func (*CreateGroupInput) SetAwsAccountId 

func (s *CreateGroupInput) SetAwsAccountId(v string) *CreateGroupInput

SetAwsAccountId sets the AwsAccountId field's value.

func (*CreateGroupInput) SetDescription 

func (s *CreateGroupInput) SetDescription(v string) *CreateGroupInput

SetDescription sets the Description field's value.

func (*CreateGroupInput) SetGroupName 

func (s *CreateGroupInput) SetGroupName(v string) *CreateGroupInput

SetGroupName sets the GroupName field's value.

func (*CreateGroupInput) SetNamespace 

func (s *CreateGroupInput) SetNamespace(v string) *CreateGroupInput

SetNamespace sets the Namespace field's value.

func (CreateGroupInput) String 

func (s CreateGroupInput) String() string

String returns the string representation

func (*CreateGroupInput) Validate 

func (s *CreateGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateGroupMembershipInput 

type CreateGroupMembershipInput struct {

	// The ID for the AWS account that the group is in. Currently, you use the ID
	// for the AWS account that contains your Amazon QuickSight account.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`

	// The name of the group that you want to add the user to.
	//
	// GroupName is a required field
	GroupName *string `location:"uri" locationName:"GroupName" min:"1" type:"string" required:"true"`

	// The name of the user that you want to add to the group membership.
	//
	// MemberName is a required field
	MemberName *string `location:"uri" locationName:"MemberName" min:"1" type:"string" required:"true"`

	// The namespace. Currently, you should set this to default.
	//
	// Namespace is a required field
	Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateGroupMembershipInput) GoString 

func (s CreateGroupMembershipInput) GoString() string

GoString returns the string representation

func (*CreateGroupMembershipInput) SetAwsAccountId 

func (s *CreateGroupMembershipInput) SetAwsAccountId(v string) *CreateGroupMembershipInput

SetAwsAccountId sets the AwsAccountId field's value.

func (*CreateGroupMembershipInput) SetGroupName 

func (s *CreateGroupMembershipInput) SetGroupName(v string) *CreateGroupMembershipInput

SetGroupName sets the GroupName field's value.

func (*CreateGroupMembershipInput) SetMemberName 

func (s *CreateGroupMembershipInput) SetMemberName(v string) *CreateGroupMembershipInput

SetMemberName sets the MemberName field's value.

func (*CreateGroupMembershipInput) SetNamespace 

func (s *CreateGroupMembershipInput) SetNamespace(v string) *CreateGroupMembershipInput

SetNamespace sets the Namespace field's value.

func (CreateGroupMembershipInput) String 

func (s CreateGroupMembershipInput) String() string

String returns the string representation

func (*CreateGroupMembershipInput) Validate 

func (s *CreateGroupMembershipInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateGroupMembershipOutput 

type CreateGroupMembershipOutput struct {

	// The group member.
	GroupMember *GroupMember `type:"structure"`

	// The AWS request ID for this operation.
	RequestId *string `type:"string"`

	// The http status of the request.
	Status *int64 `location:"statusCode" type:"integer"`
	// contains filtered or unexported fields
}

func (CreateGroupMembershipOutput) GoString 

func (s CreateGroupMembershipOutput) GoString() string

GoString returns the string representation

func (*CreateGroupMembershipOutput) SetGroupMember 

func (s *CreateGroupMembershipOutput) SetGroupMember(v *GroupMember) *CreateGroupMembershipOutput

SetGroupMember sets the GroupMember field's value.

func (*CreateGroupMembershipOutput) SetRequestId 

func (s *CreateGroupMembershipOutput) SetRequestId(v string) *CreateGroupMembershipOutput

SetRequestId sets the RequestId field's value.

func (*CreateGroupMembershipOutput) SetStatus 

func (s *CreateGroupMembershipOutput) SetStatus(v int64) *CreateGroupMembershipOutput

SetStatus sets the Status field's value.

func (CreateGroupMembershipOutput) String 

func (s CreateGroupMembershipOutput) String() string

String returns the string representation

type CreateGroupOutput 

type CreateGroupOutput struct {

	// The name of the group.
	Group *Group `type:"structure"`

	// The AWS request ID for this operation.
	RequestId *string `type:"string"`

	// The http status of the request.
	Status *int64 `location:"statusCode" type:"integer"`
	// contains filtered or unexported fields
}

The response object for this operation.

func (CreateGroupOutput) GoString 

func (s CreateGroupOutput) GoString() string

GoString returns the string representation

func (*CreateGroupOutput) SetGroup 

func (s *CreateGroupOutput) SetGroup(v *Group) *CreateGroupOutput

SetGroup sets the Group field's value.

func (*CreateGroupOutput) SetRequestId 

func (s *CreateGroupOutput) SetRequestId(v string) *CreateGroupOutput

SetRequestId sets the RequestId field's value.

func (*CreateGroupOutput) SetStatus 

func (s *CreateGroupOutput) SetStatus(v int64) *CreateGroupOutput

SetStatus sets the Status field's value.

func (CreateGroupOutput) String 

func (s CreateGroupOutput) String() string

String returns the string representation

type DeleteGroupInput 

type DeleteGroupInput struct {

	// The ID for the AWS account that the group is in. Currently, you use the ID
	// for the AWS account that contains your Amazon QuickSight account.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`

	// The name of the group that you want to delete.
	//
	// GroupName is a required field
	GroupName *string `location:"uri" locationName:"GroupName" min:"1" type:"string" required:"true"`

	// The namespace. Currently, you should set this to default.
	//
	// Namespace is a required field
	Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteGroupInput) GoString 

func (s DeleteGroupInput) GoString() string

GoString returns the string representation

func (*DeleteGroupInput) SetAwsAccountId 

func (s *DeleteGroupInput) SetAwsAccountId(v string) *DeleteGroupInput

SetAwsAccountId sets the AwsAccountId field's value.

func (*DeleteGroupInput) SetGroupName 

func (s *DeleteGroupInput) SetGroupName(v string) *DeleteGroupInput

SetGroupName sets the GroupName field's value.

func (*DeleteGroupInput) SetNamespace 

func (s *DeleteGroupInput) SetNamespace(v string) *DeleteGroupInput

SetNamespace sets the Namespace field's value.

func (DeleteGroupInput) String 

func (s DeleteGroupInput) String() string

String returns the string representation

func (*DeleteGroupInput) Validate 

func (s *DeleteGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteGroupMembershipInput 

type DeleteGroupMembershipInput struct {

	// The ID for the AWS account that the group is in. Currently, you use the ID
	// for the AWS account that contains your Amazon QuickSight account.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`

	// The name of the group that you want to delete the user from.
	//
	// GroupName is a required field
	GroupName *string `location:"uri" locationName:"GroupName" min:"1" type:"string" required:"true"`

	// The name of the user that you want to delete from the group membership.
	//
	// MemberName is a required field
	MemberName *string `location:"uri" locationName:"MemberName" min:"1" type:"string" required:"true"`

	// The namespace. Currently, you should set this to default.
	//
	// Namespace is a required field
	Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteGroupMembershipInput) GoString 

func (s DeleteGroupMembershipInput) GoString() string

GoString returns the string representation

func (*DeleteGroupMembershipInput) SetAwsAccountId 

func (s *DeleteGroupMembershipInput) SetAwsAccountId(v string) *DeleteGroupMembershipInput

SetAwsAccountId sets the AwsAccountId field's value.

func (*DeleteGroupMembershipInput) SetGroupName 

func (s *DeleteGroupMembershipInput) SetGroupName(v string) *DeleteGroupMembershipInput

SetGroupName sets the GroupName field's value.

func (*DeleteGroupMembershipInput) SetMemberName 

func (s *DeleteGroupMembershipInput) SetMemberName(v string) *DeleteGroupMembershipInput

SetMemberName sets the MemberName field's value.

func (*DeleteGroupMembershipInput) SetNamespace 

func (s *DeleteGroupMembershipInput) SetNamespace(v string) *DeleteGroupMembershipInput

SetNamespace sets the Namespace field's value.

func (DeleteGroupMembershipInput) String 

func (s DeleteGroupMembershipInput) String() string

String returns the string representation

func (*DeleteGroupMembershipInput) Validate 

func (s *DeleteGroupMembershipInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteGroupMembershipOutput 

type DeleteGroupMembershipOutput struct {

	// The AWS request ID for this operation.
	RequestId *string `type:"string"`

	// The http status of the request.
	Status *int64 `location:"statusCode" type:"integer"`
	// contains filtered or unexported fields
}

func (DeleteGroupMembershipOutput) GoString 

func (s DeleteGroupMembershipOutput) GoString() string

GoString returns the string representation

func (*DeleteGroupMembershipOutput) SetRequestId 

func (s *DeleteGroupMembershipOutput) SetRequestId(v string) *DeleteGroupMembershipOutput

SetRequestId sets the RequestId field's value.

func (*DeleteGroupMembershipOutput) SetStatus 

func (s *DeleteGroupMembershipOutput) SetStatus(v int64) *DeleteGroupMembershipOutput

SetStatus sets the Status field's value.

func (DeleteGroupMembershipOutput) String 

func (s DeleteGroupMembershipOutput) String() string

String returns the string representation

type DeleteGroupOutput 

type DeleteGroupOutput struct {

	// The AWS request ID for this operation.
	RequestId *string `type:"string"`

	// The http status of the request.
	Status *int64 `location:"statusCode" type:"integer"`
	// contains filtered or unexported fields
}

func (DeleteGroupOutput) GoString 

func (s DeleteGroupOutput) GoString() string

GoString returns the string representation

func (*DeleteGroupOutput) SetRequestId 

func (s *DeleteGroupOutput) SetRequestId(v string) *DeleteGroupOutput

SetRequestId sets the RequestId field's value.

func (*DeleteGroupOutput) SetStatus 

func (s *DeleteGroupOutput) SetStatus(v int64) *DeleteGroupOutput

SetStatus sets the Status field's value.

func (DeleteGroupOutput) String 

func (s DeleteGroupOutput) String() string

String returns the string representation

type DeleteUserByPrincipalIdInput 

type DeleteUserByPrincipalIdInput struct {

	// The ID for the AWS account that the user is in. Currently, you use the ID
	// for the AWS account that contains your Amazon QuickSight account.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`

	// The namespace. Currently, you should set this to default.
	//
	// Namespace is a required field
	Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"`

	// The principal ID of the user.
	//
	// PrincipalId is a required field
	PrincipalId *string `location:"uri" locationName:"PrincipalId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteUserByPrincipalIdInput) GoString 

func (s DeleteUserByPrincipalIdInput) GoString() string

GoString returns the string representation

func (*DeleteUserByPrincipalIdInput) SetAwsAccountId 

func (s *DeleteUserByPrincipalIdInput) SetAwsAccountId(v string) *DeleteUserByPrincipalIdInput

SetAwsAccountId sets the AwsAccountId field's value.

func (*DeleteUserByPrincipalIdInput) SetNamespace 

func (s *DeleteUserByPrincipalIdInput) SetNamespace(v string) *DeleteUserByPrincipalIdInput

SetNamespace sets the Namespace field's value.

func (*DeleteUserByPrincipalIdInput) SetPrincipalId 

func (s *DeleteUserByPrincipalIdInput) SetPrincipalId(v string) *DeleteUserByPrincipalIdInput

SetPrincipalId sets the PrincipalId field's value.

func (DeleteUserByPrincipalIdInput) String 

func (s DeleteUserByPrincipalIdInput) String() string

String returns the string representation

func (*DeleteUserByPrincipalIdInput) Validate 

func (s *DeleteUserByPrincipalIdInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteUserByPrincipalIdOutput 

type DeleteUserByPrincipalIdOutput struct {

	// The AWS request ID for this operation.
	RequestId *string `type:"string"`

	// The http status of the request.
	Status *int64 `location:"statusCode" type:"integer"`
	// contains filtered or unexported fields
}

func (DeleteUserByPrincipalIdOutput) GoString 

func (s DeleteUserByPrincipalIdOutput) GoString() string

GoString returns the string representation

func (*DeleteUserByPrincipalIdOutput) SetRequestId 

func (s *DeleteUserByPrincipalIdOutput) SetRequestId(v string) *DeleteUserByPrincipalIdOutput

SetRequestId sets the RequestId field's value.

func (*DeleteUserByPrincipalIdOutput) SetStatus 

func (s *DeleteUserByPrincipalIdOutput) SetStatus(v int64) *DeleteUserByPrincipalIdOutput

SetStatus sets the Status field's value.

func (DeleteUserByPrincipalIdOutput) String 

func (s DeleteUserByPrincipalIdOutput) String() string

String returns the string representation

type DeleteUserInput 

type DeleteUserInput struct {

	// The ID for the AWS account that the user is in. Currently, you use the ID
	// for the AWS account that contains your Amazon QuickSight account.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`

	// The namespace. Currently, you should set this to default.
	//
	// Namespace is a required field
	Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"`

	// The name of the user that you want to delete.
	//
	// UserName is a required field
	UserName *string `location:"uri" locationName:"UserName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteUserInput) GoString 

func (s DeleteUserInput) GoString() string

GoString returns the string representation

func (*DeleteUserInput) SetAwsAccountId 

func (s *DeleteUserInput) SetAwsAccountId(v string) *DeleteUserInput

SetAwsAccountId sets the AwsAccountId field's value.

func (*DeleteUserInput) SetNamespace 

func (s *DeleteUserInput) SetNamespace(v string) *DeleteUserInput

SetNamespace sets the Namespace field's value.

func (*DeleteUserInput) SetUserName 

func (s *DeleteUserInput) SetUserName(v string) *DeleteUserInput

SetUserName sets the UserName field's value.

func (DeleteUserInput) String 

func (s DeleteUserInput) String() string

String returns the string representation

func (*DeleteUserInput) Validate 

func (s *DeleteUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteUserOutput 

type DeleteUserOutput struct {

	// The AWS request ID for this operation.
	RequestId *string `type:"string"`

	// The http status of the request.
	Status *int64 `location:"statusCode" type:"integer"`
	// contains filtered or unexported fields
}

func (DeleteUserOutput) GoString 

func (s DeleteUserOutput) GoString() string

GoString returns the string representation

func (*DeleteUserOutput) SetRequestId 

func (s *DeleteUserOutput) SetRequestId(v string) *DeleteUserOutput

SetRequestId sets the RequestId field's value.

func (*DeleteUserOutput) SetStatus 

func (s *DeleteUserOutput) SetStatus(v int64) *DeleteUserOutput

SetStatus sets the Status field's value.

func (DeleteUserOutput) String 

func (s DeleteUserOutput) String() string

String returns the string representation

type DescribeGroupInput 

type DescribeGroupInput struct {

	// The ID for the AWS account that the group is in. Currently, you use the ID
	// for the AWS account that contains your Amazon QuickSight account.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`

	// The name of the group that you want to describe.
	//
	// GroupName is a required field
	GroupName *string `location:"uri" locationName:"GroupName" min:"1" type:"string" required:"true"`

	// The namespace. Currently, you should set this to default.
	//
	// Namespace is a required field
	Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeGroupInput) GoString 

func (s DescribeGroupInput) GoString() string

GoString returns the string representation

func (*DescribeGroupInput) SetAwsAccountId 

func (s *DescribeGroupInput) SetAwsAccountId(v string) *DescribeGroupInput

SetAwsAccountId sets the AwsAccountId field's value.

func (*DescribeGroupInput) SetGroupName 

func (s *DescribeGroupInput) SetGroupName(v string) *DescribeGroupInput

SetGroupName sets the GroupName field's value.

func (*DescribeGroupInput) SetNamespace 

func (s *DescribeGroupInput) SetNamespace(v string) *DescribeGroupInput

SetNamespace sets the Namespace field's value.

func (DescribeGroupInput) String 

func (s DescribeGroupInput) String() string

String returns the string representation

func (*DescribeGroupInput) Validate 

func (s *DescribeGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeGroupOutput 

type DescribeGroupOutput struct {

	// The name of the group.
	Group *Group `type:"structure"`

	// The AWS request ID for this operation.
	RequestId *string `type:"string"`

	// The http status of the request.
	Status *int64 `location:"statusCode" type:"integer"`
	// contains filtered or unexported fields
}

func (DescribeGroupOutput) GoString 

func (s DescribeGroupOutput) GoString() string

GoString returns the string representation

func (*DescribeGroupOutput) SetGroup 

func (s *DescribeGroupOutput) SetGroup(v *Group) *DescribeGroupOutput

SetGroup sets the Group field's value.

func (*DescribeGroupOutput) SetRequestId 

func (s *DescribeGroupOutput) SetRequestId(v string) *DescribeGroupOutput

SetRequestId sets the RequestId field's value.

func (*DescribeGroupOutput) SetStatus 

func (s *DescribeGroupOutput) SetStatus(v int64) *DescribeGroupOutput

SetStatus sets the Status field's value.

func (DescribeGroupOutput) String 

func (s DescribeGroupOutput) String() string

String returns the string representation

type DescribeUserInput 

type DescribeUserInput struct {

	// The ID for the AWS account that the user is in. Currently, you use the ID
	// for the AWS account that contains your Amazon QuickSight account.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`

	// The namespace. Currently, you should set this to default.
	//
	// Namespace is a required field
	Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"`

	// The name of the user that you want to describe.
	//
	// UserName is a required field
	UserName *string `location:"uri" locationName:"UserName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeUserInput) GoString 

func (s DescribeUserInput) GoString() string

GoString returns the string representation

func (*DescribeUserInput) SetAwsAccountId 

func (s *DescribeUserInput) SetAwsAccountId(v string) *DescribeUserInput

SetAwsAccountId sets the AwsAccountId field's value.

func (*DescribeUserInput) SetNamespace 

func (s *DescribeUserInput) SetNamespace(v string) *DescribeUserInput

SetNamespace sets the Namespace field's value.

func (*DescribeUserInput) SetUserName 

func (s *DescribeUserInput) SetUserName(v string) *DescribeUserInput

SetUserName sets the UserName field's value.

func (DescribeUserInput) String 

func (s DescribeUserInput) String() string

String returns the string representation

func (*DescribeUserInput) Validate 

func (s *DescribeUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeUserOutput 

type DescribeUserOutput struct {

	// The AWS request ID for this operation.
	RequestId *string `type:"string"`

	// The http status of the request.
	Status *int64 `location:"statusCode" type:"integer"`

	// The user name.
	User *User `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeUserOutput) GoString 

func (s DescribeUserOutput) GoString() string

GoString returns the string representation

func (*DescribeUserOutput) SetRequestId 

func (s *DescribeUserOutput) SetRequestId(v string) *DescribeUserOutput

SetRequestId sets the RequestId field's value.

func (*DescribeUserOutput) SetStatus 

func (s *DescribeUserOutput) SetStatus(v int64) *DescribeUserOutput

SetStatus sets the Status field's value.

func (*DescribeUserOutput) SetUser 

func (s *DescribeUserOutput) SetUser(v *User) *DescribeUserOutput

SetUser sets the User field's value.

func (DescribeUserOutput) String 

func (s DescribeUserOutput) String() string

String returns the string representation

type GetDashboardEmbedUrlInput 

type GetDashboardEmbedUrlInput struct {

	// AWS account ID that contains the dashboard you are embedding.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`

	// The ID for the dashboard, also added to IAM policy
	//
	// DashboardId is a required field
	DashboardId *string `location:"uri" locationName:"DashboardId" type:"string" required:"true"`

	// The authentication method the user uses to sign in (IAM only).
	//
	// IdentityType is a required field
	IdentityType *string `location:"querystring" locationName:"creds-type" type:"string" required:"true" enum:"IdentityType"`

	// Remove the reset button on embedded dashboard. The default is FALSE, which
	// allows the reset button.
	ResetDisabled *bool `location:"querystring" locationName:"reset-disabled" type:"boolean"`

	// How many minutes the session is valid. The session lifetime must be between
	// 15 and 600 minutes.
	SessionLifetimeInMinutes *int64 `location:"querystring" locationName:"session-lifetime" min:"15" type:"long"`

	// Remove the undo/redo button on embedded dashboard. The default is FALSE,
	// which enables the undo/redo button.
	UndoRedoDisabled *bool `location:"querystring" locationName:"undo-redo-disabled" type:"boolean"`

	// The Amazon QuickSight user's ARN, for use with QUICKSIGHT identity type.
	// You can use this for any of the following:
	//
	//    * Amazon QuickSight users in your account (readers, authors, or admins)
	//
	//    * AD users
	//
	//    * Invited non-federated users
	//
	//    * Federated IAM users
	//
	//    * Federated IAM role-based sessions
	UserArn *string `location:"querystring" locationName:"user-arn" type:"string"`
	// contains filtered or unexported fields
}

func (GetDashboardEmbedUrlInput) GoString 

func (s GetDashboardEmbedUrlInput) GoString() string

GoString returns the string representation

func (*GetDashboardEmbedUrlInput) SetAwsAccountId 

func (s *GetDashboardEmbedUrlInput) SetAwsAccountId(v string) *GetDashboardEmbedUrlInput

SetAwsAccountId sets the AwsAccountId field's value.

func (*GetDashboardEmbedUrlInput) SetDashboardId 

func (s *GetDashboardEmbedUrlInput) SetDashboardId(v string) *GetDashboardEmbedUrlInput

SetDashboardId sets the DashboardId field's value.

func (*GetDashboardEmbedUrlInput) SetIdentityType 

func (s *GetDashboardEmbedUrlInput) SetIdentityType(v string) *GetDashboardEmbedUrlInput

SetIdentityType sets the IdentityType field's value.

func (*GetDashboardEmbedUrlInput) SetResetDisabled 

func (s *GetDashboardEmbedUrlInput) SetResetDisabled(v bool) *GetDashboardEmbedUrlInput

SetResetDisabled sets the ResetDisabled field's value.

func (*GetDashboardEmbedUrlInput) SetSessionLifetimeInMinutes 

func (s *GetDashboardEmbedUrlInput) SetSessionLifetimeInMinutes(v int64) *GetDashboardEmbedUrlInput

SetSessionLifetimeInMinutes sets the SessionLifetimeInMinutes field's value.

func (*GetDashboardEmbedUrlInput) SetUndoRedoDisabled 

func (s *GetDashboardEmbedUrlInput) SetUndoRedoDisabled(v bool) *GetDashboardEmbedUrlInput

SetUndoRedoDisabled sets the UndoRedoDisabled field's value.

func (*GetDashboardEmbedUrlInput) SetUserArn 

func (s *GetDashboardEmbedUrlInput) SetUserArn(v string) *GetDashboardEmbedUrlInput

SetUserArn sets the UserArn field's value.

func (GetDashboardEmbedUrlInput) String 

func (s GetDashboardEmbedUrlInput) String() string

String returns the string representation

func (*GetDashboardEmbedUrlInput) Validate 

func (s *GetDashboardEmbedUrlInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDashboardEmbedUrlOutput 

type GetDashboardEmbedUrlOutput struct {

	// URL that you can put into your server-side webpage to embed your dashboard.
	// This URL is valid for 5 minutes, and the resulting session is valid for 10
	// hours. The API provides the URL with an auth_code that enables a single-signon
	// session.
	EmbedUrl *string `type:"string" sensitive:"true"`

	// The AWS request ID for this operation.
	RequestId *string `type:"string"`

	// The http status of the request.
	Status *int64 `location:"statusCode" type:"integer"`
	// contains filtered or unexported fields
}

func (GetDashboardEmbedUrlOutput) GoString 

func (s GetDashboardEmbedUrlOutput) GoString() string

GoString returns the string representation

func (*GetDashboardEmbedUrlOutput) SetEmbedUrl 

func (s *GetDashboardEmbedUrlOutput) SetEmbedUrl(v string) *GetDashboardEmbedUrlOutput

SetEmbedUrl sets the EmbedUrl field's value.

func (*GetDashboardEmbedUrlOutput) SetRequestId 

func (s *GetDashboardEmbedUrlOutput) SetRequestId(v string) *GetDashboardEmbedUrlOutput

SetRequestId sets the RequestId field's value.

func (*GetDashboardEmbedUrlOutput) SetStatus 

func (s *GetDashboardEmbedUrlOutput) SetStatus(v int64) *GetDashboardEmbedUrlOutput

SetStatus sets the Status field's value.

func (GetDashboardEmbedUrlOutput) String 

func (s GetDashboardEmbedUrlOutput) String() string

String returns the string representation

type Group 

type Group struct {

	// The Amazon Resource Name (ARN) for the group.
	Arn *string `type:"string"`

	// The group description.
	Description *string `min:"1" type:"string"`

	// The name of the group.
	GroupName *string `min:"1" type:"string"`

	// The principal ID of the group.
	PrincipalId *string `type:"string"`
	// contains filtered or unexported fields
}

A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. Currently, an Amazon QuickSight subscription can't contain more than 500 Amazon QuickSight groups.

func (Group) GoString 

func (s Group) GoString() string

GoString returns the string representation

func (*Group) SetArn 

func (s *Group) SetArn(v string) *Group

SetArn sets the Arn field's value.

func (*Group) SetDescription 

func (s *Group) SetDescription(v string) *Group

SetDescription sets the Description field's value.

func (*Group) SetGroupName 

func (s *Group) SetGroupName(v string) *Group

SetGroupName sets the GroupName field's value.

func (*Group) SetPrincipalId 

func (s *Group) SetPrincipalId(v string) *Group

SetPrincipalId sets the PrincipalId field's value.

func (Group) String 

func (s Group) String() string

String returns the string representation

type GroupMember 

type GroupMember struct {

	// The Amazon Resource Name (ARN) for the group member (user).
	Arn *string `type:"string"`

	// The name of the group member (user).
	MemberName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A member of an Amazon QuickSight group. Currently, group members must be users. Groups can't be members of another group.

func (GroupMember) GoString 

func (s GroupMember) GoString() string

GoString returns the string representation

func (*GroupMember) SetArn 

func (s *GroupMember) SetArn(v string) *GroupMember

SetArn sets the Arn field's value.

func (*GroupMember) SetMemberName 

func (s *GroupMember) SetMemberName(v string) *GroupMember

SetMemberName sets the MemberName field's value.

func (GroupMember) String 

func (s GroupMember) String() string

String returns the string representation

type ListGroupMembershipsInput 

type ListGroupMembershipsInput struct {

	// The ID for the AWS account that the group is in. Currently, you use the ID
	// for the AWS account that contains your Amazon QuickSight account.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`

	// The name of the group that you want to see a membership list of.
	//
	// GroupName is a required field
	GroupName *string `location:"uri" locationName:"GroupName" min:"1" type:"string" required:"true"`

	// The maximum number of results to return from this request.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The namespace. Currently, you should set this to default.
	//
	// Namespace is a required field
	Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"`

	// A pagination token that can be used in a subsequent request.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`
	// contains filtered or unexported fields
}

func (ListGroupMembershipsInput) GoString 

func (s ListGroupMembershipsInput) GoString() string

GoString returns the string representation

func (*ListGroupMembershipsInput) SetAwsAccountId 

func (s *ListGroupMembershipsInput) SetAwsAccountId(v string) *ListGroupMembershipsInput

SetAwsAccountId sets the AwsAccountId field's value.

func (*ListGroupMembershipsInput) SetGroupName 

func (s *ListGroupMembershipsInput) SetGroupName(v string) *ListGroupMembershipsInput

SetGroupName sets the GroupName field's value.

func (*ListGroupMembershipsInput) SetMaxResults 

func (s *ListGroupMembershipsInput) SetMaxResults(v int64) *ListGroupMembershipsInput

SetMaxResults sets the MaxResults field's value.

func (*ListGroupMembershipsInput) SetNamespace 

func (s *ListGroupMembershipsInput) SetNamespace(v string) *ListGroupMembershipsInput

SetNamespace sets the Namespace field's value.

func (*ListGroupMembershipsInput) SetNextToken 

func (s *ListGroupMembershipsInput) SetNextToken(v string) *ListGroupMembershipsInput

SetNextToken sets the NextToken field's value.

func (ListGroupMembershipsInput) String 

func (s ListGroupMembershipsInput) String() string

String returns the string representation

func (*ListGroupMembershipsInput) Validate 

func (s *ListGroupMembershipsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListGroupMembershipsOutput 

type ListGroupMembershipsOutput struct {

	// The list of the members of the group.
	GroupMemberList []*GroupMember `type:"list"`

	// A pagination token that can be used in a subsequent request.
	NextToken *string `type:"string"`

	// The AWS request ID for this operation.
	RequestId *string `type:"string"`

	// The http status of the request.
	Status *int64 `location:"statusCode" type:"integer"`
	// contains filtered or unexported fields
}

func (ListGroupMembershipsOutput) GoString 

func (s ListGroupMembershipsOutput) GoString() string

GoString returns the string representation

func (*ListGroupMembershipsOutput) SetGroupMemberList 

func (s *ListGroupMembershipsOutput) SetGroupMemberList(v []*GroupMember) *ListGroupMembershipsOutput

SetGroupMemberList sets the GroupMemberList field's value.

func (*ListGroupMembershipsOutput) SetNextToken 

func (s *ListGroupMembershipsOutput) SetNextToken(v string) *ListGroupMembershipsOutput

SetNextToken sets the NextToken field's value.

func (*ListGroupMembershipsOutput) SetRequestId 

func (s *ListGroupMembershipsOutput) SetRequestId(v string) *ListGroupMembershipsOutput

SetRequestId sets the RequestId field's value.

func (*ListGroupMembershipsOutput) SetStatus 

func (s *ListGroupMembershipsOutput) SetStatus(v int64) *ListGroupMembershipsOutput

SetStatus sets the Status field's value.

func (ListGroupMembershipsOutput) String 

func (s ListGroupMembershipsOutput) String() string

String returns the string representation

type ListGroupsInput 

type ListGroupsInput struct {

	// The ID for the AWS account that the group is in. Currently, you use the ID
	// for the AWS account that contains your Amazon QuickSight account.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`

	// The maximum number of results to return.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The namespace. Currently, you should set this to default.
	//
	// Namespace is a required field
	Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"`

	// A pagination token that can be used in a subsequent request.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`
	// contains filtered or unexported fields
}

func (ListGroupsInput) GoString 

func (s ListGroupsInput) GoString() string

GoString returns the string representation

func (*ListGroupsInput) SetAwsAccountId 

func (s *ListGroupsInput) SetAwsAccountId(v string) *ListGroupsInput

SetAwsAccountId sets the AwsAccountId field's value.

func (*ListGroupsInput) SetMaxResults 

func (s *ListGroupsInput) SetMaxResults(v int64) *ListGroupsInput

SetMaxResults sets the MaxResults field's value.

func (*ListGroupsInput) SetNamespace 

func (s *ListGroupsInput) SetNamespace(v string) *ListGroupsInput

SetNamespace sets the Namespace field's value.

func (*ListGroupsInput) SetNextToken 

func (s *ListGroupsInput) SetNextToken(v string) *ListGroupsInput

SetNextToken sets the NextToken field's value.

func (ListGroupsInput) String 

func (s ListGroupsInput) String() string

String returns the string representation

func (*ListGroupsInput) Validate 

func (s *ListGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListGroupsOutput 

type ListGroupsOutput struct {

	// The list of the groups.
	GroupList []*Group `type:"list"`

	// A pagination token that can be used in a subsequent request.
	NextToken *string `type:"string"`

	// The AWS request ID for this operation.
	RequestId *string `type:"string"`

	// The http status of the request.
	Status *int64 `location:"statusCode" type:"integer"`
	// contains filtered or unexported fields
}

func (ListGroupsOutput) GoString 

func (s ListGroupsOutput) GoString() string

GoString returns the string representation

func (*ListGroupsOutput) SetGroupList 

func (s *ListGroupsOutput) SetGroupList(v []*Group) *ListGroupsOutput

SetGroupList sets the GroupList field's value.

func (*ListGroupsOutput) SetNextToken 

func (s *ListGroupsOutput) SetNextToken(v string) *ListGroupsOutput

SetNextToken sets the NextToken field's value.

func (*ListGroupsOutput) SetRequestId 

func (s *ListGroupsOutput) SetRequestId(v string) *ListGroupsOutput

SetRequestId sets the RequestId field's value.

func (*ListGroupsOutput) SetStatus 

func (s *ListGroupsOutput) SetStatus(v int64) *ListGroupsOutput

SetStatus sets the Status field's value.

func (ListGroupsOutput) String 

func (s ListGroupsOutput) String() string

String returns the string representation

type ListUserGroupsInput 

type ListUserGroupsInput struct {

	// The AWS Account ID that the user is in. Currently, you use the ID for the
	// AWS account that contains your Amazon QuickSight account.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`

	// The maximum number of results to return from this request.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The namespace. Currently, you should set this to default.
	//
	// Namespace is a required field
	Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"`

	// A pagination token that can be used in a subsequent request.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`

	// The Amazon QuickSight user name that you want to list group memberships for.
	//
	// UserName is a required field
	UserName *string `location:"uri" locationName:"UserName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListUserGroupsInput) GoString 

func (s ListUserGroupsInput) GoString() string

GoString returns the string representation

func (*ListUserGroupsInput) SetAwsAccountId 

func (s *ListUserGroupsInput) SetAwsAccountId(v string) *ListUserGroupsInput

SetAwsAccountId sets the AwsAccountId field's value.

func (*ListUserGroupsInput) SetMaxResults 

func (s *ListUserGroupsInput) SetMaxResults(v int64) *ListUserGroupsInput

SetMaxResults sets the MaxResults field's value.

func (*ListUserGroupsInput) SetNamespace 

func (s *ListUserGroupsInput) SetNamespace(v string) *ListUserGroupsInput

SetNamespace sets the Namespace field's value.

func (*ListUserGroupsInput) SetNextToken 

func (s *ListUserGroupsInput) SetNextToken(v string) *ListUserGroupsInput

SetNextToken sets the NextToken field's value.

func (*ListUserGroupsInput) SetUserName 

func (s *ListUserGroupsInput) SetUserName(v string) *ListUserGroupsInput

SetUserName sets the UserName field's value.

func (ListUserGroupsInput) String 

func (s ListUserGroupsInput) String() string

String returns the string representation

func (*ListUserGroupsInput) Validate 

func (s *ListUserGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListUserGroupsOutput 

type ListUserGroupsOutput struct {

	// The list of groups the user is a member of.
	GroupList []*Group `type:"list"`

	// A pagination token that can be used in a subsequent request.
	NextToken *string `type:"string"`

	// The AWS request ID for this operation.
	RequestId *string `type:"string"`

	// The HTTP status of the request.
	Status *int64 `location:"statusCode" type:"integer"`
	// contains filtered or unexported fields
}

func (ListUserGroupsOutput) GoString 

func (s ListUserGroupsOutput) GoString() string

GoString returns the string representation

func (*ListUserGroupsOutput) SetGroupList 

func (s *ListUserGroupsOutput) SetGroupList(v []*Group) *ListUserGroupsOutput

SetGroupList sets the GroupList field's value.

func (*ListUserGroupsOutput) SetNextToken 

func (s *ListUserGroupsOutput) SetNextToken(v string) *ListUserGroupsOutput

SetNextToken sets the NextToken field's value.

func (*ListUserGroupsOutput) SetRequestId 

func (s *ListUserGroupsOutput) SetRequestId(v string) *ListUserGroupsOutput

SetRequestId sets the RequestId field's value.

func (*ListUserGroupsOutput) SetStatus 

func (s *ListUserGroupsOutput) SetStatus(v int64) *ListUserGroupsOutput

SetStatus sets the Status field's value.

func (ListUserGroupsOutput) String 

func (s ListUserGroupsOutput) String() string

String returns the string representation

type ListUsersInput 

type ListUsersInput struct {

	// The ID for the AWS account that the user is in. Currently, you use the ID
	// for the AWS account that contains your Amazon QuickSight account.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`

	// The maximum number of results to return from this request.
	MaxResults *int64 `location:"querystring" locationName:"max-results" min:"1" type:"integer"`

	// The namespace. Currently, you should set this to default.
	//
	// Namespace is a required field
	Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"`

	// A pagination token that can be used in a subsequent request.
	NextToken *string `location:"querystring" locationName:"next-token" type:"string"`
	// contains filtered or unexported fields
}

func (ListUsersInput) GoString 

func (s ListUsersInput) GoString() string

GoString returns the string representation

func (*ListUsersInput) SetAwsAccountId 

func (s *ListUsersInput) SetAwsAccountId(v string) *ListUsersInput

SetAwsAccountId sets the AwsAccountId field's value.

func (*ListUsersInput) SetMaxResults 

func (s *ListUsersInput) SetMaxResults(v int64) *ListUsersInput

SetMaxResults sets the MaxResults field's value.

func (*ListUsersInput) SetNamespace 

func (s *ListUsersInput) SetNamespace(v string) *ListUsersInput

SetNamespace sets the Namespace field's value.

func (*ListUsersInput) SetNextToken 

func (s *ListUsersInput) SetNextToken(v string) *ListUsersInput

SetNextToken sets the NextToken field's value.

func (ListUsersInput) String 

func (s ListUsersInput) String() string

String returns the string representation

func (*ListUsersInput) Validate 

func (s *ListUsersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListUsersOutput 

type ListUsersOutput struct {

	// A pagination token that can be used in a subsequent request.
	NextToken *string `type:"string"`

	// The AWS request ID for this operation.
	RequestId *string `type:"string"`

	// The http status of the request.
	Status *int64 `location:"statusCode" type:"integer"`

	// The list of users.
	UserList []*User `type:"list"`
	// contains filtered or unexported fields
}

func (ListUsersOutput) GoString 

func (s ListUsersOutput) GoString() string

GoString returns the string representation

func (*ListUsersOutput) SetNextToken 

func (s *ListUsersOutput) SetNextToken(v string) *ListUsersOutput

SetNextToken sets the NextToken field's value.

func (*ListUsersOutput) SetRequestId 

func (s *ListUsersOutput) SetRequestId(v string) *ListUsersOutput

SetRequestId sets the RequestId field's value.

func (*ListUsersOutput) SetStatus 

func (s *ListUsersOutput) SetStatus(v int64) *ListUsersOutput

SetStatus sets the Status field's value.

func (*ListUsersOutput) SetUserList 

func (s *ListUsersOutput) SetUserList(v []*User) *ListUsersOutput

SetUserList sets the UserList field's value.

func (ListUsersOutput) String 

func (s ListUsersOutput) String() string

String returns the string representation

type QuickSight 

type QuickSight struct {
	*client.Client
}

QuickSight provides the API operation methods for making requests to Amazon QuickSight. See this package's package overview docs for details on the service.

QuickSight methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *QuickSight

New creates a new instance of the QuickSight client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a QuickSight client from just a session.
svc := quicksight.New(mySession)

// Create a QuickSight client with additional configuration
svc := quicksight.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*QuickSight) CreateGroup 

func (c *QuickSight) CreateGroup(input *CreateGroupInput) (*CreateGroupOutput, error)

CreateGroup API operation for Amazon QuickSight.

Creates an Amazon QuickSight group.

The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .

The response is a group object.

CLI Sample:

aws quicksight create-group --aws-account-id=111122223333 --namespace=default --group-name="Sales-Management" --description="Sales Management - Forecasting"

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QuickSight's API operation CreateGroup for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" One or more parameters don't have a valid value.

  • ErrCodeResourceExistsException "ResourceExistsException" The resource specified doesn't exist.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more resources can't be found.

  • ErrCodeThrottlingException "ThrottlingException" Access is throttled.

  • ErrCodePreconditionNotMetException "PreconditionNotMetException" One or more preconditions aren't met.

  • ErrCodeLimitExceededException "LimitExceededException" A limit is exceeded.

  • ErrCodeInternalFailureException "InternalFailureException" An internal failure occurred.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" This resource is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroup

func (*QuickSight) CreateGroupMembership 

func (c *QuickSight) CreateGroupMembership(input *CreateGroupMembershipInput) (*CreateGroupMembershipOutput, error)

CreateGroupMembership API operation for Amazon QuickSight.

Adds an Amazon QuickSight user to an Amazon QuickSight group.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

The condition resource is the user name.

The condition key is quicksight:UserName.

The response is the group member object.

CLI Sample:

aws quicksight create-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales --member-name=Pat

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QuickSight's API operation CreateGroupMembership for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" One or more parameters don't have a valid value.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more resources can't be found.

  • ErrCodeThrottlingException "ThrottlingException" Access is throttled.

  • ErrCodePreconditionNotMetException "PreconditionNotMetException" One or more preconditions aren't met.

  • ErrCodeInternalFailureException "InternalFailureException" An internal failure occurred.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" This resource is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupMembership

func (*QuickSight) CreateGroupMembershipRequest 

func (c *QuickSight) CreateGroupMembershipRequest(input *CreateGroupMembershipInput) (req *request.Request, output *CreateGroupMembershipOutput)

CreateGroupMembershipRequest generates a "aws/request.Request" representing the client's request for the CreateGroupMembership operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateGroupMembership for more information on using the CreateGroupMembership API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateGroupMembershipRequest method.
req, resp := client.CreateGroupMembershipRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupMembership

func (*QuickSight) CreateGroupMembershipWithContext 

func (c *QuickSight) CreateGroupMembershipWithContext(ctx aws.Context, input *CreateGroupMembershipInput, opts ...request.Option) (*CreateGroupMembershipOutput, error)

CreateGroupMembershipWithContext is the same as CreateGroupMembership with the addition of the ability to pass a context and additional request options.

See CreateGroupMembership for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QuickSight) CreateGroupRequest 

func (c *QuickSight) CreateGroupRequest(input *CreateGroupInput) (req *request.Request, output *CreateGroupOutput)

CreateGroupRequest generates a "aws/request.Request" representing the client's request for the CreateGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateGroup for more information on using the CreateGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the CreateGroupRequest method.
req, resp := client.CreateGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroup

func (*QuickSight) CreateGroupWithContext 

func (c *QuickSight) CreateGroupWithContext(ctx aws.Context, input *CreateGroupInput, opts ...request.Option) (*CreateGroupOutput, error)

CreateGroupWithContext is the same as CreateGroup with the addition of the ability to pass a context and additional request options.

See CreateGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QuickSight) DeleteGroup 

func (c *QuickSight) DeleteGroup(input *DeleteGroupInput) (*DeleteGroupOutput, error)

DeleteGroup API operation for Amazon QuickSight.

Removes a user group from Amazon QuickSight.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

CLI Sample:

aws quicksight delete-group -\-aws-account-id=111122223333 -\-namespace=default -\-group-name=Sales-Management

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QuickSight's API operation DeleteGroup for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" One or more parameters don't have a valid value.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more resources can't be found.

  • ErrCodeThrottlingException "ThrottlingException" Access is throttled.

  • ErrCodePreconditionNotMetException "PreconditionNotMetException" One or more preconditions aren't met.

  • ErrCodeInternalFailureException "InternalFailureException" An internal failure occurred.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" This resource is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroup

func (*QuickSight) DeleteGroupMembership 

func (c *QuickSight) DeleteGroupMembership(input *DeleteGroupMembershipInput) (*DeleteGroupMembershipOutput, error)

DeleteGroupMembership API operation for Amazon QuickSight.

Removes a user from a group so that the user is no longer a member of the group.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

The condition resource is the user name.

The condition key is quicksight:UserName.

CLI Sample:

aws quicksight delete-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management --member-name=Charlie

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QuickSight's API operation DeleteGroupMembership for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" One or more parameters don't have a valid value.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more resources can't be found.

  • ErrCodeThrottlingException "ThrottlingException" Access is throttled.

  • ErrCodePreconditionNotMetException "PreconditionNotMetException" One or more preconditions aren't met.

  • ErrCodeInternalFailureException "InternalFailureException" An internal failure occurred.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" This resource is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupMembership

func (*QuickSight) DeleteGroupMembershipRequest 

func (c *QuickSight) DeleteGroupMembershipRequest(input *DeleteGroupMembershipInput) (req *request.Request, output *DeleteGroupMembershipOutput)

DeleteGroupMembershipRequest generates a "aws/request.Request" representing the client's request for the DeleteGroupMembership operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteGroupMembership for more information on using the DeleteGroupMembership API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteGroupMembershipRequest method.
req, resp := client.DeleteGroupMembershipRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupMembership

func (*QuickSight) DeleteGroupMembershipWithContext 

func (c *QuickSight) DeleteGroupMembershipWithContext(ctx aws.Context, input *DeleteGroupMembershipInput, opts ...request.Option) (*DeleteGroupMembershipOutput, error)

DeleteGroupMembershipWithContext is the same as DeleteGroupMembership with the addition of the ability to pass a context and additional request options.

See DeleteGroupMembership for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QuickSight) DeleteGroupRequest 

func (c *QuickSight) DeleteGroupRequest(input *DeleteGroupInput) (req *request.Request, output *DeleteGroupOutput)

DeleteGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteGroup for more information on using the DeleteGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteGroupRequest method.
req, resp := client.DeleteGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroup

func (*QuickSight) DeleteGroupWithContext 

func (c *QuickSight) DeleteGroupWithContext(ctx aws.Context, input *DeleteGroupInput, opts ...request.Option) (*DeleteGroupOutput, error)

DeleteGroupWithContext is the same as DeleteGroup with the addition of the ability to pass a context and additional request options.

See DeleteGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QuickSight) DeleteUser 

func (c *QuickSight) DeleteUser(input *DeleteUserInput) (*DeleteUserOutput, error)

DeleteUser API operation for Amazon QuickSight.

Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

CLI Sample:

aws quicksight delete-user --aws-account-id=111122223333 --namespace=default --user-name=Pat

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QuickSight's API operation DeleteUser for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" One or more parameters don't have a valid value.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more resources can't be found.

  • ErrCodeThrottlingException "ThrottlingException" Access is throttled.

  • ErrCodeInternalFailureException "InternalFailureException" An internal failure occurred.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" This resource is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteUser

func (*QuickSight) DeleteUserByPrincipalId 

func (c *QuickSight) DeleteUserByPrincipalId(input *DeleteUserByPrincipalIdInput) (*DeleteUserByPrincipalIdOutput, error)

DeleteUserByPrincipalId API operation for Amazon QuickSight.

Deletes a user identified by its principal ID.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

CLI Sample:

aws quicksight delete-user-by-principal-id --aws-account-id=111122223333 --namespace=default --principal-id=ABCDEFJA26JLI7EUUOEHS

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QuickSight's API operation DeleteUserByPrincipalId for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" One or more parameters don't have a valid value.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more resources can't be found.

  • ErrCodeThrottlingException "ThrottlingException" Access is throttled.

  • ErrCodeInternalFailureException "InternalFailureException" An internal failure occurred.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" This resource is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteUserByPrincipalId

func (*QuickSight) DeleteUserByPrincipalIdRequest 

func (c *QuickSight) DeleteUserByPrincipalIdRequest(input *DeleteUserByPrincipalIdInput) (req *request.Request, output *DeleteUserByPrincipalIdOutput)

DeleteUserByPrincipalIdRequest generates a "aws/request.Request" representing the client's request for the DeleteUserByPrincipalId operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteUserByPrincipalId for more information on using the DeleteUserByPrincipalId API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteUserByPrincipalIdRequest method.
req, resp := client.DeleteUserByPrincipalIdRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteUserByPrincipalId

func (*QuickSight) DeleteUserByPrincipalIdWithContext 

func (c *QuickSight) DeleteUserByPrincipalIdWithContext(ctx aws.Context, input *DeleteUserByPrincipalIdInput, opts ...request.Option) (*DeleteUserByPrincipalIdOutput, error)

DeleteUserByPrincipalIdWithContext is the same as DeleteUserByPrincipalId with the addition of the ability to pass a context and additional request options.

See DeleteUserByPrincipalId for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QuickSight) DeleteUserRequest 

func (c *QuickSight) DeleteUserRequest(input *DeleteUserInput) (req *request.Request, output *DeleteUserOutput)

DeleteUserRequest generates a "aws/request.Request" representing the client's request for the DeleteUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteUser for more information on using the DeleteUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DeleteUserRequest method.
req, resp := client.DeleteUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteUser

func (*QuickSight) DeleteUserWithContext 

func (c *QuickSight) DeleteUserWithContext(ctx aws.Context, input *DeleteUserInput, opts ...request.Option) (*DeleteUserOutput, error)

DeleteUserWithContext is the same as DeleteUser with the addition of the ability to pass a context and additional request options.

See DeleteUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QuickSight) DescribeGroup 

func (c *QuickSight) DescribeGroup(input *DescribeGroupInput) (*DescribeGroupOutput, error)

DescribeGroup API operation for Amazon QuickSight.

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .

The response is the group object.

CLI Sample:

aws quicksight describe-group -\-aws-account-id=11112222333 -\-namespace=default -\-group-name=Sales

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QuickSight's API operation DescribeGroup for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" One or more parameters don't have a valid value.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more resources can't be found.

  • ErrCodeThrottlingException "ThrottlingException" Access is throttled.

  • ErrCodePreconditionNotMetException "PreconditionNotMetException" One or more preconditions aren't met.

  • ErrCodeInternalFailureException "InternalFailureException" An internal failure occurred.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" This resource is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeGroup

func (*QuickSight) DescribeGroupRequest 

func (c *QuickSight) DescribeGroupRequest(input *DescribeGroupInput) (req *request.Request, output *DescribeGroupOutput)

DescribeGroupRequest generates a "aws/request.Request" representing the client's request for the DescribeGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGroup for more information on using the DescribeGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeGroupRequest method.
req, resp := client.DescribeGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeGroup

func (*QuickSight) DescribeGroupWithContext 

func (c *QuickSight) DescribeGroupWithContext(ctx aws.Context, input *DescribeGroupInput, opts ...request.Option) (*DescribeGroupOutput, error)

DescribeGroupWithContext is the same as DescribeGroup with the addition of the ability to pass a context and additional request options.

See DescribeGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QuickSight) DescribeUser 

func (c *QuickSight) DescribeUser(input *DescribeUserInput) (*DescribeUserOutput, error)

DescribeUser API operation for Amazon QuickSight.

Returns information about a user, given the user name.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.

CLI Sample:

aws quicksight describe-user --aws-account-id=111122223333 --namespace=default --user-name=Pat

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QuickSight's API operation DescribeUser for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" One or more parameters don't have a valid value.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more resources can't be found.

  • ErrCodeThrottlingException "ThrottlingException" Access is throttled.

  • ErrCodeInternalFailureException "InternalFailureException" An internal failure occurred.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" This resource is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeUser

func (*QuickSight) DescribeUserRequest 

func (c *QuickSight) DescribeUserRequest(input *DescribeUserInput) (req *request.Request, output *DescribeUserOutput)

DescribeUserRequest generates a "aws/request.Request" representing the client's request for the DescribeUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeUser for more information on using the DescribeUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the DescribeUserRequest method.
req, resp := client.DescribeUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeUser

func (*QuickSight) DescribeUserWithContext 

func (c *QuickSight) DescribeUserWithContext(ctx aws.Context, input *DescribeUserInput, opts ...request.Option) (*DescribeUserOutput, error)

DescribeUserWithContext is the same as DescribeUser with the addition of the ability to pass a context and additional request options.

See DescribeUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QuickSight) GetDashboardEmbedUrl 

func (c *QuickSight) GetDashboardEmbedUrl(input *GetDashboardEmbedUrlInput) (*GetDashboardEmbedUrlOutput, error)

GetDashboardEmbedUrl API operation for Amazon QuickSight.

Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards (https://docs.aws.amazon.com/en_us/quicksight/latest/user/embedding.html).

Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.

CLI Sample:

Assume the role with permissions enabled for actions: quickSight:RegisterUser and quicksight:GetDashboardEmbedURL. You can use assume-role, assume-role-with-web-identity, or assume-role-with-saml.

aws sts assume-role --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --role-session-name embeddingsession

If the user does not exist in QuickSight, register the user:

aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --user-role READER --session-name "embeddingsession" --email user123@example.com --region us-east-1

Get the URL for the embedded dashboard

aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type IAM

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QuickSight's API operation GetDashboardEmbedUrl for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" One or more parameters don't have a valid value.

  • ErrCodeResourceExistsException "ResourceExistsException" The resource specified doesn't exist.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more resources can't be found.

  • ErrCodeThrottlingException "ThrottlingException" Access is throttled.

  • ErrCodePreconditionNotMetException "PreconditionNotMetException" One or more preconditions aren't met.

  • ErrCodeDomainNotWhitelistedException "DomainNotWhitelistedException" The domain specified is not on the allowlist. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.

  • ErrCodeUserNotFoundException "QuickSightUserNotFoundException" The user is not 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.

  • ErrCodeIdentityTypeNotSupportedException "IdentityTypeNotSupportedException" The identity type specified is not supported. Supported identity types include IAM and QUICKSIGHT.

  • ErrCodeSessionLifetimeInMinutesInvalidException "SessionLifetimeInMinutesInvalidException" The number of minutes specified for the lifetime of a session is not valid. The session lifetime must be from 15 to 600 minutes.

  • ErrCodeUnsupportedUserEditionException "UnsupportedUserEditionException" 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 QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

  • ErrCodeInternalFailureException "InternalFailureException" An internal failure occurred.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" This resource is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrl

func (*QuickSight) GetDashboardEmbedUrlRequest 

func (c *QuickSight) GetDashboardEmbedUrlRequest(input *GetDashboardEmbedUrlInput) (req *request.Request, output *GetDashboardEmbedUrlOutput)

GetDashboardEmbedUrlRequest generates a "aws/request.Request" representing the client's request for the GetDashboardEmbedUrl operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDashboardEmbedUrl for more information on using the GetDashboardEmbedUrl API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the GetDashboardEmbedUrlRequest method.
req, resp := client.GetDashboardEmbedUrlRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrl

func (*QuickSight) GetDashboardEmbedUrlWithContext 

func (c *QuickSight) GetDashboardEmbedUrlWithContext(ctx aws.Context, input *GetDashboardEmbedUrlInput, opts ...request.Option) (*GetDashboardEmbedUrlOutput, error)

GetDashboardEmbedUrlWithContext is the same as GetDashboardEmbedUrl with the addition of the ability to pass a context and additional request options.

See GetDashboardEmbedUrl for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QuickSight) ListGroupMemberships 

func (c *QuickSight) ListGroupMemberships(input *ListGroupMembershipsInput) (*ListGroupMembershipsOutput, error)

ListGroupMemberships API operation for Amazon QuickSight.

Lists member users in a group.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

The response is a list of group member objects.

CLI Sample:

aws quicksight list-group-memberships -\-aws-account-id=111122223333 -\-namespace=default

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QuickSight's API operation ListGroupMemberships for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" One or more parameters don't have a valid value.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more resources can't be found.

  • ErrCodeThrottlingException "ThrottlingException" Access is throttled.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The NextToken value isn't valid.

  • ErrCodePreconditionNotMetException "PreconditionNotMetException" One or more preconditions aren't met.

  • ErrCodeInternalFailureException "InternalFailureException" An internal failure occurred.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" This resource is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroupMemberships

func (*QuickSight) ListGroupMembershipsRequest 

func (c *QuickSight) ListGroupMembershipsRequest(input *ListGroupMembershipsInput) (req *request.Request, output *ListGroupMembershipsOutput)

ListGroupMembershipsRequest generates a "aws/request.Request" representing the client's request for the ListGroupMemberships operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListGroupMemberships for more information on using the ListGroupMemberships API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListGroupMembershipsRequest method.
req, resp := client.ListGroupMembershipsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroupMemberships

func (*QuickSight) ListGroupMembershipsWithContext 

func (c *QuickSight) ListGroupMembershipsWithContext(ctx aws.Context, input *ListGroupMembershipsInput, opts ...request.Option) (*ListGroupMembershipsOutput, error)

ListGroupMembershipsWithContext is the same as ListGroupMemberships with the addition of the ability to pass a context and additional request options.

See ListGroupMemberships for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QuickSight) ListGroups 

func (c *QuickSight) ListGroups(input *ListGroupsInput) (*ListGroupsOutput, error)

ListGroups API operation for Amazon QuickSight.

Lists all user groups in Amazon QuickSight.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*.

The response is a list of group objects.

CLI Sample:

aws quicksight list-groups -\-aws-account-id=111122223333 -\-namespace=default

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QuickSight's API operation ListGroups for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" One or more parameters don't have a valid value.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more resources can't be found.

  • ErrCodeThrottlingException "ThrottlingException" Access is throttled.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The NextToken value isn't valid.

  • ErrCodePreconditionNotMetException "PreconditionNotMetException" One or more preconditions aren't met.

  • ErrCodeInternalFailureException "InternalFailureException" An internal failure occurred.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" This resource is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroups

func (*QuickSight) ListGroupsRequest 

func (c *QuickSight) ListGroupsRequest(input *ListGroupsInput) (req *request.Request, output *ListGroupsOutput)

ListGroupsRequest generates a "aws/request.Request" representing the client's request for the ListGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListGroups for more information on using the ListGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListGroupsRequest method.
req, resp := client.ListGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroups

func (*QuickSight) ListGroupsWithContext 

func (c *QuickSight) ListGroupsWithContext(ctx aws.Context, input *ListGroupsInput, opts ...request.Option) (*ListGroupsOutput, error)

ListGroupsWithContext is the same as ListGroups with the addition of the ability to pass a context and additional request options.

See ListGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QuickSight) ListUserGroups 

func (c *QuickSight) ListUserGroups(input *ListUserGroupsInput) (*ListUserGroupsOutput, error)

ListUserGroups API operation for Amazon QuickSight.

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

The response is a one or more group objects.

CLI Sample:

aws quicksight list-user-groups -\-user-name=Pat -\-aws-account-id=111122223333 -\-namespace=default -\-region=us-east-1

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QuickSight's API operation ListUserGroups for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" One or more parameters don't have a valid value.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more resources can't be found.

  • ErrCodeThrottlingException "ThrottlingException" Access is throttled.

  • ErrCodeInternalFailureException "InternalFailureException" An internal failure occurred.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" This resource is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUserGroups

func (*QuickSight) ListUserGroupsRequest 

func (c *QuickSight) ListUserGroupsRequest(input *ListUserGroupsInput) (req *request.Request, output *ListUserGroupsOutput)

ListUserGroupsRequest generates a "aws/request.Request" representing the client's request for the ListUserGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListUserGroups for more information on using the ListUserGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListUserGroupsRequest method.
req, resp := client.ListUserGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUserGroups

func (*QuickSight) ListUserGroupsWithContext 

func (c *QuickSight) ListUserGroupsWithContext(ctx aws.Context, input *ListUserGroupsInput, opts ...request.Option) (*ListUserGroupsOutput, error)

ListUserGroupsWithContext is the same as ListUserGroups with the addition of the ability to pass a context and additional request options.

See ListUserGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QuickSight) ListUsers 

func (c *QuickSight) ListUsers(input *ListUsersInput) (*ListUsersOutput, error)

ListUsers API operation for Amazon QuickSight.

Returns a list of all of the Amazon QuickSight users belonging to this account.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/* .

The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.

CLI Sample:

aws quicksight list-users --aws-account-id=111122223333 --namespace=default

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QuickSight's API operation ListUsers for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" One or more parameters don't have a valid value.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more resources can't be found.

  • ErrCodeThrottlingException "ThrottlingException" Access is throttled.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" The NextToken value isn't valid.

  • ErrCodeInternalFailureException "InternalFailureException" An internal failure occurred.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" This resource is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUsers

func (*QuickSight) ListUsersRequest 

func (c *QuickSight) ListUsersRequest(input *ListUsersInput) (req *request.Request, output *ListUsersOutput)

ListUsersRequest generates a "aws/request.Request" representing the client's request for the ListUsers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListUsers for more information on using the ListUsers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the ListUsersRequest method.
req, resp := client.ListUsersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUsers

func (*QuickSight) ListUsersWithContext 

func (c *QuickSight) ListUsersWithContext(ctx aws.Context, input *ListUsersInput, opts ...request.Option) (*ListUsersOutput, error)

ListUsersWithContext is the same as ListUsers with the addition of the ability to pass a context and additional request options.

See ListUsers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QuickSight) RegisterUser 

func (c *QuickSight) RegisterUser(input *RegisterUserInput) (*RegisterUserOutput, error)

RegisterUser API operation for Amazon QuickSight.

Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name.

The condition keys are quicksight:IamArn and quicksight:SessionName.

CLI Sample:

aws quicksight register-user -\-aws-account-id=111122223333 -\-namespace=default -\-email=pat@example.com -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QuickSight's API operation RegisterUser for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" One or more parameters don't have a valid value.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more resources can't be found.

  • ErrCodeThrottlingException "ThrottlingException" Access is throttled.

  • ErrCodeLimitExceededException "LimitExceededException" A limit is exceeded.

  • ErrCodeResourceExistsException "ResourceExistsException" The resource specified doesn't exist.

  • ErrCodePreconditionNotMetException "PreconditionNotMetException" One or more preconditions aren't met.

  • ErrCodeInternalFailureException "InternalFailureException" An internal failure occurred.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" This resource is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisterUser

func (*QuickSight) RegisterUserRequest 

func (c *QuickSight) RegisterUserRequest(input *RegisterUserInput) (req *request.Request, output *RegisterUserOutput)

RegisterUserRequest generates a "aws/request.Request" representing the client's request for the RegisterUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RegisterUser for more information on using the RegisterUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the RegisterUserRequest method.
req, resp := client.RegisterUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisterUser

func (*QuickSight) RegisterUserWithContext 

func (c *QuickSight) RegisterUserWithContext(ctx aws.Context, input *RegisterUserInput, opts ...request.Option) (*RegisterUserOutput, error)

RegisterUserWithContext is the same as RegisterUser with the addition of the ability to pass a context and additional request options.

See RegisterUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QuickSight) UpdateGroup 

func (c *QuickSight) UpdateGroup(input *UpdateGroupInput) (*UpdateGroupOutput, error)

UpdateGroup API operation for Amazon QuickSight.

Changes a group description.

The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

The response is a group object.

CLI Sample:

aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description="Sales BI Dashboards"

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QuickSight's API operation UpdateGroup for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" One or more parameters don't have a valid value.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more resources can't be found.

  • ErrCodeThrottlingException "ThrottlingException" Access is throttled.

  • ErrCodePreconditionNotMetException "PreconditionNotMetException" One or more preconditions aren't met.

  • ErrCodeInternalFailureException "InternalFailureException" An internal failure occurred.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" This resource is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateGroup

func (*QuickSight) UpdateGroupRequest 

func (c *QuickSight) UpdateGroupRequest(input *UpdateGroupInput) (req *request.Request, output *UpdateGroupOutput)

UpdateGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateGroup for more information on using the UpdateGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateGroupRequest method.
req, resp := client.UpdateGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateGroup

func (*QuickSight) UpdateGroupWithContext 

func (c *QuickSight) UpdateGroupWithContext(ctx aws.Context, input *UpdateGroupInput, opts ...request.Option) (*UpdateGroupOutput, error)

UpdateGroupWithContext is the same as UpdateGroup with the addition of the ability to pass a context and additional request options.

See UpdateGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*QuickSight) UpdateUser 

func (c *QuickSight) UpdateUser(input *UpdateUserInput) (*UpdateUserOutput, error)

UpdateUser API operation for Amazon QuickSight.

Updates an Amazon QuickSight user.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN).

CLI Sample:

aws quicksight update-user --user-name=Pat --role=ADMIN --email=new_address@amazon.com --aws-account-id=111122223333 --namespace=default --region=us-east-1

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon QuickSight's API operation UpdateUser for usage and error information.

Returned Error Codes:

  • ErrCodeAccessDeniedException "AccessDeniedException" You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure 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 access keys.

  • ErrCodeInvalidParameterValueException "InvalidParameterValueException" One or more parameters don't have a valid value.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" One or more resources can't be found.

  • ErrCodeThrottlingException "ThrottlingException" Access is throttled.

  • ErrCodeInternalFailureException "InternalFailureException" An internal failure occurred.

  • ErrCodeResourceUnavailableException "ResourceUnavailableException" This resource is currently unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateUser

func (*QuickSight) UpdateUserRequest 

func (c *QuickSight) UpdateUserRequest(input *UpdateUserInput) (req *request.Request, output *UpdateUserOutput)

UpdateUserRequest generates a "aws/request.Request" representing the client's request for the UpdateUser operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateUser for more information on using the UpdateUser API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic. 

// Example sending a request using the UpdateUserRequest method.
req, resp := client.UpdateUserRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateUser

func (*QuickSight) UpdateUserWithContext 

func (c *QuickSight) UpdateUserWithContext(ctx aws.Context, input *UpdateUserInput, opts ...request.Option) (*UpdateUserOutput, error)

UpdateUserWithContext is the same as UpdateUser with the addition of the ability to pass a context and additional request options.

See UpdateUser for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type RegisterUserInput 

type RegisterUserInput struct {

	// The ID for the AWS account that the user is in. Currently, you use the ID
	// for the AWS account that contains your Amazon QuickSight account.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`

	// The email address of the user that you want to register.
	//
	// Email is a required field
	Email *string `type:"string" required:"true"`

	// The ARN of the IAM user or role that you are registering with Amazon QuickSight.
	IamArn *string `type:"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.
	//
	// IdentityType is a required field
	IdentityType *string `type:"string" required:"true" enum:"IdentityType"`

	// The namespace. Currently, you should set this to default.
	//
	// Namespace is a required field
	Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"`

	// 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 AWS CLI Reference.
	SessionName *string `min:"2" type:"string"`

	// The Amazon QuickSight user name that you want to create for the user you
	// are registering.
	UserName *string `min:"1" type:"string"`

	// The Amazon QuickSight role of the user. The user role can be one of the following:
	//
	//    * READER: A user who has read-only access to dashboards.
	//
	//    * AUTHOR: A user who can create data sources, data sets, analyses, and
	//    dashboards.
	//
	//    * ADMIN: A user who is an author, who can also manage Amazon QuickSight
	//    settings.
	//
	// UserRole is a required field
	UserRole *string `type:"string" required:"true" enum:"UserRole"`
	// contains filtered or unexported fields
}

func (RegisterUserInput) GoString 

func (s RegisterUserInput) GoString() string

GoString returns the string representation

func (*RegisterUserInput) SetAwsAccountId 

func (s *RegisterUserInput) SetAwsAccountId(v string) *RegisterUserInput

SetAwsAccountId sets the AwsAccountId field's value.

func (*RegisterUserInput) SetEmail 

func (s *RegisterUserInput) SetEmail(v string) *RegisterUserInput

SetEmail sets the Email field's value.

func (*RegisterUserInput) SetIamArn 

func (s *RegisterUserInput) SetIamArn(v string) *RegisterUserInput

SetIamArn sets the IamArn field's value.

func (*RegisterUserInput) SetIdentityType 

func (s *RegisterUserInput) SetIdentityType(v string) *RegisterUserInput

SetIdentityType sets the IdentityType field's value.

func (*RegisterUserInput) SetNamespace 

func (s *RegisterUserInput) SetNamespace(v string) *RegisterUserInput

SetNamespace sets the Namespace field's value.

func (*RegisterUserInput) SetSessionName 

func (s *RegisterUserInput) SetSessionName(v string) *RegisterUserInput

SetSessionName sets the SessionName field's value.

func (*RegisterUserInput) SetUserName 

func (s *RegisterUserInput) SetUserName(v string) *RegisterUserInput

SetUserName sets the UserName field's value.

func (*RegisterUserInput) SetUserRole 

func (s *RegisterUserInput) SetUserRole(v string) *RegisterUserInput

SetUserRole sets the UserRole field's value.

func (RegisterUserInput) String 

func (s RegisterUserInput) String() string

String returns the string representation

func (*RegisterUserInput) Validate 

func (s *RegisterUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RegisterUserOutput 

type RegisterUserOutput struct {

	// The AWS request ID for this operation.
	RequestId *string `type:"string"`

	// The http status of the request.
	Status *int64 `location:"statusCode" type:"integer"`

	// The user name.
	User *User `type:"structure"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

func (RegisterUserOutput) GoString 

func (s RegisterUserOutput) GoString() string

GoString returns the string representation

func (*RegisterUserOutput) SetRequestId 

func (s *RegisterUserOutput) SetRequestId(v string) *RegisterUserOutput

SetRequestId sets the RequestId field's value.

func (*RegisterUserOutput) SetStatus 

func (s *RegisterUserOutput) SetStatus(v int64) *RegisterUserOutput

SetStatus sets the Status field's value.

func (*RegisterUserOutput) SetUser 

func (s *RegisterUserOutput) SetUser(v *User) *RegisterUserOutput

SetUser sets the User field's value.

func (*RegisterUserOutput) SetUserInvitationUrl 

func (s *RegisterUserOutput) SetUserInvitationUrl(v string) *RegisterUserOutput

SetUserInvitationUrl sets the UserInvitationUrl field's value.

func (RegisterUserOutput) String 

func (s RegisterUserOutput) String() string

String returns the string representation

type UpdateGroupInput 

type UpdateGroupInput struct {

	// The ID for the AWS account that the group is in. Currently, you use the ID
	// for the AWS account that contains your Amazon QuickSight account.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`

	// The description for the group that you want to update.
	Description *string `min:"1" type:"string"`

	// The name of the group that you want to update.
	//
	// GroupName is a required field
	GroupName *string `location:"uri" locationName:"GroupName" min:"1" type:"string" required:"true"`

	// The namespace. Currently, you should set this to default.
	//
	// Namespace is a required field
	Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateGroupInput) GoString 

func (s UpdateGroupInput) GoString() string

GoString returns the string representation

func (*UpdateGroupInput) SetAwsAccountId 

func (s *UpdateGroupInput) SetAwsAccountId(v string) *UpdateGroupInput

SetAwsAccountId sets the AwsAccountId field's value.

func (*UpdateGroupInput) SetDescription 

func (s *UpdateGroupInput) SetDescription(v string) *UpdateGroupInput

SetDescription sets the Description field's value.

func (*UpdateGroupInput) SetGroupName 

func (s *UpdateGroupInput) SetGroupName(v string) *UpdateGroupInput

SetGroupName sets the GroupName field's value.

func (*UpdateGroupInput) SetNamespace 

func (s *UpdateGroupInput) SetNamespace(v string) *UpdateGroupInput

SetNamespace sets the Namespace field's value.

func (UpdateGroupInput) String 

func (s UpdateGroupInput) String() string

String returns the string representation

func (*UpdateGroupInput) Validate 

func (s *UpdateGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateGroupOutput 

type UpdateGroupOutput struct {

	// The name of the group.
	Group *Group `type:"structure"`

	// The AWS request ID for this operation.
	RequestId *string `type:"string"`

	// The http status of the request.
	Status *int64 `location:"statusCode" type:"integer"`
	// contains filtered or unexported fields
}

func (UpdateGroupOutput) GoString 

func (s UpdateGroupOutput) GoString() string

GoString returns the string representation

func (*UpdateGroupOutput) SetGroup 

func (s *UpdateGroupOutput) SetGroup(v *Group) *UpdateGroupOutput

SetGroup sets the Group field's value.

func (*UpdateGroupOutput) SetRequestId 

func (s *UpdateGroupOutput) SetRequestId(v string) *UpdateGroupOutput

SetRequestId sets the RequestId field's value.

func (*UpdateGroupOutput) SetStatus 

func (s *UpdateGroupOutput) SetStatus(v int64) *UpdateGroupOutput

SetStatus sets the Status field's value.

func (UpdateGroupOutput) String 

func (s UpdateGroupOutput) String() string

String returns the string representation

type UpdateUserInput 

type UpdateUserInput struct {

	// The ID for the AWS account that the user is in. Currently, you use the ID
	// for the AWS account that contains your Amazon QuickSight account.
	//
	// AwsAccountId is a required field
	AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"`

	// The email address of the user that you want to update.
	//
	// Email is a required field
	Email *string `type:"string" required:"true"`

	// The namespace. Currently, you should set this to default.
	//
	// Namespace is a required field
	Namespace *string `location:"uri" locationName:"Namespace" type:"string" required:"true"`

	// The Amazon QuickSight role of the user. The user role can be one of the following:
	//
	//    * READER: A user who has read-only access to dashboards.
	//
	//    * AUTHOR: A user who can create data sources, data sets, analyses, and
	//    dashboards.
	//
	//    * ADMIN: A user who is an author, who can also manage Amazon QuickSight
	//    settings.
	//
	// Role is a required field
	Role *string `type:"string" required:"true" enum:"UserRole"`

	// The Amazon QuickSight user name that you want to update.
	//
	// UserName is a required field
	UserName *string `location:"uri" locationName:"UserName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateUserInput) GoString 

func (s UpdateUserInput) GoString() string

GoString returns the string representation

func (*UpdateUserInput) SetAwsAccountId 

func (s *UpdateUserInput) SetAwsAccountId(v string) *UpdateUserInput

SetAwsAccountId sets the AwsAccountId field's value.

func (*UpdateUserInput) SetEmail 

func (s *UpdateUserInput) SetEmail(v string) *UpdateUserInput

SetEmail sets the Email field's value.

func (*UpdateUserInput) SetNamespace 

func (s *UpdateUserInput) SetNamespace(v string) *UpdateUserInput

SetNamespace sets the Namespace field's value.

func (*UpdateUserInput) SetRole 

func (s *UpdateUserInput) SetRole(v string) *UpdateUserInput

SetRole sets the Role field's value.

func (*UpdateUserInput) SetUserName 

func (s *UpdateUserInput) SetUserName(v string) *UpdateUserInput

SetUserName sets the UserName field's value.

func (UpdateUserInput) String 

func (s UpdateUserInput) String() string

String returns the string representation

func (*UpdateUserInput) Validate 

func (s *UpdateUserInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateUserOutput 

type UpdateUserOutput struct {

	// The AWS request ID for this operation.
	RequestId *string `type:"string"`

	// The http status of the request.
	Status *int64 `location:"statusCode" type:"integer"`

	// The Amazon QuickSight user.
	User *User `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateUserOutput) GoString 

func (s UpdateUserOutput) GoString() string

GoString returns the string representation

func (*UpdateUserOutput) SetRequestId 

func (s *UpdateUserOutput) SetRequestId(v string) *UpdateUserOutput

SetRequestId sets the RequestId field's value.

func (*UpdateUserOutput) SetStatus 

func (s *UpdateUserOutput) SetStatus(v int64) *UpdateUserOutput

SetStatus sets the Status field's value.

func (*UpdateUserOutput) SetUser 

func (s *UpdateUserOutput) SetUser(v *User) *UpdateUserOutput

SetUser sets the User field's value.

func (UpdateUserOutput) String 

func (s UpdateUserOutput) String() string

String returns the string representation

type User 

type User struct {

	// Active status of user. When you create an Amazon QuickSight user that’s
	// not an IAM user or an AD user, that user is inactive until they sign in and
	// provide a password
	Active *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) for the user.
	Arn *string `type:"string"`

	// The user's email address.
	Email *string `type:"string"`

	// The type of identity authentication used by the user.
	IdentityType *string `type:"string" enum:"IdentityType"`

	// The principal ID of the user.
	PrincipalId *string `type:"string"`

	// The Amazon QuickSight role for the user.
	Role *string `type:"string" enum:"UserRole"`

	// The user's user name.
	UserName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A registered user of Amazon QuickSight. Currently, an Amazon QuickSight subscription can't contain more than 20 million users.

func (User) GoString 

func (s User) GoString() string

GoString returns the string representation

func (*User) SetActive 

func (s *User) SetActive(v bool) *User

SetActive sets the Active field's value.

func (*User) SetArn 

func (s *User) SetArn(v string) *User

SetArn sets the Arn field's value.

func (*User) SetEmail 

func (s *User) SetEmail(v string) *User

SetEmail sets the Email field's value.

func (*User) SetIdentityType 

func (s *User) SetIdentityType(v string) *User

SetIdentityType sets the IdentityType field's value.

func (*User) SetPrincipalId 

func (s *User) SetPrincipalId(v string) *User

SetPrincipalId sets the PrincipalId field's value.

func (*User) SetRole 

func (s *User) SetRole(v string) *User

SetRole sets the Role field's value.

func (*User) SetUserName 

func (s *User) SetUserName(v string) *User

SetUserName sets the UserName field's value.

func (User) String 

func (s User) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package quicksightiface provides an interface to enable mocking the Amazon QuickSight service client for testing your code.
 Package quicksightiface provides an interface to enable mocking the Amazon QuickSight service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.