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.UpdateIAMPolicyAssignment

Description

Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.

Synopsis

Creating a Request

data UpdateIAMPolicyAssignment Source #

See: newUpdateIAMPolicyAssignment smart constructor.

Constructors

UpdateIAMPolicyAssignment' 

Fields

  • assignmentStatus :: Maybe AssignmentStatus

    The status of the assignment. Possible values are as follows:

    • ENABLED - Anything specified in this assignment is used when creating the data source.
    • DISABLED - This assignment isn't used when creating the data source.
    • DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
  • identities :: Maybe (HashMap Text [Text])

    The Amazon QuickSight users, groups, or both that you want to assign the policy to.

  • policyArn :: Maybe Text

    The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.

  • awsAccountId :: Text

    The ID of the Amazon Web Services account that contains the IAM policy assignment.

  • assignmentName :: Text

    The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account.

  • namespace :: Text

    The namespace of the assignment.

Instances

Instances details
ToJSON UpdateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

ToHeaders UpdateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

ToPath UpdateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

ToQuery UpdateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

AWSRequest UpdateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

Generic UpdateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

Associated Types

type Rep UpdateIAMPolicyAssignment :: Type -> Type #

Read UpdateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

Show UpdateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

NFData UpdateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

Eq UpdateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

Hashable UpdateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

type AWSResponse UpdateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

type Rep UpdateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

type Rep UpdateIAMPolicyAssignment = D1 ('MetaData "UpdateIAMPolicyAssignment" "Amazonka.QuickSight.UpdateIAMPolicyAssignment" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "UpdateIAMPolicyAssignment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "assignmentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssignmentStatus)) :*: (S1 ('MetaSel ('Just "identities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "policyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "assignmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateIAMPolicyAssignment Source #

Create a value of UpdateIAMPolicyAssignment 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:

UpdateIAMPolicyAssignment, updateIAMPolicyAssignment_assignmentStatus - The status of the assignment. Possible values are as follows:

  • ENABLED - Anything specified in this assignment is used when creating the data source.
  • DISABLED - This assignment isn't used when creating the data source.
  • DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

UpdateIAMPolicyAssignment, updateIAMPolicyAssignment_identities - The Amazon QuickSight users, groups, or both that you want to assign the policy to.

UpdateIAMPolicyAssignment, updateIAMPolicyAssignment_policyArn - The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.

UpdateIAMPolicyAssignment, updateIAMPolicyAssignment_awsAccountId - The ID of the Amazon Web Services account that contains the IAM policy assignment.

UpdateIAMPolicyAssignment, updateIAMPolicyAssignment_assignmentName - The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account.

UpdateIAMPolicyAssignment, updateIAMPolicyAssignment_namespace - The namespace of the assignment.

Request Lenses

updateIAMPolicyAssignment_assignmentStatus :: Lens' UpdateIAMPolicyAssignment (Maybe AssignmentStatus) Source #

The status of the assignment. Possible values are as follows:

  • ENABLED - Anything specified in this assignment is used when creating the data source.
  • DISABLED - This assignment isn't used when creating the data source.
  • DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

updateIAMPolicyAssignment_identities :: Lens' UpdateIAMPolicyAssignment (Maybe (HashMap Text [Text])) Source #

The Amazon QuickSight users, groups, or both that you want to assign the policy to.

updateIAMPolicyAssignment_policyArn :: Lens' UpdateIAMPolicyAssignment (Maybe Text) Source #

The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.

updateIAMPolicyAssignment_awsAccountId :: Lens' UpdateIAMPolicyAssignment Text Source #

The ID of the Amazon Web Services account that contains the IAM policy assignment.

updateIAMPolicyAssignment_assignmentName :: Lens' UpdateIAMPolicyAssignment Text Source #

The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account.

Destructuring the Response

data UpdateIAMPolicyAssignmentResponse Source #

See: newUpdateIAMPolicyAssignmentResponse smart constructor.

Constructors

UpdateIAMPolicyAssignmentResponse' 

Fields

  • assignmentId :: Maybe Text

    The ID of the assignment.

  • assignmentName :: Maybe Text

    The name of the assignment or rule.

  • assignmentStatus :: Maybe AssignmentStatus

    The status of the assignment. Possible values are as follows:

    • ENABLED - Anything specified in this assignment is used when creating the data source.
    • DISABLED - This assignment isn't used when creating the data source.
    • DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
  • identities :: Maybe (HashMap Text [Text])

    The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.

  • policyArn :: Maybe Text

    The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this assignment.

  • requestId :: Maybe Text

    The Amazon Web Services request ID for this operation.

  • status :: Int

    The HTTP status of the request.

Instances

Instances details
Generic UpdateIAMPolicyAssignmentResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

Associated Types

type Rep UpdateIAMPolicyAssignmentResponse :: Type -> Type #

Read UpdateIAMPolicyAssignmentResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

Show UpdateIAMPolicyAssignmentResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

NFData UpdateIAMPolicyAssignmentResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

Eq UpdateIAMPolicyAssignmentResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

type Rep UpdateIAMPolicyAssignmentResponse Source # 
Instance details

Defined in Amazonka.QuickSight.UpdateIAMPolicyAssignment

type Rep UpdateIAMPolicyAssignmentResponse = D1 ('MetaData "UpdateIAMPolicyAssignmentResponse" "Amazonka.QuickSight.UpdateIAMPolicyAssignment" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "UpdateIAMPolicyAssignmentResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "assignmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "assignmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "assignmentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssignmentStatus)))) :*: ((S1 ('MetaSel ('Just "identities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "policyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newUpdateIAMPolicyAssignmentResponse Source #

Create a value of UpdateIAMPolicyAssignmentResponse 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:

UpdateIAMPolicyAssignmentResponse, updateIAMPolicyAssignmentResponse_assignmentId - The ID of the assignment.

UpdateIAMPolicyAssignment, updateIAMPolicyAssignmentResponse_assignmentName - The name of the assignment or rule.

UpdateIAMPolicyAssignment, updateIAMPolicyAssignmentResponse_assignmentStatus - The status of the assignment. Possible values are as follows:

  • ENABLED - Anything specified in this assignment is used when creating the data source.
  • DISABLED - This assignment isn't used when creating the data source.
  • DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

UpdateIAMPolicyAssignment, updateIAMPolicyAssignmentResponse_identities - The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.

UpdateIAMPolicyAssignment, updateIAMPolicyAssignmentResponse_policyArn - The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this assignment.

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

UpdateIAMPolicyAssignmentResponse, updateIAMPolicyAssignmentResponse_status - The HTTP status of the request.

Response Lenses

updateIAMPolicyAssignmentResponse_assignmentStatus :: Lens' UpdateIAMPolicyAssignmentResponse (Maybe AssignmentStatus) Source #

The status of the assignment. Possible values are as follows:

  • ENABLED - Anything specified in this assignment is used when creating the data source.
  • DISABLED - This assignment isn't used when creating the data source.
  • DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.

updateIAMPolicyAssignmentResponse_identities :: Lens' UpdateIAMPolicyAssignmentResponse (Maybe (HashMap Text [Text])) Source #

The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.

updateIAMPolicyAssignmentResponse_policyArn :: Lens' UpdateIAMPolicyAssignmentResponse (Maybe Text) Source #

The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this assignment.

updateIAMPolicyAssignmentResponse_requestId :: Lens' UpdateIAMPolicyAssignmentResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.