Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.RAM.ListResources

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Synopsis

data ListResources = ListResources' {
- resourceType :: Maybe Text
- nextToken :: Maybe Text
- resourceArns :: Maybe [Text]
- principal :: Maybe Text
- maxResults :: Maybe Natural
- resourceShareArns :: Maybe [Text]
- resourceOwner :: ResourceOwner
}
newListResources :: ResourceOwner -> ListResources
listResources_resourceType :: Lens' ListResources (Maybe Text)
listResources_nextToken :: Lens' ListResources (Maybe Text)
listResources_resourceArns :: Lens' ListResources (Maybe [Text])
listResources_principal :: Lens' ListResources (Maybe Text)
listResources_maxResults :: Lens' ListResources (Maybe Natural)
listResources_resourceShareArns :: Lens' ListResources (Maybe [Text])
listResources_resourceOwner :: Lens' ListResources ResourceOwner
data ListResourcesResponse = ListResourcesResponse' {
- resources :: Maybe [Resource]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListResourcesResponse :: Int -> ListResourcesResponse
listResourcesResponse_resources :: Lens' ListResourcesResponse (Maybe [Resource])
listResourcesResponse_nextToken :: Lens' ListResourcesResponse (Maybe Text)
listResourcesResponse_httpStatus :: Lens' ListResourcesResponse Int

Creating a Request

data ListResources Source #

See: newListResources smart constructor.

Constructors

ListResources'

Fields

resourceType :: Maybe Text
The resource type.
Valid values: acm-pca:CertificateAuthority | appmesh:Mesh | codebuild:Project | codebuild:ReportGroup | ec2:CapacityReservation | ec2:DedicatedHost | ec2:LocalGatewayRouteTable | ec2:PrefixList | ec2:Subnet | ec2:TrafficMirrorTarget | ec2:TransitGateway | imagebuilder:Component | imagebuilder:Image | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe | glue:Catalog | glue:Database | glue:Table | license-manager:LicenseConfiguration I network-firewall:FirewallPolicy | network-firewall:StatefulRuleGroup | network-firewall:StatelessRuleGroup | outposts:Outpost | resource-groups:Group | rds:Cluster | route53resolver:FirewallRuleGroup |route53resolver:ResolverQueryLogConfig | route53resolver:ResolverRule | s3-outposts:Outpost | ssm-contacts:Contact | ssm-incidents:ResponsePlan
nextToken :: Maybe Text
The token for the next page of results.
resourceArns :: Maybe [Text]
The Amazon Resource Names (ARNs) of the resources.
principal :: Maybe Text
The principal.
maxResults :: Maybe Natural
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
resourceShareArns :: Maybe [Text]
The Amazon Resource Names (ARN) of the resource shares.
resourceOwner :: ResourceOwner
The type of owner.

Instances

Instances details

Eq ListResources Source #
Instance details Defined in Amazonka.RAM.ListResources Methods (==) :: ListResources -> ListResources -> Bool # (/=) :: ListResources -> ListResources -> Bool #
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 #
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 #
NFData ListResources Source #
Instance details Defined in Amazonka.RAM.ListResources Methods rnf :: ListResources -> () #
Hashable ListResources Source #
Instance details Defined in Amazonka.RAM.ListResources Methods hashWithSalt :: Int -> ListResources -> Int # hash :: ListResources -> Int #
ToJSON ListResources Source #
Instance details Defined in Amazonka.RAM.ListResources Methods toJSON :: ListResources -> Value # toEncoding :: ListResources -> Encoding # toJSONList :: [ListResources] -> Value # toEncodingList :: [ListResources] -> Encoding #
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 :: ListResources -> Request ListResources # response :: MonadResource m => Logger -> Service -> Proxy ListResources -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListResources))) #
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 #
type Rep ListResources Source #
Instance details Defined in Amazonka.RAM.ListResources type Rep ListResources = D1 ('MetaData "ListResources" "Amazonka.RAM.ListResources" "libZSservicesZSamazonka-ramZSamazonka-ram" 'False) (C1 ('MetaCons "ListResources'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "principal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "resourceShareArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "resourceOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceOwner)))))
type AWSResponse ListResources Source #
Instance details Defined in Amazonka.RAM.ListResources type AWSResponse ListResources = ListResourcesResponse

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:resourceType:ListResources', listResources_resourceType - The resource type.

$sel:nextToken:ListResources', listResources_nextToken - The token for the next page of results.

$sel:resourceArns:ListResources', listResources_resourceArns - The Amazon Resource Names (ARNs) of the resources.

$sel:principal:ListResources', listResources_principal - The principal.

$sel:maxResults:ListResources', listResources_maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

$sel:resourceShareArns:ListResources', listResources_resourceShareArns - The Amazon Resource Names (ARN) of the resource shares.

$sel:resourceOwner:ListResources', listResources_resourceOwner - The type of owner.

Request Lenses

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

The resource type.

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

The token for the next page of results.

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

The Amazon Resource Names (ARNs) of the resources.

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

The principal.

listResources_maxResults :: Lens' ListResources (Maybe Natural) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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

The Amazon Resource Names (ARN) of the resource shares.

listResources_resourceOwner :: Lens' ListResources ResourceOwner Source #

The type of owner.

Destructuring the Response

data ListResourcesResponse Source #

See: newListResourcesResponse smart constructor.

Constructors

ListResourcesResponse'
Fields resources :: Maybe [Resource] Information about the resources. nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListResourcesResponse Source #
Instance details Defined in Amazonka.RAM.ListResources Methods (==) :: ListResourcesResponse -> ListResourcesResponse -> Bool # (/=) :: ListResourcesResponse -> ListResourcesResponse -> Bool #
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 #
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 #
NFData ListResourcesResponse Source #
Instance details Defined in Amazonka.RAM.ListResources Methods rnf :: ListResourcesResponse -> () #
type Rep ListResourcesResponse Source #
Instance details Defined in Amazonka.RAM.ListResources type Rep ListResourcesResponse = D1 ('MetaData "ListResourcesResponse" "Amazonka.RAM.ListResources" "libZSservicesZSamazonka-ramZSamazonka-ram" 'False) (C1 ('MetaCons "ListResourcesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Resource])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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:

$sel:resources:ListResourcesResponse', listResourcesResponse_resources - Information about the resources.

$sel:nextToken:ListResources', listResourcesResponse_nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

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

Response Lenses

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

Information about the resources.

listResourcesResponse_nextToken :: Lens' ListResourcesResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

listResourcesResponse_httpStatus :: Lens' ListResourcesResponse Int Source #

The response's http status code.