CloudFormation / Client / list_stack_refactor_actions

list_stack_refactor_actions

CloudFormation.Client.list_stack_refactor_actions(**kwargs)

Lists the stack refactor actions that will be taken after calling the ExecuteStackRefactor action.

See also: AWS API Documentation

Request Syntax

response = client.list_stack_refactor_actions(
    StackRefactorId='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

• StackRefactorId (string) –

  [REQUIRED]

  The ID associated with the stack refactor created from the CreateStackRefactor action.

• NextToken (string) – If the request doesn’t return all the remaining results, NextToken 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 the request returns all results, NextToken is set to null.

• MaxResults (integer) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'StackRefactorActions': [
        {
            'Action': 'MOVE'|'CREATE',
            'Entity': 'RESOURCE'|'STACK',
            'PhysicalResourceId': 'string',
            'ResourceIdentifier': 'string',
            'Description': 'string',
            'Detection': 'AUTO'|'MANUAL',
            'DetectionReason': 'string',
            'TagResources': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'UntagResources': [
                'string',
            ],
            'ResourceMapping': {
                'Source': {
                    'StackName': 'string',
                    'LogicalResourceId': 'string'
                },
                'Destination': {
                    'StackName': 'string',
                    'LogicalResourceId': 'string'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • StackRefactorActions (list) –

    The stack refactor actions.

    • (dict) –

      Describes the stack and the action that CloudFormation will perform on it if you execute the stack refactor.

      • Action (string) –

        The action that CloudFormation takes on the stack.

      • Entity (string) –

        The type that will be evaluated in the StackRefactorAction. The following are potential Entity types:

        • Stack

        • Resource

      • PhysicalResourceId (string) –

        The name or unique identifier associated with the physical instance of the resource.

      • ResourceIdentifier (string) –

        A key-value pair that identifies the target resource. The key is an identifier property (for example, BucketName for AWS::S3::Bucket resources) and the value is the actual property value (for example, MyS3Bucket).

      • Description (string) –

        A description to help you identify the refactor.

      • Detection (string) –

        The detection type is one of the following:

        • Auto: CloudFormation figured out the mapping on its own.

        • Manual: The customer provided the mapping in the ResourceMapping parameter.

      • DetectionReason (string) –

        The description of the detection type.

      • TagResources (list) –

        Assigns one or more tags to specified resources.

        • (dict) –

          The Tag type enables you to specify a key-value pair that can be used to store information about an CloudFormation stack.

          • Key (string) –

            Required. A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services have the reserved prefix: aws:.

          • Value (string) –

            Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

      • UntagResources (list) –

        Removes one or more tags to specified resources.

        • (string) –

      • ResourceMapping (dict) –

        The mapping for the stack resource Source and stack resource Destination.

        • Source (dict) –

          The source stack StackName and LogicalResourceId for the resource being refactored.

          • StackName (string) –

            The name associated with the stack.

          • LogicalResourceId (string) –

            The logical name of the resource specified in the template.

        • Destination (dict) –

          The destination stack StackName and LogicalResourceId for the resource being refactored.

          • StackName (string) –

            The name associated with the stack.

          • LogicalResourceId (string) –

            The logical name of the resource specified in the template.

  • NextToken (string) –

    If the request doesn’t return all the remaining results, NextToken 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 the request returns all results, NextToken is set to null.