amazonka-ram-2.0: Amazon Resource Access Manager 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.RAM.GetResourcePolicies

Description

Retrieves the resource policies for the specified resources that you own and have shared.

This operation returns paginated results.

Synopsis

Creating a Request

data GetResourcePolicies Source #

See: newGetResourcePolicies smart constructor.

Constructors

GetResourcePolicies' 

Fields

  • maxResults :: Maybe Natural

    Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • nextToken :: Maybe Text

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • principal :: Maybe Text

    Specifies the principal.

  • resourceArns :: [Text]

    Specifies the Amazon Resource Names (ARNs) of the resources whose policies you want to retrieve.

Instances

Instances details
ToJSON GetResourcePolicies Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

ToHeaders GetResourcePolicies Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

ToPath GetResourcePolicies Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

ToQuery GetResourcePolicies Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

AWSPager GetResourcePolicies Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

AWSRequest GetResourcePolicies Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

Associated Types

type AWSResponse GetResourcePolicies #

Generic GetResourcePolicies Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

Associated Types

type Rep GetResourcePolicies :: Type -> Type #

Read GetResourcePolicies Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

Show GetResourcePolicies Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

NFData GetResourcePolicies Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

Methods

rnf :: GetResourcePolicies -> () #

Eq GetResourcePolicies Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

Hashable GetResourcePolicies Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

type AWSResponse GetResourcePolicies Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

type Rep GetResourcePolicies Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

type Rep GetResourcePolicies = D1 ('MetaData "GetResourcePolicies" "Amazonka.RAM.GetResourcePolicies" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "GetResourcePolicies'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "principal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newGetResourcePolicies :: GetResourcePolicies Source #

Create a value of GetResourcePolicies 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:maxResults:GetResourcePolicies', getResourcePolicies_maxResults - Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

GetResourcePolicies, getResourcePolicies_nextToken - Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

$sel:principal:GetResourcePolicies', getResourcePolicies_principal - Specifies the principal.

$sel:resourceArns:GetResourcePolicies', getResourcePolicies_resourceArns - Specifies the Amazon Resource Names (ARNs) of the resources whose policies you want to retrieve.

Request Lenses

getResourcePolicies_maxResults :: Lens' GetResourcePolicies (Maybe Natural) Source #

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

getResourcePolicies_nextToken :: Lens' GetResourcePolicies (Maybe Text) Source #

Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

getResourcePolicies_resourceArns :: Lens' GetResourcePolicies [Text] Source #

Specifies the Amazon Resource Names (ARNs) of the resources whose policies you want to retrieve.

Destructuring the Response

data GetResourcePoliciesResponse Source #

See: newGetResourcePoliciesResponse smart constructor.

Constructors

GetResourcePoliciesResponse' 

Fields

  • nextToken :: Maybe Text

    If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

  • policies :: Maybe [Text]

    An array of resource policy documents in JSON format.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetResourcePoliciesResponse Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

Associated Types

type Rep GetResourcePoliciesResponse :: Type -> Type #

Read GetResourcePoliciesResponse Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

Show GetResourcePoliciesResponse Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

NFData GetResourcePoliciesResponse Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

Eq GetResourcePoliciesResponse Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

type Rep GetResourcePoliciesResponse Source # 
Instance details

Defined in Amazonka.RAM.GetResourcePolicies

type Rep GetResourcePoliciesResponse = D1 ('MetaData "GetResourcePoliciesResponse" "Amazonka.RAM.GetResourcePolicies" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "GetResourcePoliciesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "policies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetResourcePoliciesResponse Source #

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

GetResourcePolicies, getResourcePoliciesResponse_nextToken - If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

$sel:policies:GetResourcePoliciesResponse', getResourcePoliciesResponse_policies - An array of resource policy documents in JSON format.

$sel:httpStatus:GetResourcePoliciesResponse', getResourcePoliciesResponse_httpStatus - The response's http status code.

Response Lenses

getResourcePoliciesResponse_nextToken :: Lens' GetResourcePoliciesResponse (Maybe Text) Source #

If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

getResourcePoliciesResponse_policies :: Lens' GetResourcePoliciesResponse (Maybe [Text]) Source #

An array of resource policy documents in JSON format.