libZSservicesZSamazonka-ramZSamazonka-ram
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.RAM.ListResources

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

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

Read ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Show ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Generic ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Associated Types

type Rep ListResources :: Type -> Type #

NFData ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Methods

rnf :: ListResources -> () #

Hashable ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

ToJSON ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

AWSPager ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

AWSRequest ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Associated Types

type AWSResponse ListResources #

ToHeaders ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

ToPath ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

ToQuery ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

type Rep ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

type AWSResponse ListResources Source # 
Instance details

Defined in Amazonka.RAM.ListResources

newListResources Source #

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.

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

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

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

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

Destructuring the Response

data ListResourcesResponse Source #

See: newListResourcesResponse smart constructor.

Constructors

ListResourcesResponse' 

Fields

Instances

Instances details
Eq ListResourcesResponse Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Read ListResourcesResponse Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Show ListResourcesResponse Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Generic ListResourcesResponse Source # 
Instance details

Defined in Amazonka.RAM.ListResources

Associated Types

type Rep ListResourcesResponse :: Type -> Type #

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 #

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