amazonka-quicksight-2.0: Amazon QuickSight SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.QuickSight.UpdatePublicSharingSettings

Description

Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.

To use this operation, turn on session capacity pricing for your Amazon QuickSight account.

Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.

Synopsis

Creating a Request

data UpdatePublicSharingSettings Source #

See: newUpdatePublicSharingSettings smart constructor.

Constructors

UpdatePublicSharingSettings' 

Fields

  • publicSharingEnabled :: Maybe Bool

    A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.

  • awsAccountId :: Text

    The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

Instances

Instances details
ToJSON UpdatePublicSharingSettings Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

ToHeaders UpdatePublicSharingSettings Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

ToPath UpdatePublicSharingSettings Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

ToQuery UpdatePublicSharingSettings Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

AWSRequest UpdatePublicSharingSettings Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

Generic UpdatePublicSharingSettings Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

Associated Types

type Rep UpdatePublicSharingSettings :: Type -> Type #

Read UpdatePublicSharingSettings Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

Show UpdatePublicSharingSettings Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

NFData UpdatePublicSharingSettings Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

Eq UpdatePublicSharingSettings Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

Hashable UpdatePublicSharingSettings Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

type AWSResponse UpdatePublicSharingSettings Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

type Rep UpdatePublicSharingSettings Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

type Rep UpdatePublicSharingSettings = D1 ('MetaData "UpdatePublicSharingSettings" "Amazonka.QuickSight.UpdatePublicSharingSettings" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "UpdatePublicSharingSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "publicSharingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdatePublicSharingSettings Source #

Create a value of UpdatePublicSharingSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdatePublicSharingSettings, updatePublicSharingSettings_publicSharingEnabled - A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.

UpdatePublicSharingSettings, updatePublicSharingSettings_awsAccountId - The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

Request Lenses

updatePublicSharingSettings_publicSharingEnabled :: Lens' UpdatePublicSharingSettings (Maybe Bool) Source #

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.

updatePublicSharingSettings_awsAccountId :: Lens' UpdatePublicSharingSettings Text Source #

The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

Destructuring the Response

data UpdatePublicSharingSettingsResponse Source #

Constructors

UpdatePublicSharingSettingsResponse' 

Fields

Instances

Instances details
Generic UpdatePublicSharingSettingsResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

Read UpdatePublicSharingSettingsResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

Show UpdatePublicSharingSettingsResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

NFData UpdatePublicSharingSettingsResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

Eq UpdatePublicSharingSettingsResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

type Rep UpdatePublicSharingSettingsResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdatePublicSharingSettings

type Rep UpdatePublicSharingSettingsResponse = D1 ('MetaData "UpdatePublicSharingSettingsResponse" "Amazonka.QuickSight.UpdatePublicSharingSettings" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "UpdatePublicSharingSettingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdatePublicSharingSettingsResponse Source #

Create a value of UpdatePublicSharingSettingsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:requestId:UpdatePublicSharingSettingsResponse', updatePublicSharingSettingsResponse_requestId - The Amazon Web Services request ID for this operation.

UpdatePublicSharingSettingsResponse, updatePublicSharingSettingsResponse_status - The HTTP status of the request.

Response Lenses