Skip to content

ListResourcesInput

Source code in docs_src/capo_cloudcontrol/types/list_resources_input.py
class ListResourcesInput(TypedDict, closed=True):
    type_name: "capo_cloudcontrol.types.type_name.TypeName"
    """<p>The name of the resource type.</p>"""
    type_version_id: NotRequired[
        "capo_cloudcontrol.types.type_version_id.TypeVersionId"
    ]
    """<p>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.</p>"""
    role_arn: NotRequired["capo_cloudcontrol.types.role_arn.RoleArn"]
    """<p>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 <code> <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers">handlers</a> </code> section of the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html">resource type definition schema</a>.</p> <p>If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions">Specifying credentials</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p>"""
    next_token: NotRequired[
        "capo_cloudcontrol.types.handler_next_token.HandlerNextToken"
    ]
    """<p>If the previous paginated request didn't return all of the remaining results, the response object's <code>NextToken</code> 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 <code>NextToken</code> parameter. If there are no remaining results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>.</p>"""
    max_results: NotRequired["capo_cloudcontrol.types.max_results.MaxResults"]
    """<p>Reserved.</p>"""
    resource_model: NotRequired["capo_cloudcontrol.types.properties.Properties"]
    """<p>The resource model to use to select the resources to return.</p>"""

max_results instance-attribute

max_results: NotRequired[MaxResults]

Reserved.

next_token instance-attribute

next_token: NotRequired[HandlerNextToken]

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.

resource_model instance-attribute

resource_model: NotRequired[Properties]

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

role_arn instance-attribute

role_arn: NotRequired[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.

type_name instance-attribute

type_name: TypeName

The name of the resource type.

type_version_id instance-attribute

type_version_id: NotRequired[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.