Skip to content

List Resources

cloudcontrolapi_list_resources R Documentation

Returns information about the specified resources

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 those resources were provisioned using Cloud Control API.

Usage

cloudcontrolapi_list_resources(TypeName, TypeVersionId, RoleArn,
  NextToken, MaxResults, ResourceModel)

Arguments

TypeName

[required] The name of the resource type.

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.

RoleArn

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role 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.

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.

MaxResults

Reserved.

ResourceModel

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

Value

A list with the following syntax: 

list(
  TypeName = "string",
  ResourceDescriptions = list(
    list(
      Identifier = "string",
      Properties = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_resources(
  TypeName = "string",
  TypeVersionId = "string",
  RoleArn = "string",
  NextToken = "string",
  MaxResults = 123,
  ResourceModel = "string"
)