libZSservicesZSamazonka-iamZSamazonka-iam
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.IAM.GetAccountAuthorizationDetails

Description

Retrieves information about all IAM users, groups, roles, and policies in your Amazon Web Services account, including their relationships to one another. Use this operation to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.

Policies returned by this operation are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

You can optionally filter the results using the Filter parameter. You can paginate the results using the MaxItems and Marker parameters.

This operation returns paginated results.

Synopsis

Creating a Request

data GetAccountAuthorizationDetails Source #

See: newGetAccountAuthorizationDetails smart constructor.

Constructors

GetAccountAuthorizationDetails' 

Fields

  • marker :: Maybe Text

    Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

  • maxItems :: Maybe Natural

    Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

    If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

  • filter' :: Maybe [EntityType]

    A list of entity types used to filter the results. Only the entities that match the types you specify are included in the output. Use the value LocalManagedPolicy to include customer managed policies.

    The format for this parameter is a comma-separated (if more than one) list of strings. Each string value in the list must be one of the valid values listed below.

Instances

Instances details
Eq GetAccountAuthorizationDetails Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

Read GetAccountAuthorizationDetails Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

Show GetAccountAuthorizationDetails Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

Generic GetAccountAuthorizationDetails Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

Associated Types

type Rep GetAccountAuthorizationDetails :: Type -> Type #

NFData GetAccountAuthorizationDetails Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

Hashable GetAccountAuthorizationDetails Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

AWSPager GetAccountAuthorizationDetails Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

AWSRequest GetAccountAuthorizationDetails Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

ToHeaders GetAccountAuthorizationDetails Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

ToPath GetAccountAuthorizationDetails Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

ToQuery GetAccountAuthorizationDetails Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

type Rep GetAccountAuthorizationDetails Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

type Rep GetAccountAuthorizationDetails = D1 ('MetaData "GetAccountAuthorizationDetails" "Amazonka.IAM.GetAccountAuthorizationDetails" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "GetAccountAuthorizationDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EntityType])))))
type AWSResponse GetAccountAuthorizationDetails Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

newGetAccountAuthorizationDetails :: GetAccountAuthorizationDetails Source #

Create a value of GetAccountAuthorizationDetails 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:marker:GetAccountAuthorizationDetails', getAccountAuthorizationDetails_marker - Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

$sel:maxItems:GetAccountAuthorizationDetails', getAccountAuthorizationDetails_maxItems - Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

$sel:filter':GetAccountAuthorizationDetails', getAccountAuthorizationDetails_filter - A list of entity types used to filter the results. Only the entities that match the types you specify are included in the output. Use the value LocalManagedPolicy to include customer managed policies.

The format for this parameter is a comma-separated (if more than one) list of strings. Each string value in the list must be one of the valid values listed below.

Request Lenses

getAccountAuthorizationDetails_marker :: Lens' GetAccountAuthorizationDetails (Maybe Text) Source #

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

getAccountAuthorizationDetails_maxItems :: Lens' GetAccountAuthorizationDetails (Maybe Natural) Source #

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

getAccountAuthorizationDetails_filter :: Lens' GetAccountAuthorizationDetails (Maybe [EntityType]) Source #

A list of entity types used to filter the results. Only the entities that match the types you specify are included in the output. Use the value LocalManagedPolicy to include customer managed policies.

The format for this parameter is a comma-separated (if more than one) list of strings. Each string value in the list must be one of the valid values listed below.

Destructuring the Response

data GetAccountAuthorizationDetailsResponse Source #

Contains the response to a successful GetAccountAuthorizationDetails request.

See: newGetAccountAuthorizationDetailsResponse smart constructor.

Constructors

GetAccountAuthorizationDetailsResponse' 

Fields

  • roleDetailList :: Maybe [RoleDetail]

    A list containing information about IAM roles.

  • groupDetailList :: Maybe [GroupDetail]

    A list containing information about IAM groups.

  • userDetailList :: Maybe [UserDetail]

    A list containing information about IAM users.

  • marker :: Maybe Text

    When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

  • isTruncated :: Maybe Bool

    A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

  • policies :: Maybe [ManagedPolicyDetail]

    A list containing information about managed policies.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetAccountAuthorizationDetailsResponse Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

Read GetAccountAuthorizationDetailsResponse Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

Show GetAccountAuthorizationDetailsResponse Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

Generic GetAccountAuthorizationDetailsResponse Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

NFData GetAccountAuthorizationDetailsResponse Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

type Rep GetAccountAuthorizationDetailsResponse Source # 
Instance details

Defined in Amazonka.IAM.GetAccountAuthorizationDetails

type Rep GetAccountAuthorizationDetailsResponse = D1 ('MetaData "GetAccountAuthorizationDetailsResponse" "Amazonka.IAM.GetAccountAuthorizationDetails" "libZSservicesZSamazonka-iamZSamazonka-iam" 'False) (C1 ('MetaCons "GetAccountAuthorizationDetailsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "roleDetailList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RoleDetail])) :*: (S1 ('MetaSel ('Just "groupDetailList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GroupDetail])) :*: S1 ('MetaSel ('Just "userDetailList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UserDetail])))) :*: ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "isTruncated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "policies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ManagedPolicyDetail])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetAccountAuthorizationDetailsResponse Source #

Create a value of GetAccountAuthorizationDetailsResponse 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:roleDetailList:GetAccountAuthorizationDetailsResponse', getAccountAuthorizationDetailsResponse_roleDetailList - A list containing information about IAM roles.

$sel:groupDetailList:GetAccountAuthorizationDetailsResponse', getAccountAuthorizationDetailsResponse_groupDetailList - A list containing information about IAM groups.

$sel:userDetailList:GetAccountAuthorizationDetailsResponse', getAccountAuthorizationDetailsResponse_userDetailList - A list containing information about IAM users.

$sel:marker:GetAccountAuthorizationDetails', getAccountAuthorizationDetailsResponse_marker - When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

$sel:isTruncated:GetAccountAuthorizationDetailsResponse', getAccountAuthorizationDetailsResponse_isTruncated - A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

$sel:policies:GetAccountAuthorizationDetailsResponse', getAccountAuthorizationDetailsResponse_policies - A list containing information about managed policies.

$sel:httpStatus:GetAccountAuthorizationDetailsResponse', getAccountAuthorizationDetailsResponse_httpStatus - The response's http status code.

Response Lenses

getAccountAuthorizationDetailsResponse_marker :: Lens' GetAccountAuthorizationDetailsResponse (Maybe Text) Source #

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

getAccountAuthorizationDetailsResponse_isTruncated :: Lens' GetAccountAuthorizationDetailsResponse (Maybe Bool) Source #

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.