libZSservicesZSamazonka-quicksightZSamazonka-quicksight
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.QuickSight.CreateIAMPolicyAssignment

Description

Creates an assignment with one specified IAMpolicy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.

Synopsis

Creating a Request

data CreateIAMPolicyAssignment Source #

See: newCreateIAMPolicyAssignment smart constructor.

Constructors

CreateIAMPolicyAssignment' 

Fields

  • policyArn :: Maybe Text

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

  • identities :: Maybe (HashMap Text [Text])

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

  • awsAccountId :: Text

    The ID of the Amazon Web Services account where you want to assign an IAMpolicy to Amazon QuickSight users or groups.

  • assignmentName :: Text

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

  • assignmentStatus :: 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.
  • namespace :: Text

    The namespace that contains the assignment.

Instances

Instances details
Eq CreateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

Read CreateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

Show CreateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

Generic CreateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

Associated Types

type Rep CreateIAMPolicyAssignment :: Type -> Type #

NFData CreateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

Hashable CreateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

ToJSON CreateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

AWSRequest CreateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

ToHeaders CreateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

ToPath CreateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

ToQuery CreateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

type Rep CreateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

type Rep CreateIAMPolicyAssignment = D1 ('MetaData "CreateIAMPolicyAssignment" "Amazonka.QuickSight.CreateIAMPolicyAssignment" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "CreateIAMPolicyAssignment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "policyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "identities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "assignmentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "assignmentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AssignmentStatus) :*: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateIAMPolicyAssignment Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

newCreateIAMPolicyAssignment Source #

Create a value of CreateIAMPolicyAssignment 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:policyArn:CreateIAMPolicyAssignment', createIAMPolicyAssignment_policyArn - The ARN for the IAMpolicy to apply to the Amazon QuickSight users and groups specified in this assignment.

$sel:identities:CreateIAMPolicyAssignment', createIAMPolicyAssignment_identities - The Amazon QuickSight users, groups, or both that you want to assign the policy to.

$sel:awsAccountId:CreateIAMPolicyAssignment', createIAMPolicyAssignment_awsAccountId - The ID of the Amazon Web Services account where you want to assign an IAMpolicy to Amazon QuickSight users or groups.

$sel:assignmentName:CreateIAMPolicyAssignment', createIAMPolicyAssignment_assignmentName - The name of the assignment, also called a rule. It must be unique within an Amazon Web Services account.

$sel:assignmentStatus:CreateIAMPolicyAssignment', createIAMPolicyAssignment_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.

$sel:namespace:CreateIAMPolicyAssignment', createIAMPolicyAssignment_namespace - The namespace that contains the assignment.

Request Lenses

createIAMPolicyAssignment_policyArn :: Lens' CreateIAMPolicyAssignment (Maybe Text) Source #

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

createIAMPolicyAssignment_identities :: Lens' CreateIAMPolicyAssignment (Maybe (HashMap Text [Text])) Source #

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

createIAMPolicyAssignment_awsAccountId :: Lens' CreateIAMPolicyAssignment Text Source #

The ID of the Amazon Web Services account where you want to assign an IAMpolicy to Amazon QuickSight users or groups.

createIAMPolicyAssignment_assignmentName :: Lens' CreateIAMPolicyAssignment Text Source #

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

createIAMPolicyAssignment_assignmentStatus :: Lens' CreateIAMPolicyAssignment 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.

createIAMPolicyAssignment_namespace :: Lens' CreateIAMPolicyAssignment Text Source #

The namespace that contains the assignment.

Destructuring the Response

data CreateIAMPolicyAssignmentResponse Source #

See: newCreateIAMPolicyAssignmentResponse smart constructor.

Constructors

CreateIAMPolicyAssignmentResponse' 

Fields

  • requestId :: Maybe Text

    The Amazon Web Services request ID for this operation.

  • assignmentName :: Maybe Text

    The name of the assignment. This name must be unique within the Amazon Web Services account.

  • 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.
  • policyArn :: Maybe Text

    The ARN for the IAMpolicy that is applied to the Amazon QuickSight users and groups specified in this assignment.

  • identities :: Maybe (HashMap Text [Text])

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

  • assignmentId :: Maybe Text

    The ID for the assignment.

  • status :: Int

    The HTTP status of the request.

Instances

Instances details
Eq CreateIAMPolicyAssignmentResponse Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

Read CreateIAMPolicyAssignmentResponse Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

Show CreateIAMPolicyAssignmentResponse Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

Generic CreateIAMPolicyAssignmentResponse Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

Associated Types

type Rep CreateIAMPolicyAssignmentResponse :: Type -> Type #

NFData CreateIAMPolicyAssignmentResponse Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

type Rep CreateIAMPolicyAssignmentResponse Source # 
Instance details

Defined in Amazonka.QuickSight.CreateIAMPolicyAssignment

type Rep CreateIAMPolicyAssignmentResponse = D1 ('MetaData "CreateIAMPolicyAssignmentResponse" "Amazonka.QuickSight.CreateIAMPolicyAssignment" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "CreateIAMPolicyAssignmentResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestId") '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 "policyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "identities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text])))) :*: (S1 ('MetaSel ('Just "assignmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateIAMPolicyAssignmentResponse Source #

Create a value of CreateIAMPolicyAssignmentResponse 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:CreateIAMPolicyAssignmentResponse', createIAMPolicyAssignmentResponse_requestId - The Amazon Web Services request ID for this operation.

$sel:assignmentName:CreateIAMPolicyAssignment', createIAMPolicyAssignmentResponse_assignmentName - The name of the assignment. This name must be unique within the Amazon Web Services account.

$sel:assignmentStatus:CreateIAMPolicyAssignment', createIAMPolicyAssignmentResponse_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.

$sel:policyArn:CreateIAMPolicyAssignment', createIAMPolicyAssignmentResponse_policyArn - The ARN for the IAMpolicy that is applied to the Amazon QuickSight users and groups specified in this assignment.

$sel:identities:CreateIAMPolicyAssignment', createIAMPolicyAssignmentResponse_identities - The Amazon QuickSight users, groups, or both that the IAMpolicy is assigned to.

$sel:assignmentId:CreateIAMPolicyAssignmentResponse', createIAMPolicyAssignmentResponse_assignmentId - The ID for the assignment.

$sel:status:CreateIAMPolicyAssignmentResponse', createIAMPolicyAssignmentResponse_status - The HTTP status of the request.

Response Lenses

createIAMPolicyAssignmentResponse_requestId :: Lens' CreateIAMPolicyAssignmentResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createIAMPolicyAssignmentResponse_assignmentName :: Lens' CreateIAMPolicyAssignmentResponse (Maybe Text) Source #

The name of the assignment. This name must be unique within the Amazon Web Services account.

createIAMPolicyAssignmentResponse_assignmentStatus :: Lens' CreateIAMPolicyAssignmentResponse (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.

createIAMPolicyAssignmentResponse_policyArn :: Lens' CreateIAMPolicyAssignmentResponse (Maybe Text) Source #

The ARN for the IAMpolicy that is applied to the Amazon QuickSight users and groups specified in this assignment.

createIAMPolicyAssignmentResponse_identities :: Lens' CreateIAMPolicyAssignmentResponse (Maybe (HashMap Text [Text])) Source #

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