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.

GetDashboardEmbedUrlInput

import "github.com/aws/aws-sdk-go/service/quicksight"

type GetDashboardEmbedUrlInput struct { AwsAccountId *string `location:"uri" locationName:"AwsAccountId" min:"12" type:"string" required:"true"` DashboardId *string `location:"uri" locationName:"DashboardId" type:"string" required:"true"` IdentityType *string `location:"querystring" locationName:"creds-type" type:"string" required:"true" enum:"IdentityType"` ResetDisabled *bool `location:"querystring" locationName:"reset-disabled" type:"boolean"` SessionLifetimeInMinutes *int64 `location:"querystring" locationName:"session-lifetime" min:"15" type:"long"` UndoRedoDisabled *bool `location:"querystring" locationName:"undo-redo-disabled" type:"boolean"` }

AwsAccountId

Type: *string

AWS account ID that contains the dashboard you are embedding.

AwsAccountId is a required field

DashboardId

Type: *string

The ID for the dashboard, also added to IAM policy

DashboardId is a required field

IdentityType

Type: *string

The authentication method the user uses to sign in (IAM only).

IdentityType is a required field

ResetDisabled

Type: *bool

Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.

SessionLifetimeInMinutes

Type: *int64

How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.

UndoRedoDisabled

Type: *bool

Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button.

Method

GoString

func (s GetDashboardEmbedUrlInput) GoString() string

GoString returns the string representation

SetAwsAccountId

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

SetAwsAccountId sets the AwsAccountId field's value.

SetDashboardId

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

SetDashboardId sets the DashboardId field's value.

SetIdentityType

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

SetIdentityType sets the IdentityType field's value.

SetResetDisabled

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

SetResetDisabled sets the ResetDisabled field's value.

SetSessionLifetimeInMinutes

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

SetSessionLifetimeInMinutes sets the SessionLifetimeInMinutes field's value.

SetUndoRedoDisabled

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

SetUndoRedoDisabled sets the UndoRedoDisabled field's value.

String

func (s GetDashboardEmbedUrlInput) String() string

String returns the string representation

Validate

func (s *GetDashboardEmbedUrlInput) Validate() error

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

On this page: