AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

QuickSight

import "github.com/aws/aws-sdk-go/service/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.

Client

Type: *client.Client

Method

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

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

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

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

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.

See Also

For more information about using this API, see AWS API Documentation.

On this page: