libZSservicesZSamazonka-cloudcontrolZSamazonka-cloudcontrol
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.CloudControl.ListResources

Description

Returns information about the specified resources. For more information, see Discovering resources in the Amazon Web Services Cloud Control API User Guide.

You can use this action to return information about existing resources in your account and Amazon Web Services Region, whether or not those resources were provisioned using Cloud Control API.

Synopsis

Creating a Request

data ListResources Source #

See: newListResources smart constructor.

Constructors

ListResources' 

Fields

  • resourceModel :: Maybe (Sensitive Text)

    The resource model to use to select the resources to return.

  • nextToken :: Maybe Text

    If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

  • typeVersionId :: Maybe Text

    For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

  • maxResults :: Maybe Natural

    The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    The default is 20.

  • roleArn :: Maybe Text

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

    If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

    For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

  • typeName :: Text

    The name of the resource type.

Instances

Instances details
Eq ListResources Source # 
Instance details

Defined in Amazonka.CloudControl.ListResources

Show ListResources Source # 
Instance details

Defined in Amazonka.CloudControl.ListResources

Generic ListResources Source # 
Instance details

Defined in Amazonka.CloudControl.ListResources

Associated Types

type Rep ListResources :: Type -> Type #

NFData ListResources Source # 
Instance details

Defined in Amazonka.CloudControl.ListResources

Methods

rnf :: ListResources -> () #

Hashable ListResources Source # 
Instance details

Defined in Amazonka.CloudControl.ListResources

ToJSON ListResources Source # 
Instance details

Defined in Amazonka.CloudControl.ListResources

AWSRequest ListResources Source # 
Instance details

Defined in Amazonka.CloudControl.ListResources

Associated Types

type AWSResponse ListResources #

ToHeaders ListResources Source # 
Instance details

Defined in Amazonka.CloudControl.ListResources

ToPath ListResources Source # 
Instance details

Defined in Amazonka.CloudControl.ListResources

ToQuery ListResources Source # 
Instance details

Defined in Amazonka.CloudControl.ListResources

type Rep ListResources Source # 
Instance details

Defined in Amazonka.CloudControl.ListResources

type Rep ListResources = D1 ('MetaData "ListResources" "Amazonka.CloudControl.ListResources" "libZSservicesZSamazonka-cloudcontrolZSamazonka-cloudcontrol" 'False) (C1 ('MetaCons "ListResources'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "resourceModel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "typeVersionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse ListResources Source # 
Instance details

Defined in Amazonka.CloudControl.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:resourceModel:ListResources', listResources_resourceModel - The resource model to use to select the resources to return.

$sel:nextToken:ListResources', listResources_nextToken - If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

$sel:typeVersionId:ListResources', listResources_typeVersionId - For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

$sel:maxResults:ListResources', listResources_maxResults - The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

The default is 20.

$sel:roleArn:ListResources', listResources_roleArn - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

$sel:typeName:ListResources', listResources_typeName - The name of the resource type.

Request Lenses

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

The resource model to use to select the resources to return.

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

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

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

For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

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

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

The default is 20.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the handlers section of the resource type definition schema.

If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

listResources_typeName :: Lens' ListResources Text Source #

The name of the resource type.

Destructuring the Response

data ListResourcesResponse Source #

See: newListResourcesResponse smart constructor.

Constructors

ListResourcesResponse' 

Fields

  • resourceDescriptions :: Maybe [ResourceDescription]

    Information about the specified resources, including primary identifier and resource model.

  • typeName :: Maybe Text

    The name of the resource type.

  • nextToken :: Maybe Text

    If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResources again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudControl.ListResources

Show ListResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudControl.ListResources

Generic ListResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudControl.ListResources

Associated Types

type Rep ListResourcesResponse :: Type -> Type #

NFData ListResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudControl.ListResources

Methods

rnf :: ListResourcesResponse -> () #

type Rep ListResourcesResponse Source # 
Instance details

Defined in Amazonka.CloudControl.ListResources

type Rep ListResourcesResponse = D1 ('MetaData "ListResourcesResponse" "Amazonka.CloudControl.ListResources" "libZSservicesZSamazonka-cloudcontrolZSamazonka-cloudcontrol" 'False) (C1 ('MetaCons "ListResourcesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "resourceDescriptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceDescription])) :*: S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (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:resourceDescriptions:ListResourcesResponse', listResourcesResponse_resourceDescriptions - Information about the specified resources, including primary identifier and resource model.

$sel:typeName:ListResources', listResourcesResponse_typeName - The name of the resource type.

$sel:nextToken:ListResources', listResourcesResponse_nextToken - If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResources again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

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

Response Lenses

listResourcesResponse_resourceDescriptions :: Lens' ListResourcesResponse (Maybe [ResourceDescription]) Source #

Information about the specified resources, including primary identifier and resource model.

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

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListResources again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.