Proton / Client / list_component_provisioned_resources

list_component_provisioned_resources#

Proton.Client.list_component_provisioned_resources(**kwargs)#

List provisioned resources for a component with details.

For more information about components, see Proton components in the Proton User Guide.

See also: AWS API Documentation

Request Syntax

response = client.list_component_provisioned_resources(
    componentName='string',
    nextToken='string'
)
Parameters:

  • componentName (string) –

    [REQUIRED]

    The name of the component whose provisioned resources you want.

  • nextToken (string) – A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the list of provisioned resources that was previously requested.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'provisionedResources': [
        {
            'identifier': 'string',
            'name': 'string',
            'provisioningEngine': 'CLOUDFORMATION'|'TERRAFORM'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      A token that indicates the location of the next provisioned resource in the array of provisioned resources, after the current requested list of provisioned resources.

    • provisionedResources (list) –

      An array of provisioned resources for a component.

      • (dict) –

        Detail data for a provisioned resource.

        • identifier (string) –

          The provisioned resource identifier.

        • name (string) –

          The provisioned resource name.

        • provisioningEngine (string) –

          The resource provisioning engine. At this time, CLOUDFORMATION can be used for Amazon Web Services-managed provisioning, and TERRAFORM can be used for self-managed provisioning.

          For more information, see Self-managed provisioning in the Proton User Guide.

Exceptions