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 |
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
- data ListResources = ListResources' {}
- newListResources :: Text -> ListResources
- listResources_resourceModel :: Lens' ListResources (Maybe Text)
- listResources_nextToken :: Lens' ListResources (Maybe Text)
- listResources_typeVersionId :: Lens' ListResources (Maybe Text)
- listResources_maxResults :: Lens' ListResources (Maybe Natural)
- listResources_roleArn :: Lens' ListResources (Maybe Text)
- listResources_typeName :: Lens' ListResources Text
- data ListResourcesResponse = ListResourcesResponse' {}
- newListResourcesResponse :: Int -> ListResourcesResponse
- listResourcesResponse_resourceDescriptions :: Lens' ListResourcesResponse (Maybe [ResourceDescription])
- listResourcesResponse_typeName :: Lens' ListResourcesResponse (Maybe Text)
- listResourcesResponse_nextToken :: Lens' ListResourcesResponse (Maybe Text)
- listResourcesResponse_httpStatus :: Lens' ListResourcesResponse Int
Creating a Request
data ListResources Source #
See: newListResources
smart constructor.
ListResources' | |
|
Instances
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.
ListResourcesResponse' | |
|
Instances
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_typeName :: Lens' ListResourcesResponse (Maybe Text) Source #
The name of the resource type.
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.
listResourcesResponse_httpStatus :: Lens' ListResourcesResponse Int Source #
The response's http status code.