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

Description

Lists the resources that you added to a resource share or the resources that are shared with you.

This operation returns paginated results.

Synopsis

Creating a Request

data ListResources Source #

See: newListResources smart constructor.

Constructors

ListResources' 

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 that you want to list only the resource shares that are associated with the specified principal.

  • resourceArns :: Maybe [Text]

    Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

  • resourceRegionScope :: Maybe ResourceRegionScopeFilter

    Specifies that you want the results to include only resources that have the specified scope.

    • ALL – the results include both global and regional resources or resource types.
    • GLOBAL – the results include only global resources or resource types.
    • REGIONAL – the results include only regional resources or resource types.

    The default value is ALL.

  • resourceShareArns :: Maybe [Text]

    Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

  • resourceType :: Maybe Text

    Specifies that you want to list only the resource shares that include resources of the specified resource type.

    For valid values, query the ListResourceTypes operation.

  • resourceOwner :: ResourceOwner

    Specifies that you want to list only the resource shares that match the following:

    • SELF – resources that your account shares with other accounts
    • OTHER-ACCOUNTS – resources that other accounts share with your account

Instances

Instances details
ToJSON ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Methods

toJSON :: ListResources -> Value #

toEncoding :: ListResources -> Encoding #

toJSONList :: [ListResources] -> Value #

toEncodingList :: [ListResources] -> Encoding #

ToHeaders ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Methods

toHeaders :: ListResources -> [Header] #

ToPath ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Methods

toPath :: ListResources -> ByteString #

ToQuery ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Methods

toQuery :: ListResources -> QueryString #

AWSPager ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Methods

page :: ListResources -> AWSResponse ListResources -> Maybe ListResources #

AWSRequest ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Associated Types

type AWSResponse ListResources #

Methods

request :: (Service -> Service) -> ListResources -> Request ListResources #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListResources -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListResources))) #

Generic ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Associated Types

type Rep ListResources :: Type -> Type #

Methods

from :: ListResources -> Rep ListResources x #

to :: Rep ListResources x -> ListResources #

Read ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Methods

readsPrec :: Int -> ReadS ListResources #

readList :: ReadS [ListResources] #

readPrec :: ReadPrec ListResources #

readListPrec :: ReadPrec [ListResources] #

Show ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Methods

showsPrec :: Int -> ListResources -> ShowS #

show :: ListResources -> String #

showList :: [ListResources] -> ShowS #

NFData ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Methods

rnf :: ListResources -> () #

Eq ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Methods

(==) :: ListResources -> ListResources -> Bool #

(/=) :: ListResources -> ListResources -> Bool #

Hashable ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Methods

hashWithSalt :: Int -> ListResources -> Int #

hash :: ListResources -> Int #

type AWSResponse ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

type AWSResponse ListResources = ListResourcesResponse
type Rep ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

