CloudControlApi / Client / list_resources

list_resources#

CloudControlApi.Client.list_resources(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.list_resources(
    TypeName='string',
    TypeVersionId='string',
    RoleArn='string',
    NextToken='string',
    MaxResults=123,
    ResourceModel='string'
)
Parameters:

  • TypeName (string) –

    [REQUIRED]

    The name of the resource type.

  • TypeVersionId (string) – 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 (string) –

    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 (string) – 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 (integer) – Reserved.

  • ResourceModel (string) – The resource model to use to select the resources to return.

Return type:

dict

Returns:

Response Syntax

{
    'TypeName': 'string',
    'ResourceDescriptions': [
        {
            'Identifier': 'string',
            'Properties': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • TypeName (string) –

      The name of the resource type.

    • ResourceDescriptions (list) –

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

      • (dict) –

        Represents information about a provisioned resource.

        • Identifier (string) –

          The primary identifier for the resource.

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

        • Properties (string) –

          A list of the resource properties and their current values.

    • NextToken (string) –

      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.

Exceptions

  • CloudControlApi.Client.exceptions.AlreadyExistsException

  • CloudControlApi.Client.exceptions.HandlerInternalFailureException

  • CloudControlApi.Client.exceptions.GeneralServiceException

  • CloudControlApi.Client.exceptions.NotUpdatableException

  • CloudControlApi.Client.exceptions.TypeNotFoundException

  • CloudControlApi.Client.exceptions.InvalidRequestException

  • CloudControlApi.Client.exceptions.PrivateTypeException

  • CloudControlApi.Client.exceptions.ResourceNotFoundException

  • CloudControlApi.Client.exceptions.NetworkFailureException

  • CloudControlApi.Client.exceptions.UnsupportedActionException

  • CloudControlApi.Client.exceptions.NotStabilizedException

  • CloudControlApi.Client.exceptions.ServiceInternalErrorException

  • CloudControlApi.Client.exceptions.HandlerFailureException

  • CloudControlApi.Client.exceptions.ServiceLimitExceededException

  • CloudControlApi.Client.exceptions.InvalidCredentialsException

  • CloudControlApi.Client.exceptions.ResourceConflictException

  • CloudControlApi.Client.exceptions.ThrottlingException