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 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
- type CreateGroupInput
- type CreateGroupMembershipInput
- type CreateGroupMembershipOutput
- type CreateGroupMembershipRequest
- type CreateGroupOutput
- type CreateGroupRequest
- type DeleteGroupInput
- type DeleteGroupMembershipInput
- type DeleteGroupMembershipOutput
- type DeleteGroupMembershipRequest
- type DeleteGroupOutput
- type DeleteGroupRequest
- type DeleteUserByPrincipalIdInput
- type DeleteUserByPrincipalIdOutput
- type DeleteUserByPrincipalIdRequest
- type DeleteUserInput
- type DeleteUserOutput
- type DeleteUserRequest
- type DescribeGroupInput
- type DescribeGroupOutput
- type DescribeGroupRequest
- type DescribeUserInput
- type DescribeUserOutput
- type DescribeUserRequest
- type ExceptionResourceType
- type GetDashboardEmbedUrlInput
- type GetDashboardEmbedUrlOutput
- type GetDashboardEmbedUrlRequest
- type Group
- type GroupMember
- type IdentityType
- type ListGroupMembershipsInput
- type ListGroupMembershipsOutput
- type ListGroupMembershipsRequest
- type ListGroupsInput
- type ListGroupsOutput
- type ListGroupsRequest
- type ListUserGroupsInput
- type ListUserGroupsOutput
- type ListUserGroupsRequest
- type ListUsersInput
- type ListUsersOutput
- type ListUsersRequest
- type QuickSight
- func (c *QuickSight) CreateGroupMembershipRequest(input *CreateGroupMembershipInput) CreateGroupMembershipRequest
- func (c *QuickSight) CreateGroupRequest(input *CreateGroupInput) CreateGroupRequest
- func (c *QuickSight) DeleteGroupMembershipRequest(input *DeleteGroupMembershipInput) DeleteGroupMembershipRequest
- func (c *QuickSight) DeleteGroupRequest(input *DeleteGroupInput) DeleteGroupRequest
- func (c *QuickSight) DeleteUserByPrincipalIdRequest(input *DeleteUserByPrincipalIdInput) DeleteUserByPrincipalIdRequest
- func (c *QuickSight) DeleteUserRequest(input *DeleteUserInput) DeleteUserRequest
- func (c *QuickSight) DescribeGroupRequest(input *DescribeGroupInput) DescribeGroupRequest
- func (c *QuickSight) DescribeUserRequest(input *DescribeUserInput) DescribeUserRequest
- func (c *QuickSight) GetDashboardEmbedUrlRequest(input *GetDashboardEmbedUrlInput) GetDashboardEmbedUrlRequest
- func (c *QuickSight) ListGroupMembershipsRequest(input *ListGroupMembershipsInput) ListGroupMembershipsRequest
- func (c *QuickSight) ListGroupsRequest(input *ListGroupsInput) ListGroupsRequest
- func (c *QuickSight) ListUserGroupsRequest(input *ListUserGroupsInput) ListUserGroupsRequest
- func (c *QuickSight) ListUsersRequest(input *ListUsersInput) ListUsersRequest
- func (c *QuickSight) RegisterUserRequest(input *RegisterUserInput) RegisterUserRequest
- func (c *QuickSight) UpdateGroupRequest(input *UpdateGroupInput) UpdateGroupRequest
- func (c *QuickSight) UpdateUserRequest(input *UpdateUserInput) UpdateUserRequest
- type RegisterUserInput
- type RegisterUserOutput
- type RegisterUserRequest
- type UpdateGroupInput
- type UpdateGroupOutput
- type UpdateGroupRequest
- type UpdateUserInput
- type UpdateUserOutput
- type UpdateUserRequest
- type User
- type UserRole
Constants ¶
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" // "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 // "UserNotFoundException". // // 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 = "UserNotFoundException" )
const ( ServiceName = "quicksight" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupRequest
func (CreateGroupInput) GoString ¶
func (s CreateGroupInput) GoString() string
GoString returns the string representation
func (CreateGroupInput) MarshalFields ¶
func (s CreateGroupInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupMembershipRequest
func (CreateGroupMembershipInput) GoString ¶
func (s CreateGroupMembershipInput) GoString() string
GoString returns the string representation
func (CreateGroupMembershipInput) MarshalFields ¶
func (s CreateGroupMembershipInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupMembershipResponse
func (CreateGroupMembershipOutput) GoString ¶
func (s CreateGroupMembershipOutput) GoString() string
GoString returns the string representation
func (CreateGroupMembershipOutput) MarshalFields ¶
func (s CreateGroupMembershipOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateGroupMembershipOutput) SDKResponseMetadata ¶
func (s CreateGroupMembershipOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateGroupMembershipOutput) String ¶
func (s CreateGroupMembershipOutput) String() string
String returns the string representation
type CreateGroupMembershipRequest ¶
type CreateGroupMembershipRequest struct { *aws.Request Input *CreateGroupMembershipInput Copy func(*CreateGroupMembershipInput) CreateGroupMembershipRequest }
CreateGroupMembershipRequest is a API request type for the CreateGroupMembership API operation.
func (CreateGroupMembershipRequest) Send ¶
func (r CreateGroupMembershipRequest) Send(ctx context.Context) (*CreateGroupMembershipOutput, error)
Send marshals and sends the CreateGroupMembership API request.
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupResponse
func (CreateGroupOutput) GoString ¶
func (s CreateGroupOutput) GoString() string
GoString returns the string representation
func (CreateGroupOutput) MarshalFields ¶
func (s CreateGroupOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (CreateGroupOutput) SDKResponseMetadata ¶
func (s CreateGroupOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateGroupOutput) String ¶
func (s CreateGroupOutput) String() string
String returns the string representation
type CreateGroupRequest ¶
type CreateGroupRequest struct { *aws.Request Input *CreateGroupInput Copy func(*CreateGroupInput) CreateGroupRequest }
CreateGroupRequest is a API request type for the CreateGroup API operation.
func (CreateGroupRequest) Send ¶
func (r CreateGroupRequest) Send(ctx context.Context) (*CreateGroupOutput, error)
Send marshals and sends the CreateGroup API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupRequest
func (DeleteGroupInput) GoString ¶
func (s DeleteGroupInput) GoString() string
GoString returns the string representation
func (DeleteGroupInput) MarshalFields ¶
func (s DeleteGroupInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupMembershipRequest
func (DeleteGroupMembershipInput) GoString ¶
func (s DeleteGroupMembershipInput) GoString() string
GoString returns the string representation
func (DeleteGroupMembershipInput) MarshalFields ¶
func (s DeleteGroupMembershipInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupMembershipResponse
func (DeleteGroupMembershipOutput) GoString ¶
func (s DeleteGroupMembershipOutput) GoString() string
GoString returns the string representation
func (DeleteGroupMembershipOutput) MarshalFields ¶
func (s DeleteGroupMembershipOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteGroupMembershipOutput) SDKResponseMetadata ¶
func (s DeleteGroupMembershipOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteGroupMembershipOutput) String ¶
func (s DeleteGroupMembershipOutput) String() string
String returns the string representation
type DeleteGroupMembershipRequest ¶
type DeleteGroupMembershipRequest struct { *aws.Request Input *DeleteGroupMembershipInput Copy func(*DeleteGroupMembershipInput) DeleteGroupMembershipRequest }
DeleteGroupMembershipRequest is a API request type for the DeleteGroupMembership API operation.
func (DeleteGroupMembershipRequest) Send ¶
func (r DeleteGroupMembershipRequest) Send(ctx context.Context) (*DeleteGroupMembershipOutput, error)
Send marshals and sends the DeleteGroupMembership API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupResponse
func (DeleteGroupOutput) GoString ¶
func (s DeleteGroupOutput) GoString() string
GoString returns the string representation
func (DeleteGroupOutput) MarshalFields ¶
func (s DeleteGroupOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteGroupOutput) SDKResponseMetadata ¶
func (s DeleteGroupOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteGroupOutput) String ¶
func (s DeleteGroupOutput) String() string
String returns the string representation
type DeleteGroupRequest ¶
type DeleteGroupRequest struct { *aws.Request Input *DeleteGroupInput Copy func(*DeleteGroupInput) DeleteGroupRequest }
DeleteGroupRequest is a API request type for the DeleteGroup API operation.
func (DeleteGroupRequest) Send ¶
func (r DeleteGroupRequest) Send(ctx context.Context) (*DeleteGroupOutput, error)
Send marshals and sends the DeleteGroup API request.
type DeleteUserByPrincipalIdInput ¶ added in v0.8.0
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteUserByPrincipalIdRequest
func (DeleteUserByPrincipalIdInput) GoString ¶ added in v0.8.0
func (s DeleteUserByPrincipalIdInput) GoString() string
GoString returns the string representation
func (DeleteUserByPrincipalIdInput) MarshalFields ¶ added in v0.8.0
func (s DeleteUserByPrincipalIdInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteUserByPrincipalIdInput) String ¶ added in v0.8.0
func (s DeleteUserByPrincipalIdInput) String() string
String returns the string representation
func (*DeleteUserByPrincipalIdInput) Validate ¶ added in v0.8.0
func (s *DeleteUserByPrincipalIdInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteUserByPrincipalIdOutput ¶ added in v0.8.0
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteUserByPrincipalIdResponse
func (DeleteUserByPrincipalIdOutput) GoString ¶ added in v0.8.0
func (s DeleteUserByPrincipalIdOutput) GoString() string
GoString returns the string representation
func (DeleteUserByPrincipalIdOutput) MarshalFields ¶ added in v0.8.0
func (s DeleteUserByPrincipalIdOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteUserByPrincipalIdOutput) SDKResponseMetadata ¶ added in v0.8.0
func (s DeleteUserByPrincipalIdOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteUserByPrincipalIdOutput) String ¶ added in v0.8.0
func (s DeleteUserByPrincipalIdOutput) String() string
String returns the string representation
type DeleteUserByPrincipalIdRequest ¶ added in v0.8.0
type DeleteUserByPrincipalIdRequest struct { *aws.Request Input *DeleteUserByPrincipalIdInput Copy func(*DeleteUserByPrincipalIdInput) DeleteUserByPrincipalIdRequest }
DeleteUserByPrincipalIdRequest is a API request type for the DeleteUserByPrincipalId API operation.
func (DeleteUserByPrincipalIdRequest) Send ¶ added in v0.8.0
func (r DeleteUserByPrincipalIdRequest) Send(ctx context.Context) (*DeleteUserByPrincipalIdOutput, error)
Send marshals and sends the DeleteUserByPrincipalId API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteUserRequest
func (DeleteUserInput) GoString ¶
func (s DeleteUserInput) GoString() string
GoString returns the string representation
func (DeleteUserInput) MarshalFields ¶
func (s DeleteUserInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteUserResponse
func (DeleteUserOutput) GoString ¶
func (s DeleteUserOutput) GoString() string
GoString returns the string representation
func (DeleteUserOutput) MarshalFields ¶
func (s DeleteUserOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DeleteUserOutput) SDKResponseMetadata ¶
func (s DeleteUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteUserOutput) String ¶
func (s DeleteUserOutput) String() string
String returns the string representation
type DeleteUserRequest ¶
type DeleteUserRequest struct { *aws.Request Input *DeleteUserInput Copy func(*DeleteUserInput) DeleteUserRequest }
DeleteUserRequest is a API request type for the DeleteUser API operation.
func (DeleteUserRequest) Send ¶
func (r DeleteUserRequest) Send(ctx context.Context) (*DeleteUserOutput, error)
Send marshals and sends the DeleteUser API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeGroupRequest
func (DescribeGroupInput) GoString ¶
func (s DescribeGroupInput) GoString() string
GoString returns the string representation
func (DescribeGroupInput) MarshalFields ¶
func (s DescribeGroupInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeGroupResponse
func (DescribeGroupOutput) GoString ¶
func (s DescribeGroupOutput) GoString() string
GoString returns the string representation
func (DescribeGroupOutput) MarshalFields ¶
func (s DescribeGroupOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DescribeGroupOutput) SDKResponseMetadata ¶
func (s DescribeGroupOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeGroupOutput) String ¶
func (s DescribeGroupOutput) String() string
String returns the string representation
type DescribeGroupRequest ¶
type DescribeGroupRequest struct { *aws.Request Input *DescribeGroupInput Copy func(*DescribeGroupInput) DescribeGroupRequest }
DescribeGroupRequest is a API request type for the DescribeGroup API operation.
func (DescribeGroupRequest) Send ¶
func (r DescribeGroupRequest) Send(ctx context.Context) (*DescribeGroupOutput, error)
Send marshals and sends the DescribeGroup API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeUserRequest
func (DescribeUserInput) GoString ¶
func (s DescribeUserInput) GoString() string
GoString returns the string representation
func (DescribeUserInput) MarshalFields ¶
func (s DescribeUserInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeUserResponse
func (DescribeUserOutput) GoString ¶
func (s DescribeUserOutput) GoString() string
GoString returns the string representation
func (DescribeUserOutput) MarshalFields ¶
func (s DescribeUserOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (DescribeUserOutput) SDKResponseMetadata ¶
func (s DescribeUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeUserOutput) String ¶
func (s DescribeUserOutput) String() string
String returns the string representation
type DescribeUserRequest ¶
type DescribeUserRequest struct { *aws.Request Input *DescribeUserInput Copy func(*DescribeUserInput) DescribeUserRequest }
DescribeUserRequest is a API request type for the DescribeUser API operation.
func (DescribeUserRequest) Send ¶
func (r DescribeUserRequest) Send(ctx context.Context) (*DescribeUserOutput, error)
Send marshals and sends the DescribeUser API request.
type ExceptionResourceType ¶
type ExceptionResourceType string
const ( ExceptionResourceTypeUser ExceptionResourceType = "USER" ExceptionResourceTypeGroup ExceptionResourceType = "GROUP" ExceptionResourceTypeNamespace ExceptionResourceType = "NAMESPACE" ExceptionResourceTypeDataSource ExceptionResourceType = "DATA_SOURCE" ExceptionResourceTypeDataSet ExceptionResourceType = "DATA_SET" ExceptionResourceTypeVpcConnection ExceptionResourceType = "VPC_CONNECTION" ExceptionResourceTypeIngestion ExceptionResourceType = "INGESTION" )
Enum values for ExceptionResourceType
func (ExceptionResourceType) MarshalValue ¶
func (enum ExceptionResourceType) MarshalValue() (string, error)
func (ExceptionResourceType) MarshalValueBuf ¶
func (enum ExceptionResourceType) MarshalValueBuf(b []byte) ([]byte, error)
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 IdentityType `location:"querystring" locationName:"creds-type" type:"string" required:"true" enum:"true"` // 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"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlRequest
func (GetDashboardEmbedUrlInput) GoString ¶
func (s GetDashboardEmbedUrlInput) GoString() string
GoString returns the string representation
func (GetDashboardEmbedUrlInput) MarshalFields ¶
func (s GetDashboardEmbedUrlInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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"` // 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrlResponse
func (GetDashboardEmbedUrlOutput) GoString ¶
func (s GetDashboardEmbedUrlOutput) GoString() string
GoString returns the string representation
func (GetDashboardEmbedUrlOutput) MarshalFields ¶
func (s GetDashboardEmbedUrlOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GetDashboardEmbedUrlOutput) SDKResponseMetadata ¶
func (s GetDashboardEmbedUrlOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetDashboardEmbedUrlOutput) String ¶
func (s GetDashboardEmbedUrlOutput) String() string
String returns the string representation
type GetDashboardEmbedUrlRequest ¶
type GetDashboardEmbedUrlRequest struct { *aws.Request Input *GetDashboardEmbedUrlInput Copy func(*GetDashboardEmbedUrlInput) GetDashboardEmbedUrlRequest }
GetDashboardEmbedUrlRequest is a API request type for the GetDashboardEmbedUrl API operation.
func (GetDashboardEmbedUrlRequest) Send ¶
func (r GetDashboardEmbedUrlRequest) Send(ctx context.Context) (*GetDashboardEmbedUrlOutput, error)
Send marshals and sends the GetDashboardEmbedUrl API request.
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/Group
func (Group) MarshalFields ¶
func (s Group) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GroupMember
func (GroupMember) GoString ¶
func (s GroupMember) GoString() string
GoString returns the string representation
func (GroupMember) MarshalFields ¶
func (s GroupMember) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (GroupMember) String ¶
func (s GroupMember) String() string
String returns the string representation
type IdentityType ¶
type IdentityType string
const ( IdentityTypeIam IdentityType = "IAM" IdentityTypeQuicksight IdentityType = "QUICKSIGHT" )
Enum values for IdentityType
func (IdentityType) MarshalValue ¶
func (enum IdentityType) MarshalValue() (string, error)
func (IdentityType) MarshalValueBuf ¶
func (enum IdentityType) MarshalValueBuf(b []byte) ([]byte, error)
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroupMembershipsRequest
func (ListGroupMembershipsInput) GoString ¶
func (s ListGroupMembershipsInput) GoString() string
GoString returns the string representation
func (ListGroupMembershipsInput) MarshalFields ¶
func (s ListGroupMembershipsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroupMembershipsResponse
func (ListGroupMembershipsOutput) GoString ¶
func (s ListGroupMembershipsOutput) GoString() string
GoString returns the string representation
func (ListGroupMembershipsOutput) MarshalFields ¶
func (s ListGroupMembershipsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListGroupMembershipsOutput) SDKResponseMetadata ¶
func (s ListGroupMembershipsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListGroupMembershipsOutput) String ¶
func (s ListGroupMembershipsOutput) String() string
String returns the string representation
type ListGroupMembershipsRequest ¶
type ListGroupMembershipsRequest struct { *aws.Request Input *ListGroupMembershipsInput Copy func(*ListGroupMembershipsInput) ListGroupMembershipsRequest }
ListGroupMembershipsRequest is a API request type for the ListGroupMemberships API operation.
func (ListGroupMembershipsRequest) Send ¶
func (r ListGroupMembershipsRequest) Send(ctx context.Context) (*ListGroupMembershipsOutput, error)
Send marshals and sends the ListGroupMemberships API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroupsRequest
func (ListGroupsInput) GoString ¶
func (s ListGroupsInput) GoString() string
GoString returns the string representation
func (ListGroupsInput) MarshalFields ¶
func (s ListGroupsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroupsResponse
func (ListGroupsOutput) GoString ¶
func (s ListGroupsOutput) GoString() string
GoString returns the string representation
func (ListGroupsOutput) MarshalFields ¶
func (s ListGroupsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListGroupsOutput) SDKResponseMetadata ¶
func (s ListGroupsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListGroupsOutput) String ¶
func (s ListGroupsOutput) String() string
String returns the string representation
type ListGroupsRequest ¶
type ListGroupsRequest struct { *aws.Request Input *ListGroupsInput Copy func(*ListGroupsInput) ListGroupsRequest }
ListGroupsRequest is a API request type for the ListGroups API operation.
func (ListGroupsRequest) Send ¶
func (r ListGroupsRequest) Send(ctx context.Context) (*ListGroupsOutput, error)
Send marshals and sends the ListGroups API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUserGroupsRequest
func (ListUserGroupsInput) GoString ¶
func (s ListUserGroupsInput) GoString() string
GoString returns the string representation
func (ListUserGroupsInput) MarshalFields ¶
func (s ListUserGroupsInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUserGroupsResponse
func (ListUserGroupsOutput) GoString ¶
func (s ListUserGroupsOutput) GoString() string
GoString returns the string representation
func (ListUserGroupsOutput) MarshalFields ¶
func (s ListUserGroupsOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListUserGroupsOutput) SDKResponseMetadata ¶
func (s ListUserGroupsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListUserGroupsOutput) String ¶
func (s ListUserGroupsOutput) String() string
String returns the string representation
type ListUserGroupsRequest ¶
type ListUserGroupsRequest struct { *aws.Request Input *ListUserGroupsInput Copy func(*ListUserGroupsInput) ListUserGroupsRequest }
ListUserGroupsRequest is a API request type for the ListUserGroups API operation.
func (ListUserGroupsRequest) Send ¶
func (r ListUserGroupsRequest) Send(ctx context.Context) (*ListUserGroupsOutput, error)
Send marshals and sends the ListUserGroups API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUsersRequest
func (ListUsersInput) GoString ¶
func (s ListUsersInput) GoString() string
GoString returns the string representation
func (ListUsersInput) MarshalFields ¶
func (s ListUsersInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUsersResponse
func (ListUsersOutput) GoString ¶
func (s ListUsersOutput) GoString() string
GoString returns the string representation
func (ListUsersOutput) MarshalFields ¶
func (s ListUsersOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (ListUsersOutput) SDKResponseMetadata ¶
func (s ListUsersOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListUsersOutput) String ¶
func (s ListUsersOutput) String() string
String returns the string representation
type ListUsersRequest ¶
type ListUsersRequest struct { *aws.Request Input *ListUsersInput Copy func(*ListUsersInput) ListUsersRequest }
ListUsersRequest is a API request type for the ListUsers API operation.
func (ListUsersRequest) Send ¶
func (r ListUsersRequest) Send(ctx context.Context) (*ListUsersOutput, error)
Send marshals and sends the ListUsers API request.
type QuickSight ¶
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(config aws.Config) *QuickSight
New creates a new instance of the QuickSight client with a config.
Example:
// Create a QuickSight client from just a config. svc := quicksight.New(myConfig)
func (*QuickSight) CreateGroupMembershipRequest ¶
func (c *QuickSight) CreateGroupMembershipRequest(input *CreateGroupMembershipInput) CreateGroupMembershipRequest
CreateGroupMembershipRequest returns a request value for making 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
// Example sending a request using the CreateGroupMembershipRequest method. req := client.CreateGroupMembershipRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroupMembership
func (*QuickSight) CreateGroupRequest ¶
func (c *QuickSight) CreateGroupRequest(input *CreateGroupInput) CreateGroupRequest
CreateGroupRequest returns a request value for making 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"
// Example sending a request using the CreateGroupRequest method. req := client.CreateGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/CreateGroup
func (*QuickSight) DeleteGroupMembershipRequest ¶
func (c *QuickSight) DeleteGroupMembershipRequest(input *DeleteGroupMembershipInput) DeleteGroupMembershipRequest
DeleteGroupMembershipRequest returns a request value for making 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
// Example sending a request using the DeleteGroupMembershipRequest method. req := client.DeleteGroupMembershipRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroupMembership
func (*QuickSight) DeleteGroupRequest ¶
func (c *QuickSight) DeleteGroupRequest(input *DeleteGroupInput) DeleteGroupRequest
DeleteGroupRequest returns a request value for making 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
// Example sending a request using the DeleteGroupRequest method. req := client.DeleteGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteGroup
func (*QuickSight) DeleteUserByPrincipalIdRequest ¶ added in v0.8.0
func (c *QuickSight) DeleteUserByPrincipalIdRequest(input *DeleteUserByPrincipalIdInput) DeleteUserByPrincipalIdRequest
DeleteUserByPrincipalIdRequest returns a request value for making API operation for Amazon QuickSight.
Deletes a user after locating the user by its principal ID.
// Example sending a request using the DeleteUserByPrincipalIdRequest method. req := client.DeleteUserByPrincipalIdRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteUserByPrincipalId
func (*QuickSight) DeleteUserRequest ¶
func (c *QuickSight) DeleteUserRequest(input *DeleteUserInput) DeleteUserRequest
DeleteUserRequest returns a request value for making 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
// Example sending a request using the DeleteUserRequest method. req := client.DeleteUserRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DeleteUser
func (*QuickSight) DescribeGroupRequest ¶
func (c *QuickSight) DescribeGroupRequest(input *DescribeGroupInput) DescribeGroupRequest
DescribeGroupRequest returns a request value for making 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
// Example sending a request using the DescribeGroupRequest method. req := client.DescribeGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeGroup
func (*QuickSight) DescribeUserRequest ¶
func (c *QuickSight) DescribeUserRequest(input *DescribeUserInput) DescribeUserRequest
DescribeUserRequest returns a request value for making 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
// Example sending a request using the DescribeUserRequest method. req := client.DescribeUserRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeUser
func (*QuickSight) GetDashboardEmbedUrlRequest ¶
func (c *QuickSight) GetDashboardEmbedUrlRequest(input *GetDashboardEmbedUrlInput) GetDashboardEmbedUrlRequest
GetDashboardEmbedUrlRequest returns a request value for making 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
// Example sending a request using the GetDashboardEmbedUrlRequest method. req := client.GetDashboardEmbedUrlRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/GetDashboardEmbedUrl
func (*QuickSight) ListGroupMembershipsRequest ¶
func (c *QuickSight) ListGroupMembershipsRequest(input *ListGroupMembershipsInput) ListGroupMembershipsRequest
ListGroupMembershipsRequest returns a request value for making 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
// Example sending a request using the ListGroupMembershipsRequest method. req := client.ListGroupMembershipsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroupMemberships
func (*QuickSight) ListGroupsRequest ¶
func (c *QuickSight) ListGroupsRequest(input *ListGroupsInput) ListGroupsRequest
ListGroupsRequest returns a request value for making 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
// Example sending a request using the ListGroupsRequest method. req := client.ListGroupsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListGroups
func (*QuickSight) ListUserGroupsRequest ¶
func (c *QuickSight) ListUserGroupsRequest(input *ListUserGroupsInput) ListUserGroupsRequest
ListUserGroupsRequest returns a request value for making 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
// Example sending a request using the ListUserGroupsRequest method. req := client.ListUserGroupsRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUserGroups
func (*QuickSight) ListUsersRequest ¶
func (c *QuickSight) ListUsersRequest(input *ListUsersInput) ListUsersRequest
ListUsersRequest returns a request value for making 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
// Example sending a request using the ListUsersRequest method. req := client.ListUsersRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/ListUsers
func (*QuickSight) RegisterUserRequest ¶
func (c *QuickSight) RegisterUserRequest(input *RegisterUserInput) RegisterUserRequest
RegisterUserRequest returns a request value for making 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
// Example sending a request using the RegisterUserRequest method. req := client.RegisterUserRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisterUser
func (*QuickSight) UpdateGroupRequest ¶
func (c *QuickSight) UpdateGroupRequest(input *UpdateGroupInput) UpdateGroupRequest
UpdateGroupRequest returns a request value for making 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"
// Example sending a request using the UpdateGroupRequest method. req := client.UpdateGroupRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateGroup
func (*QuickSight) UpdateUserRequest ¶
func (c *QuickSight) UpdateUserRequest(input *UpdateUserInput) UpdateUserRequest
UpdateUserRequest returns a request value for making 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
// Example sending a request using the UpdateUserRequest method. req := client.UpdateUserRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateUser
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 IdentityType `type:"string" required:"true" enum:"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 session with the assumed IAM role. By using this parameter, // you can register multiple users with the same IAM role, provided that each // 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 UserRole `type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisterUserRequest
func (RegisterUserInput) GoString ¶
func (s RegisterUserInput) GoString() string
GoString returns the string representation
func (RegisterUserInput) MarshalFields ¶
func (s RegisterUserInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/RegisterUserResponse
func (RegisterUserOutput) GoString ¶
func (s RegisterUserOutput) GoString() string
GoString returns the string representation
func (RegisterUserOutput) MarshalFields ¶
func (s RegisterUserOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (RegisterUserOutput) SDKResponseMetadata ¶
func (s RegisterUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (RegisterUserOutput) String ¶
func (s RegisterUserOutput) String() string
String returns the string representation
type RegisterUserRequest ¶
type RegisterUserRequest struct { *aws.Request Input *RegisterUserInput Copy func(*RegisterUserInput) RegisterUserRequest }
RegisterUserRequest is a API request type for the RegisterUser API operation.
func (RegisterUserRequest) Send ¶
func (r RegisterUserRequest) Send(ctx context.Context) (*RegisterUserOutput, error)
Send marshals and sends the RegisterUser API request.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateGroupRequest
func (UpdateGroupInput) GoString ¶
func (s UpdateGroupInput) GoString() string
GoString returns the string representation
func (UpdateGroupInput) MarshalFields ¶
func (s UpdateGroupInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateGroupResponse
func (UpdateGroupOutput) GoString ¶
func (s UpdateGroupOutput) GoString() string
GoString returns the string representation
func (UpdateGroupOutput) MarshalFields ¶
func (s UpdateGroupOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateGroupOutput) SDKResponseMetadata ¶
func (s UpdateGroupOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateGroupOutput) String ¶
func (s UpdateGroupOutput) String() string
String returns the string representation
type UpdateGroupRequest ¶
type UpdateGroupRequest struct { *aws.Request Input *UpdateGroupInput Copy func(*UpdateGroupInput) UpdateGroupRequest }
UpdateGroupRequest is a API request type for the UpdateGroup API operation.
func (UpdateGroupRequest) Send ¶
func (r UpdateGroupRequest) Send(ctx context.Context) (*UpdateGroupOutput, error)
Send marshals and sends the UpdateGroup API request.
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 UserRole `type:"string" required:"true" enum:"true"` // 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateUserRequest
func (UpdateUserInput) GoString ¶
func (s UpdateUserInput) GoString() string
GoString returns the string representation
func (UpdateUserInput) MarshalFields ¶
func (s UpdateUserInput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/UpdateUserResponse
func (UpdateUserOutput) GoString ¶
func (s UpdateUserOutput) GoString() string
GoString returns the string representation
func (UpdateUserOutput) MarshalFields ¶
func (s UpdateUserOutput) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (UpdateUserOutput) SDKResponseMetadata ¶
func (s UpdateUserOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateUserOutput) String ¶
func (s UpdateUserOutput) String() string
String returns the string representation
type UpdateUserRequest ¶
type UpdateUserRequest struct { *aws.Request Input *UpdateUserInput Copy func(*UpdateUserInput) UpdateUserRequest }
UpdateUserRequest is a API request type for the UpdateUser API operation.
func (UpdateUserRequest) Send ¶
func (r UpdateUserRequest) Send(ctx context.Context) (*UpdateUserOutput, error)
Send marshals and sends the UpdateUser API request.
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 IdentityType `type:"string" enum:"true"` // The principal ID of the user. PrincipalId *string `type:"string"` // The Amazon QuickSight role for the user. Role UserRole `type:"string" enum:"true"` // 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/User
func (User) MarshalFields ¶
func (s User) MarshalFields(e protocol.FieldEncoder) error
MarshalFields encodes the AWS API shape using the passed in protocol encoder.
type UserRole ¶
type UserRole string
const ( UserRoleAdmin UserRole = "ADMIN" UserRoleAuthor UserRole = "AUTHOR" UserRoleReader UserRole = "READER" UserRoleRestrictedAuthor UserRole = "RESTRICTED_AUTHOR" UserRoleRestrictedReader UserRole = "RESTRICTED_READER" )
Enum values for UserRole
func (UserRole) MarshalValue ¶
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. |