type Rep ListResources = D1 ('MetaData "ListResources" "Amazonka.RAM.ListResources" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "ListResources'" '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 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "resourceRegionScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceRegionScopeFilter)) :*: S1 ('MetaSel ('Just "resourceShareArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceOwner)))))

newListResources Source #

Arguments

:: ResourceOwner

$sel:resourceOwner:ListResources'

-> ListResources 

Create a value of ListResources 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:ListResources', listResources_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.

ListResources, listResources_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:ListResources', listResources_principal - Specifies that you want to list only the resource shares that are associated with the specified principal.

$sel:resourceArns:ListResources', listResources_resourceArns - Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

ListResources, listResources_resourceRegionScope - Specifies that you want the results to include only resources that have the specified scope.

  • ALL – the results include both global and regional resources or resource types.
  • GLOBAL – the results include only global resources or resource types.
  • REGIONAL – the results include only regional resources or resource types.

The default value is ALL.

$sel:resourceShareArns:ListResources', listResources_resourceShareArns - Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

ListResources, listResources_resourceType - Specifies that you want to list only the resource shares that include resources of the specified resource type.

For valid values, query the ListResourceTypes operation.

$sel:resourceOwner:ListResources', listResources_resourceOwner - Specifies that you want to list only the resource shares that match the following:

  • SELF – resources that your account shares with other accounts
  • OTHER-ACCOUNTS – resources that other accounts share with your account

Request Lenses

listResources_maxResults :: Lens' ListResources (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.

listResources_nextToken :: Lens' ListResources (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.

listResources_principal :: Lens' ListResources (Maybe Text) Source #

Specifies that you want to list only the resource shares that are associated with the specified principal.

listResources_resourceArns :: Lens' ListResources (Maybe [Text]) Source #

Specifies that you want to list only the resource shares that include resources with the specified Amazon Resource Names (ARNs).

listResources_resourceRegionScope :: Lens' ListResources (Maybe ResourceRegionScopeFilter) Source #

Specifies that you want the results to include only resources that have the specified scope.

  • ALL – the results include both global and regional resources or resource types.
  • GLOBAL – the results include only global resources or resource types.
  • REGIONAL – the results include only regional resources or resource types.

The default value is ALL.

listResources_resourceShareArns :: Lens' ListResources (Maybe [Text]) Source #

Specifies that you want to list only resources in the resource shares identified by the specified Amazon Resource Names (ARNs).

listResources_resourceType :: Lens' ListResources (Maybe Text) Source #

Specifies that you want to list only the resource shares that include resources of the specified resource type.

For valid values, query the ListResourceTypes operation.

listResources_resourceOwner :: Lens' ListResources ResourceOwner Source #

Specifies that you want to list only the resource shares that match the following:

  • SELF – resources that your account shares with other accounts
  • OTHER-ACCOUNTS – resources that other accounts share with your account

Destructuring the Response

data ListResourcesResponse Source #

See: newListResourcesResponse smart constructor.

Constructors

ListResourcesResponse' 

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.

  • resources :: Maybe [Resource]

    An array of objects that contain information about the resources.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListResourcesResponse Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Associated Types

type Rep ListResourcesResponse :: Type -> Type #

Methods

from :: ListResourcesResponse -> Rep ListResourcesResponse x #

to :: Rep ListResourcesResponse x -> ListResourcesResponse #

Read ListResourcesResponse Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Methods

readsPrec :: Int -> ReadS ListResourcesResponse #

readList :: ReadS [ListResourcesResponse] #

readPrec :: ReadPrec ListResourcesResponse #

readListPrec :: ReadPrec [ListResourcesResponse] #

Show ListResourcesResponse Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Methods

showsPrec :: Int -> ListResourcesResponse -> ShowS #

show :: ListResourcesResponse -> String #

showList :: [ListResourcesResponse] -> ShowS #

NFData ListResourcesResponse Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Methods

rnf :: ListResourcesResponse -> () #

Eq ListResourcesResponse Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Methods

(==) :: ListResourcesResponse -> ListResourcesResponse -> Bool #

(/=) :: ListResourcesResponse -> ListResourcesResponse -> Bool #

type Rep ListResourcesResponse Source # 
Instance details

Defined in Amazonka.RAM.ListResources

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

newListResourcesResponse Source #

Arguments

:: Int

$sel:httpStatus:ListResourcesResponse'

-> ListResourcesResponse 

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

ListResources, listResourcesResponse_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:resources:ListResourcesResponse', listResourcesResponse_resources - An array of objects that contain information about the resources.

$sel:httpStatus:ListResourcesResponse', listResourcesResponse_httpStatus - The response's http status code.

Response Lenses

listResourcesResponse_nextToken :: Lens' ListResourcesResponse (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.

listResourcesResponse_resources :: Lens' ListResourcesResponse (Maybe [Resource]) Source #

An array of objects that contain information about the resources.

listResourcesResponse_httpStatus :: Lens' ListResourcesResponse Int Source #

The response's http status code.