CloudFormationClient

Index > CloudFormation > CloudFormationClient

Auto-generated documentation for CloudFormation type annotations stubs module mypy-boto3-cloudformation.

CloudFormationClient

Type annotations and code completion for boto3.client("cloudformation"). boto3 documentation

Usage example

from boto3.session import Session
from mypy_boto3_cloudformation.client import CloudFormationClient

def get_cloudformation_client() -> CloudFormationClient:
    return Session().client("cloudformation")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("cloudformation").exceptions structure.

Usage example

client = boto3.client("cloudformation")

try:
    do_something(client)
except (
    client.AlreadyExistsException,
    client.CFNRegistryException,
    client.ChangeSetNotFoundException,
    client.ClientError,
    client.CreatedButModifiedException,
    client.InsufficientCapabilitiesException,
    client.InvalidChangeSetStatusException,
    client.InvalidOperationException,
    client.InvalidStateTransitionException,
    client.LimitExceededException,
    client.NameAlreadyExistsException,
    client.OperationIdAlreadyExistsException,
    client.OperationInProgressException,
    client.OperationNotFoundException,
    client.OperationStatusCheckFailedException,
    client.StackInstanceNotFoundException,
    client.StackNotFoundException,
    client.StackSetNotEmptyException,
    client.StackSetNotFoundException,
    client.StaleRequestException,
    client.TokenAlreadyExistsException,
    client.TypeConfigurationNotFoundException,
    client.TypeNotFoundException,
) as e:
    print(e)

Type checking example

from mypy_boto3_cloudformation.client import Exceptions

def handle_error(exc: Exceptions.AlreadyExistsException) -> None:
    ...

Methods

activate_type

Activates a public third-party extension, making it available for use in stack templates.

Type annotations and code completion for boto3.client("cloudformation").activate_type method. boto3 documentation

Method definition

def activate_type(
    self,
    *,
    Type: ThirdPartyTypeType = ...,  # (1)
    PublicTypeArn: str = ...,
    PublisherId: str = ...,
    TypeName: str = ...,
    TypeNameAlias: str = ...,
    AutoUpdate: bool = ...,
    LoggingConfig: LoggingConfigTypeDef = ...,  # (2)
    ExecutionRoleArn: str = ...,
    VersionBump: VersionBumpType = ...,  # (3)
    MajorVersion: int = ...,
) -> ActivateTypeOutputTypeDef:  # (4)
    ...

1. See ThirdPartyTypeType
2. See LoggingConfigTypeDef
3. See VersionBumpType
4. See ActivateTypeOutputTypeDef

Usage example with kwargs

kwargs: ActivateTypeInputRequestTypeDef = {  # (1)
    "Type": ...,
}

parent.activate_type(**kwargs)

1. See ActivateTypeInputRequestTypeDef

batch_describe_type_configurations

Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and region.

Type annotations and code completion for boto3.client("cloudformation").batch_describe_type_configurations method. boto3 documentation

Method definition

def batch_describe_type_configurations(
    self,
    *,
    TypeConfigurationIdentifiers: Sequence[TypeConfigurationIdentifierTypeDef],  # (1)
) -> BatchDescribeTypeConfigurationsOutputTypeDef:  # (2)
    ...

1. See TypeConfigurationIdentifierTypeDef
2. See BatchDescribeTypeConfigurationsOutputTypeDef

Usage example with kwargs

kwargs: BatchDescribeTypeConfigurationsInputRequestTypeDef = {  # (1)
    "TypeConfigurationIdentifiers": ...,
}

parent.batch_describe_type_configurations(**kwargs)

1. See BatchDescribeTypeConfigurationsInputRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("cloudformation").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_update_stack

Cancels an update on the specified stack.

Type annotations and code completion for boto3.client("cloudformation").cancel_update_stack method. boto3 documentation

Method definition

def cancel_update_stack(
    self,
    *,
    StackName: str,
    ClientRequestToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: CancelUpdateStackInputRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.cancel_update_stack(**kwargs)

1. See CancelUpdateStackInputRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("cloudformation").close method. boto3 documentation

Method definition

def close(
    self,
) -> None:
    ...

continue_update_rollback

For a specified stack that's in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state.

Type annotations and code completion for boto3.client("cloudformation").continue_update_rollback method. boto3 documentation

Method definition

def continue_update_rollback(
    self,
    *,
    StackName: str,
    RoleARN: str = ...,
    ResourcesToSkip: Sequence[str] = ...,
    ClientRequestToken: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: ContinueUpdateRollbackInputRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.continue_update_rollback(**kwargs)

1. See ContinueUpdateRollbackInputRequestTypeDef

create_change_set

Creates a list of changes that will be applied to a stack so that you can review the changes before executing them.

Type annotations and code completion for boto3.client("cloudformation").create_change_set method. boto3 documentation

Method definition

def create_change_set(
    self,
    *,
    StackName: str,
    ChangeSetName: str,
    TemplateBody: str = ...,
    TemplateURL: str = ...,
    UsePreviousTemplate: bool = ...,
    Parameters: Sequence[ParameterTypeDef] = ...,  # (1)
    Capabilities: Sequence[CapabilityType] = ...,  # (2)
    ResourceTypes: Sequence[str] = ...,
    RoleARN: str = ...,
    RollbackConfiguration: RollbackConfigurationTypeDef = ...,  # (3)
    NotificationARNs: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    ClientToken: str = ...,
    Description: str = ...,
    ChangeSetType: ChangeSetTypeType = ...,  # (5)
    ResourcesToImport: Sequence[ResourceToImportTypeDef] = ...,  # (6)
    IncludeNestedStacks: bool = ...,
) -> CreateChangeSetOutputTypeDef:  # (7)
    ...

1. See ParameterTypeDef
2. See CapabilityType
3. See RollbackConfigurationTypeDef
4. See TagTypeDef
5. See ChangeSetTypeType
6. See ResourceToImportTypeDef
7. See CreateChangeSetOutputTypeDef

Usage example with kwargs

kwargs: CreateChangeSetInputRequestTypeDef = {  # (1)
    "StackName": ...,
    "ChangeSetName": ...,
}

parent.create_change_set(**kwargs)

1. See CreateChangeSetInputRequestTypeDef

create_stack

Creates a stack as specified in the template.

Type annotations and code completion for boto3.client("cloudformation").create_stack method. boto3 documentation

Method definition

def create_stack(
    self,
    *,
    StackName: str,
    TemplateBody: str = ...,
    TemplateURL: str = ...,
    Parameters: Sequence[ParameterTypeDef] = ...,  # (1)
    DisableRollback: bool = ...,
    RollbackConfiguration: RollbackConfigurationTypeDef = ...,  # (2)
    TimeoutInMinutes: int = ...,
    NotificationARNs: Sequence[str] = ...,
    Capabilities: Sequence[CapabilityType] = ...,  # (3)
    ResourceTypes: Sequence[str] = ...,
    RoleARN: str = ...,
    OnFailure: OnFailureType = ...,  # (4)
    StackPolicyBody: str = ...,
    StackPolicyURL: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (5)
    ClientRequestToken: str = ...,
    EnableTerminationProtection: bool = ...,
) -> CreateStackOutputTypeDef:  # (6)
    ...

1. See ParameterTypeDef
2. See RollbackConfigurationTypeDef
3. See CapabilityType
4. See OnFailureType
5. See TagTypeDef
6. See CreateStackOutputTypeDef

Usage example with kwargs

kwargs: CreateStackInputRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.create_stack(**kwargs)

1. See CreateStackInputRequestTypeDef

create_stack_instances

Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions.

Type annotations and code completion for boto3.client("cloudformation").create_stack_instances method. boto3 documentation

Method definition

def create_stack_instances(
    self,
    *,
    StackSetName: str,
    Regions: Sequence[str],
    Accounts: Sequence[str] = ...,
    DeploymentTargets: DeploymentTargetsTypeDef = ...,  # (1)
    ParameterOverrides: Sequence[ParameterTypeDef] = ...,  # (2)
    OperationPreferences: StackSetOperationPreferencesTypeDef = ...,  # (3)
    OperationId: str = ...,
    CallAs: CallAsType = ...,  # (4)
) -> CreateStackInstancesOutputTypeDef:  # (5)
    ...

1. See DeploymentTargetsTypeDef
2. See ParameterTypeDef
3. See StackSetOperationPreferencesTypeDef
4. See CallAsType
5. See CreateStackInstancesOutputTypeDef

Usage example with kwargs

kwargs: CreateStackInstancesInputRequestTypeDef = {  # (1)
    "StackSetName": ...,
    "Regions": ...,
}

parent.create_stack_instances(**kwargs)

1. See CreateStackInstancesInputRequestTypeDef

create_stack_set

Creates a stack set.

Type annotations and code completion for boto3.client("cloudformation").create_stack_set method. boto3 documentation

Method definition

def create_stack_set(
    self,
    *,
    StackSetName: str,
    Description: str = ...,
    TemplateBody: str = ...,
    TemplateURL: str = ...,
    StackId: str = ...,
    Parameters: Sequence[ParameterTypeDef] = ...,  # (1)
    Capabilities: Sequence[CapabilityType] = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    AdministrationRoleARN: str = ...,
    ExecutionRoleName: str = ...,
    PermissionModel: PermissionModelsType = ...,  # (4)
    AutoDeployment: AutoDeploymentTypeDef = ...,  # (5)
    CallAs: CallAsType = ...,  # (6)
    ClientRequestToken: str = ...,
    ManagedExecution: ManagedExecutionTypeDef = ...,  # (7)
) -> CreateStackSetOutputTypeDef:  # (8)
    ...

1. See ParameterTypeDef
2. See CapabilityType
3. See TagTypeDef
4. See PermissionModelsType
5. See AutoDeploymentTypeDef
6. See CallAsType
7. See ManagedExecutionTypeDef
8. See CreateStackSetOutputTypeDef

Usage example with kwargs

kwargs: CreateStackSetInputRequestTypeDef = {  # (1)
    "StackSetName": ...,
}

parent.create_stack_set(**kwargs)

1. See CreateStackSetInputRequestTypeDef

deactivate_type

Deactivates a public extension that was previously activated in this account and region.

Type annotations and code completion for boto3.client("cloudformation").deactivate_type method. boto3 documentation

Method definition

def deactivate_type(
    self,
    *,
    TypeName: str = ...,
    Type: ThirdPartyTypeType = ...,  # (1)
    Arn: str = ...,
) -> Dict[str, Any]:
    ...

1. See ThirdPartyTypeType

Usage example with kwargs

kwargs: DeactivateTypeInputRequestTypeDef = {  # (1)
    "TypeName": ...,
}

parent.deactivate_type(**kwargs)

1. See DeactivateTypeInputRequestTypeDef

delete_change_set

Deletes the specified change set.

Type annotations and code completion for boto3.client("cloudformation").delete_change_set method. boto3 documentation

Method definition

def delete_change_set(
    self,
    *,
    ChangeSetName: str,
    StackName: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteChangeSetInputRequestTypeDef = {  # (1)
    "ChangeSetName": ...,
}

parent.delete_change_set(**kwargs)

1. See DeleteChangeSetInputRequestTypeDef

delete_stack

Deletes a specified stack.

Type annotations and code completion for boto3.client("cloudformation").delete_stack method. boto3 documentation

Method definition

def delete_stack(
    self,
    *,
    StackName: str,
    RetainResources: Sequence[str] = ...,
    RoleARN: str = ...,
    ClientRequestToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteStackInputRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.delete_stack(**kwargs)

1. See DeleteStackInputRequestTypeDef

delete_stack_instances

Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.

Type annotations and code completion for boto3.client("cloudformation").delete_stack_instances method. boto3 documentation

Method definition

def delete_stack_instances(
    self,
    *,
    StackSetName: str,
    Regions: Sequence[str],
    RetainStacks: bool,
    Accounts: Sequence[str] = ...,
    DeploymentTargets: DeploymentTargetsTypeDef = ...,  # (1)
    OperationPreferences: StackSetOperationPreferencesTypeDef = ...,  # (2)
    OperationId: str = ...,
    CallAs: CallAsType = ...,  # (3)
) -> DeleteStackInstancesOutputTypeDef:  # (4)
    ...

1. See DeploymentTargetsTypeDef
2. See StackSetOperationPreferencesTypeDef
3. See CallAsType
4. See DeleteStackInstancesOutputTypeDef

Usage example with kwargs

kwargs: DeleteStackInstancesInputRequestTypeDef = {  # (1)
    "StackSetName": ...,
    "Regions": ...,
    "RetainStacks": ...,
}

parent.delete_stack_instances(**kwargs)

1. See DeleteStackInstancesInputRequestTypeDef

delete_stack_set

Deletes a stack set.

Type annotations and code completion for boto3.client("cloudformation").delete_stack_set method. boto3 documentation

Method definition

def delete_stack_set(
    self,
    *,
    StackSetName: str,
    CallAs: CallAsType = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See CallAsType

Usage example with kwargs

kwargs: DeleteStackSetInputRequestTypeDef = {  # (1)
    "StackSetName": ...,
}

parent.delete_stack_set(**kwargs)

1. See DeleteStackSetInputRequestTypeDef

deregister_type

Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use.

Type annotations and code completion for boto3.client("cloudformation").deregister_type method. boto3 documentation

Method definition

def deregister_type(
    self,
    *,
    Arn: str = ...,
    Type: RegistryTypeType = ...,  # (1)
    TypeName: str = ...,
    VersionId: str = ...,
) -> Dict[str, Any]:
    ...

1. See RegistryTypeType

Usage example with kwargs

kwargs: DeregisterTypeInputRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.deregister_type(**kwargs)

1. See DeregisterTypeInputRequestTypeDef

describe_account_limits

Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in your account.

Type annotations and code completion for boto3.client("cloudformation").describe_account_limits method. boto3 documentation

Method definition

def describe_account_limits(
    self,
    *,
    NextToken: str = ...,
) -> DescribeAccountLimitsOutputTypeDef:  # (1)
    ...

1. See DescribeAccountLimitsOutputTypeDef

Usage example with kwargs

kwargs: DescribeAccountLimitsInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.describe_account_limits(**kwargs)

1. See DescribeAccountLimitsInputRequestTypeDef

describe_change_set

Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the change set.

Type annotations and code completion for boto3.client("cloudformation").describe_change_set method. boto3 documentation

Method definition

def describe_change_set(
    self,
    *,
    ChangeSetName: str,
    StackName: str = ...,
    NextToken: str = ...,
) -> DescribeChangeSetOutputTypeDef:  # (1)
    ...

1. See DescribeChangeSetOutputTypeDef

Usage example with kwargs

kwargs: DescribeChangeSetInputRequestTypeDef = {  # (1)
    "ChangeSetName": ...,
}

parent.describe_change_set(**kwargs)

1. See DescribeChangeSetInputRequestTypeDef

describe_change_set_hooks

Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.

Type annotations and code completion for boto3.client("cloudformation").describe_change_set_hooks method. boto3 documentation

Method definition

def describe_change_set_hooks(
    self,
    *,
    ChangeSetName: str,
    StackName: str = ...,
    NextToken: str = ...,
    LogicalResourceId: str = ...,
) -> DescribeChangeSetHooksOutputTypeDef:  # (1)
    ...

1. See DescribeChangeSetHooksOutputTypeDef

Usage example with kwargs

kwargs: DescribeChangeSetHooksInputRequestTypeDef = {  # (1)
    "ChangeSetName": ...,
}

parent.describe_change_set_hooks(**kwargs)

1. See DescribeChangeSetHooksInputRequestTypeDef

describe_publisher

Returns information about a CloudFormation extension publisher.

Type annotations and code completion for boto3.client("cloudformation").describe_publisher method. boto3 documentation

Method definition

def describe_publisher(
    self,
    *,
    PublisherId: str = ...,
) -> DescribePublisherOutputTypeDef:  # (1)
    ...

1. See DescribePublisherOutputTypeDef

Usage example with kwargs

kwargs: DescribePublisherInputRequestTypeDef = {  # (1)
    "PublisherId": ...,
}

parent.describe_publisher(**kwargs)

1. See DescribePublisherInputRequestTypeDef

describe_stack_drift_detection_status

Returns information about a stack drift detection operation.

Type annotations and code completion for boto3.client("cloudformation").describe_stack_drift_detection_status method. boto3 documentation

Method definition

def describe_stack_drift_detection_status(
    self,
    *,
    StackDriftDetectionId: str,
) -> DescribeStackDriftDetectionStatusOutputTypeDef:  # (1)
    ...

1. See DescribeStackDriftDetectionStatusOutputTypeDef

Usage example with kwargs

kwargs: DescribeStackDriftDetectionStatusInputRequestTypeDef = {  # (1)
    "StackDriftDetectionId": ...,
}

parent.describe_stack_drift_detection_status(**kwargs)

1. See DescribeStackDriftDetectionStatusInputRequestTypeDef

describe_stack_events

Returns all stack related events for a specified stack in reverse chronological order.

Type annotations and code completion for boto3.client("cloudformation").describe_stack_events method. boto3 documentation

Method definition

def describe_stack_events(
    self,
    *,
    StackName: str = ...,
    NextToken: str = ...,
) -> DescribeStackEventsOutputTypeDef:  # (1)
    ...

1. See DescribeStackEventsOutputTypeDef

Usage example with kwargs

kwargs: DescribeStackEventsInputRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.describe_stack_events(**kwargs)

1. See DescribeStackEventsInputRequestTypeDef

describe_stack_instance

Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.

Type annotations and code completion for boto3.client("cloudformation").describe_stack_instance method. boto3 documentation

Method definition

def describe_stack_instance(
    self,
    *,
    StackSetName: str,
    StackInstanceAccount: str,
    StackInstanceRegion: str,
    CallAs: CallAsType = ...,  # (1)
) -> DescribeStackInstanceOutputTypeDef:  # (2)
    ...

1. See CallAsType
2. See DescribeStackInstanceOutputTypeDef

Usage example with kwargs

kwargs: DescribeStackInstanceInputRequestTypeDef = {  # (1)
    "StackSetName": ...,
    "StackInstanceAccount": ...,
    "StackInstanceRegion": ...,
}

parent.describe_stack_instance(**kwargs)

1. See DescribeStackInstanceInputRequestTypeDef

describe_stack_resource

Returns a description of the specified resource in the specified stack.

Type annotations and code completion for boto3.client("cloudformation").describe_stack_resource method. boto3 documentation

Method definition

def describe_stack_resource(
    self,
    *,
    StackName: str,
    LogicalResourceId: str,
) -> DescribeStackResourceOutputTypeDef:  # (1)
    ...

1. See DescribeStackResourceOutputTypeDef

Usage example with kwargs

kwargs: DescribeStackResourceInputRequestTypeDef = {  # (1)
    "StackName": ...,
    "LogicalResourceId": ...,
}

parent.describe_stack_resource(**kwargs)

1. See DescribeStackResourceInputRequestTypeDef

describe_stack_resource_drifts

Returns drift information for the resources that have been checked for drift in the specified stack.

Type annotations and code completion for boto3.client("cloudformation").describe_stack_resource_drifts method. boto3 documentation

Method definition

def describe_stack_resource_drifts(
    self,
    *,
    StackName: str,
    StackResourceDriftStatusFilters: Sequence[StackResourceDriftStatusType] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeStackResourceDriftsOutputTypeDef:  # (2)
    ...

1. See StackResourceDriftStatusType
2. See DescribeStackResourceDriftsOutputTypeDef

Usage example with kwargs

kwargs: DescribeStackResourceDriftsInputRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.describe_stack_resource_drifts(**kwargs)

1. See DescribeStackResourceDriftsInputRequestTypeDef

describe_stack_resources

Returns Amazon Web Services resource descriptions for running and deleted stacks.

Type annotations and code completion for boto3.client("cloudformation").describe_stack_resources method. boto3 documentation

Method definition

def describe_stack_resources(
    self,
    *,
    StackName: str = ...,
    LogicalResourceId: str = ...,
    PhysicalResourceId: str = ...,
) -> DescribeStackResourcesOutputTypeDef:  # (1)
    ...

1. See DescribeStackResourcesOutputTypeDef

Usage example with kwargs

kwargs: DescribeStackResourcesInputRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.describe_stack_resources(**kwargs)

1. See DescribeStackResourcesInputRequestTypeDef

describe_stack_set

Returns the description of the specified stack set.

Type annotations and code completion for boto3.client("cloudformation").describe_stack_set method. boto3 documentation

Method definition

def describe_stack_set(
    self,
    *,
    StackSetName: str,
    CallAs: CallAsType = ...,  # (1)
) -> DescribeStackSetOutputTypeDef:  # (2)
    ...

1. See CallAsType
2. See DescribeStackSetOutputTypeDef

Usage example with kwargs

kwargs: DescribeStackSetInputRequestTypeDef = {  # (1)
    "StackSetName": ...,
}

parent.describe_stack_set(**kwargs)

1. See DescribeStackSetInputRequestTypeDef

describe_stack_set_operation

Returns the description of the specified stack set operation.

Type annotations and code completion for boto3.client("cloudformation").describe_stack_set_operation method. boto3 documentation

Method definition

def describe_stack_set_operation(
    self,
    *,
    StackSetName: str,
    OperationId: str,
    CallAs: CallAsType = ...,  # (1)
) -> DescribeStackSetOperationOutputTypeDef:  # (2)
    ...

1. See CallAsType
2. See DescribeStackSetOperationOutputTypeDef

Usage example with kwargs

kwargs: DescribeStackSetOperationInputRequestTypeDef = {  # (1)
    "StackSetName": ...,
    "OperationId": ...,
}

parent.describe_stack_set_operation(**kwargs)

1. See DescribeStackSetOperationInputRequestTypeDef

describe_stacks

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

Type annotations and code completion for boto3.client("cloudformation").describe_stacks method. boto3 documentation

Method definition

def describe_stacks(
    self,
    *,
    StackName: str = ...,
    NextToken: str = ...,
) -> DescribeStacksOutputTypeDef:  # (1)
    ...

1. See DescribeStacksOutputTypeDef

Usage example with kwargs

kwargs: DescribeStacksInputRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.describe_stacks(**kwargs)

1. See DescribeStacksInputRequestTypeDef

describe_type

Returns detailed information about an extension that has been registered.

Type annotations and code completion for boto3.client("cloudformation").describe_type method. boto3 documentation

Method definition

def describe_type(
    self,
    *,
    Type: RegistryTypeType = ...,  # (1)
    TypeName: str = ...,
    Arn: str = ...,
    VersionId: str = ...,
    PublisherId: str = ...,
    PublicVersionNumber: str = ...,
) -> DescribeTypeOutputTypeDef:  # (2)
    ...

1. See RegistryTypeType
2. See DescribeTypeOutputTypeDef

Usage example with kwargs

kwargs: DescribeTypeInputRequestTypeDef = {  # (1)
    "Type": ...,
}

parent.describe_type(**kwargs)

1. See DescribeTypeInputRequestTypeDef

describe_type_registration

Returns information about an extension's registration, including its current status and type and version identifiers.

Type annotations and code completion for boto3.client("cloudformation").describe_type_registration method. boto3 documentation

Method definition

def describe_type_registration(
    self,
    *,
    RegistrationToken: str,
) -> DescribeTypeRegistrationOutputTypeDef:  # (1)
    ...

1. See DescribeTypeRegistrationOutputTypeDef

Usage example with kwargs

kwargs: DescribeTypeRegistrationInputRequestTypeDef = {  # (1)
    "RegistrationToken": ...,
}

parent.describe_type_registration(**kwargs)

1. See DescribeTypeRegistrationInputRequestTypeDef

detect_stack_drift

Detects whether a stack's actual configuration differs, or has drifted , from it's expected configuration, as defined in the stack template and any values specified as template parameters.

Type annotations and code completion for boto3.client("cloudformation").detect_stack_drift method. boto3 documentation

Method definition

def detect_stack_drift(
    self,
    *,
    StackName: str,
    LogicalResourceIds: Sequence[str] = ...,
) -> DetectStackDriftOutputTypeDef:  # (1)
    ...

1. See DetectStackDriftOutputTypeDef

Usage example with kwargs

kwargs: DetectStackDriftInputRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.detect_stack_drift(**kwargs)

1. See DetectStackDriftInputRequestTypeDef

detect_stack_resource_drift

Returns information about whether a resource's actual configuration differs, or has drifted , from it's expected configuration, as defined in the stack template and any values specified as template parameters.

Type annotations and code completion for boto3.client("cloudformation").detect_stack_resource_drift method. boto3 documentation

Method definition

def detect_stack_resource_drift(
    self,
    *,
    StackName: str,
    LogicalResourceId: str,
) -> DetectStackResourceDriftOutputTypeDef:  # (1)
    ...

1. See DetectStackResourceDriftOutputTypeDef

Usage example with kwargs

kwargs: DetectStackResourceDriftInputRequestTypeDef = {  # (1)
    "StackName": ...,
    "LogicalResourceId": ...,
}

parent.detect_stack_resource_drift(**kwargs)

1. See DetectStackResourceDriftInputRequestTypeDef

detect_stack_set_drift

Detect drift on a stack set.

Type annotations and code completion for boto3.client("cloudformation").detect_stack_set_drift method. boto3 documentation

Method definition

def detect_stack_set_drift(
    self,
    *,
    StackSetName: str,
    OperationPreferences: StackSetOperationPreferencesTypeDef = ...,  # (1)
    OperationId: str = ...,
    CallAs: CallAsType = ...,  # (2)
) -> DetectStackSetDriftOutputTypeDef:  # (3)
    ...

1. See StackSetOperationPreferencesTypeDef
2. See CallAsType
3. See DetectStackSetDriftOutputTypeDef

Usage example with kwargs

kwargs: DetectStackSetDriftInputRequestTypeDef = {  # (1)
    "StackSetName": ...,
}

parent.detect_stack_set_drift(**kwargs)

1. See DetectStackSetDriftInputRequestTypeDef

estimate_template_cost

Returns the estimated monthly cost of a template.

Type annotations and code completion for boto3.client("cloudformation").estimate_template_cost method. boto3 documentation

Method definition

def estimate_template_cost(
    self,
    *,
    TemplateBody: str = ...,
    TemplateURL: str = ...,
    Parameters: Sequence[ParameterTypeDef] = ...,  # (1)
) -> EstimateTemplateCostOutputTypeDef:  # (2)
    ...

1. See ParameterTypeDef
2. See EstimateTemplateCostOutputTypeDef

Usage example with kwargs

kwargs: EstimateTemplateCostInputRequestTypeDef = {  # (1)
    "TemplateBody": ...,
}

parent.estimate_template_cost(**kwargs)

1. See EstimateTemplateCostInputRequestTypeDef

execute_change_set

Updates a stack using the input information that was provided when the specified change set was created.

Type annotations and code completion for boto3.client("cloudformation").execute_change_set method. boto3 documentation

Method definition

def execute_change_set(
    self,
    *,
    ChangeSetName: str,
    StackName: str = ...,
    ClientRequestToken: str = ...,
    DisableRollback: bool = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: ExecuteChangeSetInputRequestTypeDef = {  # (1)
    "ChangeSetName": ...,
}

parent.execute_change_set(**kwargs)

1. See ExecuteChangeSetInputRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("cloudformation").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_stack_policy

Returns the stack policy for a specified stack.

Type annotations and code completion for boto3.client("cloudformation").get_stack_policy method. boto3 documentation

Method definition

def get_stack_policy(
    self,
    *,
    StackName: str,
) -> GetStackPolicyOutputTypeDef:  # (1)
    ...

1. See GetStackPolicyOutputTypeDef

Usage example with kwargs

kwargs: GetStackPolicyInputRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.get_stack_policy(**kwargs)

1. See GetStackPolicyInputRequestTypeDef

get_template

Returns the template body for a specified stack.

Type annotations and code completion for boto3.client("cloudformation").get_template method. boto3 documentation

Method definition

def get_template(
    self,
    *,
    StackName: str = ...,
    ChangeSetName: str = ...,
    TemplateStage: TemplateStageType = ...,  # (1)
) -> GetTemplateOutputTypeDef:  # (2)
    ...

1. See TemplateStageType
2. See GetTemplateOutputTypeDef

Usage example with kwargs

kwargs: GetTemplateInputRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.get_template(**kwargs)

1. See GetTemplateInputRequestTypeDef

get_template_summary

Returns information about a new or existing template.

Type annotations and code completion for boto3.client("cloudformation").get_template_summary method. boto3 documentation

Method definition

def get_template_summary(
    self,
    *,
    TemplateBody: str = ...,
    TemplateURL: str = ...,
    StackName: str = ...,
    StackSetName: str = ...,
    CallAs: CallAsType = ...,  # (1)
) -> GetTemplateSummaryOutputTypeDef:  # (2)
    ...

1. See CallAsType
2. See GetTemplateSummaryOutputTypeDef

Usage example with kwargs

kwargs: GetTemplateSummaryInputRequestTypeDef = {  # (1)
    "TemplateBody": ...,
}

parent.get_template_summary(**kwargs)

1. See GetTemplateSummaryInputRequestTypeDef

import_stacks_to_stack_set

Import existing stacks into a new stack sets.

Type annotations and code completion for boto3.client("cloudformation").import_stacks_to_stack_set method. boto3 documentation

Method definition

def import_stacks_to_stack_set(
    self,
    *,
    StackSetName: str,
    StackIds: Sequence[str] = ...,
    StackIdsUrl: str = ...,
    OrganizationalUnitIds: Sequence[str] = ...,
    OperationPreferences: StackSetOperationPreferencesTypeDef = ...,  # (1)
    OperationId: str = ...,
    CallAs: CallAsType = ...,  # (2)
) -> ImportStacksToStackSetOutputTypeDef:  # (3)
    ...

1. See StackSetOperationPreferencesTypeDef
2. See CallAsType
3. See ImportStacksToStackSetOutputTypeDef

Usage example with kwargs

kwargs: ImportStacksToStackSetInputRequestTypeDef = {  # (1)
    "StackSetName": ...,
}

parent.import_stacks_to_stack_set(**kwargs)

1. See ImportStacksToStackSetInputRequestTypeDef

list_change_sets

Returns the ID and status of each active change set for a stack.

Type annotations and code completion for boto3.client("cloudformation").list_change_sets method. boto3 documentation

Method definition

def list_change_sets(
    self,
    *,
    StackName: str,
    NextToken: str = ...,
) -> ListChangeSetsOutputTypeDef:  # (1)
    ...

1. See ListChangeSetsOutputTypeDef

Usage example with kwargs

kwargs: ListChangeSetsInputRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.list_change_sets(**kwargs)

1. See ListChangeSetsInputRequestTypeDef

list_exports

Lists all exported output values in the account and Region in which you call this action.

Type annotations and code completion for boto3.client("cloudformation").list_exports method. boto3 documentation

Method definition

def list_exports(
    self,
    *,
    NextToken: str = ...,
) -> ListExportsOutputTypeDef:  # (1)
    ...

1. See ListExportsOutputTypeDef

Usage example with kwargs

kwargs: ListExportsInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_exports(**kwargs)

1. See ListExportsInputRequestTypeDef

list_imports

Lists all stacks that are importing an exported output value.

Type annotations and code completion for boto3.client("cloudformation").list_imports method. boto3 documentation

Method definition

def list_imports(
    self,
    *,
    ExportName: str,
    NextToken: str = ...,
) -> ListImportsOutputTypeDef:  # (1)
    ...

1. See ListImportsOutputTypeDef

Usage example with kwargs

kwargs: ListImportsInputRequestTypeDef = {  # (1)
    "ExportName": ...,
}

parent.list_imports(**kwargs)

1. See ListImportsInputRequestTypeDef

list_stack_instances

Returns summary information about stack instances that are associated with the specified stack set.

Type annotations and code completion for boto3.client("cloudformation").list_stack_instances method. boto3 documentation

Method definition

def list_stack_instances(
    self,
    *,
    StackSetName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    Filters: Sequence[StackInstanceFilterTypeDef] = ...,  # (1)
    StackInstanceAccount: str = ...,
    StackInstanceRegion: str = ...,
    CallAs: CallAsType = ...,  # (2)
) -> ListStackInstancesOutputTypeDef:  # (3)
    ...

1. See StackInstanceFilterTypeDef
2. See CallAsType
3. See ListStackInstancesOutputTypeDef

Usage example with kwargs

kwargs: ListStackInstancesInputRequestTypeDef = {  # (1)
    "StackSetName": ...,
}

parent.list_stack_instances(**kwargs)

1. See ListStackInstancesInputRequestTypeDef

list_stack_resources

Returns descriptions of all resources of the specified stack.

Type annotations and code completion for boto3.client("cloudformation").list_stack_resources method. boto3 documentation

Method definition

def list_stack_resources(
    self,
    *,
    StackName: str,
    NextToken: str = ...,
) -> ListStackResourcesOutputTypeDef:  # (1)
    ...

1. See ListStackResourcesOutputTypeDef

Usage example with kwargs

kwargs: ListStackResourcesInputRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.list_stack_resources(**kwargs)

1. See ListStackResourcesInputRequestTypeDef

list_stack_set_operation_results

Returns summary information about the results of a stack set operation.

Type annotations and code completion for boto3.client("cloudformation").list_stack_set_operation_results method. boto3 documentation

Method definition

def list_stack_set_operation_results(
    self,
    *,
    StackSetName: str,
    OperationId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    CallAs: CallAsType = ...,  # (1)
    Filters: Sequence[OperationResultFilterTypeDef] = ...,  # (2)
) -> ListStackSetOperationResultsOutputTypeDef:  # (3)
    ...

1. See CallAsType
2. See OperationResultFilterTypeDef
3. See ListStackSetOperationResultsOutputTypeDef

Usage example with kwargs

kwargs: ListStackSetOperationResultsInputRequestTypeDef = {  # (1)
    "StackSetName": ...,
    "OperationId": ...,
}

parent.list_stack_set_operation_results(**kwargs)

1. See ListStackSetOperationResultsInputRequestTypeDef

list_stack_set_operations

Returns summary information about operations performed on a stack set.

Type annotations and code completion for boto3.client("cloudformation").list_stack_set_operations method. boto3 documentation

Method definition

def list_stack_set_operations(
    self,
    *,
    StackSetName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    CallAs: CallAsType = ...,  # (1)
) -> ListStackSetOperationsOutputTypeDef:  # (2)
    ...

1. See CallAsType
2. See ListStackSetOperationsOutputTypeDef

Usage example with kwargs

kwargs: ListStackSetOperationsInputRequestTypeDef = {  # (1)
    "StackSetName": ...,
}

parent.list_stack_set_operations(**kwargs)

1. See ListStackSetOperationsInputRequestTypeDef

list_stack_sets

Returns summary information about stack sets that are associated with the user.

Type annotations and code completion for boto3.client("cloudformation").list_stack_sets method. boto3 documentation

Method definition

def list_stack_sets(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    Status: StackSetStatusType = ...,  # (1)
    CallAs: CallAsType = ...,  # (2)
) -> ListStackSetsOutputTypeDef:  # (3)
    ...

1. See StackSetStatusType
2. See CallAsType
3. See ListStackSetsOutputTypeDef

Usage example with kwargs

kwargs: ListStackSetsInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_stack_sets(**kwargs)

1. See ListStackSetsInputRequestTypeDef

list_stacks

Returns the summary information for stacks whose status matches the specified StackStatusFilter.

Type annotations and code completion for boto3.client("cloudformation").list_stacks method. boto3 documentation

Method definition

def list_stacks(
    self,
    *,
    NextToken: str = ...,
    StackStatusFilter: Sequence[StackStatusType] = ...,  # (1)
) -> ListStacksOutputTypeDef:  # (2)
    ...

1. See StackStatusType
2. See ListStacksOutputTypeDef

Usage example with kwargs

kwargs: ListStacksInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_stacks(**kwargs)

1. See ListStacksInputRequestTypeDef

list_type_registrations

Returns a list of registration tokens for the specified extension(s).

Type annotations and code completion for boto3.client("cloudformation").list_type_registrations method. boto3 documentation

Method definition

def list_type_registrations(
    self,
    *,
    Type: RegistryTypeType = ...,  # (1)
    TypeName: str = ...,
    TypeArn: str = ...,
    RegistrationStatusFilter: RegistrationStatusType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTypeRegistrationsOutputTypeDef:  # (3)
    ...

1. See RegistryTypeType
2. See RegistrationStatusType
3. See ListTypeRegistrationsOutputTypeDef

Usage example with kwargs

kwargs: ListTypeRegistrationsInputRequestTypeDef = {  # (1)
    "Type": ...,
}

parent.list_type_registrations(**kwargs)

1. See ListTypeRegistrationsInputRequestTypeDef

list_type_versions

Returns summary information about the versions of an extension.

Type annotations and code completion for boto3.client("cloudformation").list_type_versions method. boto3 documentation

Method definition

def list_type_versions(
    self,
    *,
    Type: RegistryTypeType = ...,  # (1)
    TypeName: str = ...,
    Arn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    DeprecatedStatus: DeprecatedStatusType = ...,  # (2)
    PublisherId: str = ...,
) -> ListTypeVersionsOutputTypeDef:  # (3)
    ...

1. See RegistryTypeType
2. See DeprecatedStatusType
3. See ListTypeVersionsOutputTypeDef

Usage example with kwargs

kwargs: ListTypeVersionsInputRequestTypeDef = {  # (1)
    "Type": ...,
}

parent.list_type_versions(**kwargs)

1. See ListTypeVersionsInputRequestTypeDef

list_types

Returns summary information about extension that have been registered with CloudFormation.

Type annotations and code completion for boto3.client("cloudformation").list_types method. boto3 documentation

Method definition

def list_types(
    self,
    *,
    Visibility: VisibilityType = ...,  # (1)
    ProvisioningType: ProvisioningTypeType = ...,  # (2)
    DeprecatedStatus: DeprecatedStatusType = ...,  # (3)
    Type: RegistryTypeType = ...,  # (4)
    Filters: TypeFiltersTypeDef = ...,  # (5)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListTypesOutputTypeDef:  # (6)
    ...

1. See VisibilityType
2. See ProvisioningTypeType
3. See DeprecatedStatusType
4. See RegistryTypeType
5. See TypeFiltersTypeDef
6. See ListTypesOutputTypeDef

Usage example with kwargs

kwargs: ListTypesInputRequestTypeDef = {  # (1)
    "Visibility": ...,
}

parent.list_types(**kwargs)

1. See ListTypesInputRequestTypeDef

publish_type

Publishes the specified extension to the CloudFormation registry as a public extension in this region.

Type annotations and code completion for boto3.client("cloudformation").publish_type method. boto3 documentation

Method definition

def publish_type(
    self,
    *,
    Type: ThirdPartyTypeType = ...,  # (1)
    Arn: str = ...,
    TypeName: str = ...,
    PublicVersionNumber: str = ...,
) -> PublishTypeOutputTypeDef:  # (2)
    ...

1. See ThirdPartyTypeType
2. See PublishTypeOutputTypeDef

Usage example with kwargs

kwargs: PublishTypeInputRequestTypeDef = {  # (1)
    "Type": ...,
}

parent.publish_type(**kwargs)

1. See PublishTypeInputRequestTypeDef

record_handler_progress

Reports progress of a resource handler to CloudFormation.

Type annotations and code completion for boto3.client("cloudformation").record_handler_progress method. boto3 documentation

Method definition

def record_handler_progress(
    self,
    *,
    BearerToken: str,
    OperationStatus: OperationStatusType,  # (1)
    CurrentOperationStatus: OperationStatusType = ...,  # (1)
    StatusMessage: str = ...,
    ErrorCode: HandlerErrorCodeType = ...,  # (3)
    ResourceModel: str = ...,
    ClientRequestToken: str = ...,
) -> Dict[str, Any]:
    ...

1. See OperationStatusType
2. See OperationStatusType
3. See HandlerErrorCodeType

Usage example with kwargs

kwargs: RecordHandlerProgressInputRequestTypeDef = {  # (1)
    "BearerToken": ...,
    "OperationStatus": ...,
}

parent.record_handler_progress(**kwargs)

1. See RecordHandlerProgressInputRequestTypeDef

register_publisher

Registers your account as a publisher of public extensions in the CloudFormation registry.

Type annotations and code completion for boto3.client("cloudformation").register_publisher method. boto3 documentation

Method definition

def register_publisher(
    self,
    *,
    AcceptTermsAndConditions: bool = ...,
    ConnectionArn: str = ...,
) -> RegisterPublisherOutputTypeDef:  # (1)
    ...

1. See RegisterPublisherOutputTypeDef

Usage example with kwargs

kwargs: RegisterPublisherInputRequestTypeDef = {  # (1)
    "AcceptTermsAndConditions": ...,
}

parent.register_publisher(**kwargs)

1. See RegisterPublisherInputRequestTypeDef

register_type

Registers an extension with the CloudFormation service.

Type annotations and code completion for boto3.client("cloudformation").register_type method. boto3 documentation

Method definition

def register_type(
    self,
    *,
    TypeName: str,
    SchemaHandlerPackage: str,
    Type: RegistryTypeType = ...,  # (1)
    LoggingConfig: LoggingConfigTypeDef = ...,  # (2)
    ExecutionRoleArn: str = ...,
    ClientRequestToken: str = ...,
) -> RegisterTypeOutputTypeDef:  # (3)
    ...

1. See RegistryTypeType
2. See LoggingConfigTypeDef
3. See RegisterTypeOutputTypeDef

Usage example with kwargs

kwargs: RegisterTypeInputRequestTypeDef = {  # (1)
    "TypeName": ...,
    "SchemaHandlerPackage": ...,
}

parent.register_type(**kwargs)

1. See RegisterTypeInputRequestTypeDef

rollback_stack

When specifying RollbackStack , you preserve the state of previously provisioned resources when an operation fails.

Type annotations and code completion for boto3.client("cloudformation").rollback_stack method. boto3 documentation

Method definition

def rollback_stack(
    self,
    *,
    StackName: str,
    RoleARN: str = ...,
    ClientRequestToken: str = ...,
) -> RollbackStackOutputTypeDef:  # (1)
    ...

1. See RollbackStackOutputTypeDef

Usage example with kwargs

kwargs: RollbackStackInputRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.rollback_stack(**kwargs)

1. See RollbackStackInputRequestTypeDef

set_stack_policy

Sets a stack policy for a specified stack.

Type annotations and code completion for boto3.client("cloudformation").set_stack_policy method. boto3 documentation

Method definition

def set_stack_policy(
    self,
    *,
    StackName: str,
    StackPolicyBody: str = ...,
    StackPolicyURL: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: SetStackPolicyInputRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.set_stack_policy(**kwargs)

1. See SetStackPolicyInputRequestTypeDef

set_type_configuration

Specifies the configuration data for a registered CloudFormation extension, in the given account and region.

Type annotations and code completion for boto3.client("cloudformation").set_type_configuration method. boto3 documentation

Method definition

def set_type_configuration(
    self,
    *,
    Configuration: str,
    TypeArn: str = ...,
    ConfigurationAlias: str = ...,
    TypeName: str = ...,
    Type: ThirdPartyTypeType = ...,  # (1)
) -> SetTypeConfigurationOutputTypeDef:  # (2)
    ...

1. See ThirdPartyTypeType
2. See SetTypeConfigurationOutputTypeDef

Usage example with kwargs

kwargs: SetTypeConfigurationInputRequestTypeDef = {  # (1)
    "Configuration": ...,
}

parent.set_type_configuration(**kwargs)

1. See SetTypeConfigurationInputRequestTypeDef

set_type_default_version

Specify the default version of an extension.

Type annotations and code completion for boto3.client("cloudformation").set_type_default_version method. boto3 documentation

Method definition

def set_type_default_version(
    self,
    *,
    Arn: str = ...,
    Type: RegistryTypeType = ...,  # (1)
    TypeName: str = ...,
    VersionId: str = ...,
) -> Dict[str, Any]:
    ...

1. See RegistryTypeType

Usage example with kwargs

kwargs: SetTypeDefaultVersionInputRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.set_type_default_version(**kwargs)

1. See SetTypeDefaultVersionInputRequestTypeDef

signal_resource

Sends a signal to the specified resource with a success or failure status.

Type annotations and code completion for boto3.client("cloudformation").signal_resource method. boto3 documentation

Method definition

def signal_resource(
    self,
    *,
    StackName: str,
    LogicalResourceId: str,
    UniqueId: str,
    Status: ResourceSignalStatusType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ResourceSignalStatusType
2. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: SignalResourceInputRequestTypeDef = {  # (1)
    "StackName": ...,
    "LogicalResourceId": ...,
    "UniqueId": ...,
    "Status": ...,
}

parent.signal_resource(**kwargs)

1. See SignalResourceInputRequestTypeDef

stop_stack_set_operation

Stops an in-progress operation on a stack set and its associated stack instances.

Type annotations and code completion for boto3.client("cloudformation").stop_stack_set_operation method. boto3 documentation

Method definition

def stop_stack_set_operation(
    self,
    *,
    StackSetName: str,
    OperationId: str,
    CallAs: CallAsType = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See CallAsType

Usage example with kwargs

kwargs: StopStackSetOperationInputRequestTypeDef = {  # (1)
    "StackSetName": ...,
    "OperationId": ...,
}

parent.stop_stack_set_operation(**kwargs)

1. See StopStackSetOperationInputRequestTypeDef

test_type

Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.

Type annotations and code completion for boto3.client("cloudformation").test_type method. boto3 documentation

Method definition

def test_type(
    self,
    *,
    Arn: str = ...,
    Type: ThirdPartyTypeType = ...,  # (1)
    TypeName: str = ...,
    VersionId: str = ...,
    LogDeliveryBucket: str = ...,
) -> TestTypeOutputTypeDef:  # (2)
    ...

1. See ThirdPartyTypeType
2. See TestTypeOutputTypeDef

Usage example with kwargs

kwargs: TestTypeInputRequestTypeDef = {  # (1)
    "Arn": ...,
}

parent.test_type(**kwargs)

1. See TestTypeInputRequestTypeDef

update_stack

Updates a stack as specified in the template.

Type annotations and code completion for boto3.client("cloudformation").update_stack method. boto3 documentation

Method definition

def update_stack(
    self,
    *,
    StackName: str,
    TemplateBody: str = ...,
    TemplateURL: str = ...,
    UsePreviousTemplate: bool = ...,
    StackPolicyDuringUpdateBody: str = ...,
    StackPolicyDuringUpdateURL: str = ...,
    Parameters: Sequence[ParameterTypeDef] = ...,  # (1)
    Capabilities: Sequence[CapabilityType] = ...,  # (2)
    ResourceTypes: Sequence[str] = ...,
    RoleARN: str = ...,
    RollbackConfiguration: RollbackConfigurationTypeDef = ...,  # (3)
    StackPolicyBody: str = ...,
    StackPolicyURL: str = ...,
    NotificationARNs: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    DisableRollback: bool = ...,
    ClientRequestToken: str = ...,
) -> UpdateStackOutputTypeDef:  # (5)
    ...

1. See ParameterTypeDef
2. See CapabilityType
3. See RollbackConfigurationTypeDef
4. See TagTypeDef
5. See UpdateStackOutputTypeDef

Usage example with kwargs

kwargs: UpdateStackInputRequestTypeDef = {  # (1)
    "StackName": ...,
}

parent.update_stack(**kwargs)

1. See UpdateStackInputRequestTypeDef

update_stack_instances

Updates the parameter values for stack instances for the specified accounts, within the specified Amazon Web Services Regions.

Type annotations and code completion for boto3.client("cloudformation").update_stack_instances method. boto3 documentation

Method definition

def update_stack_instances(
    self,
    *,
    StackSetName: str,
    Regions: Sequence[str],
    Accounts: Sequence[str] = ...,
    DeploymentTargets: DeploymentTargetsTypeDef = ...,  # (1)
    ParameterOverrides: Sequence[ParameterTypeDef] = ...,  # (2)
    OperationPreferences: StackSetOperationPreferencesTypeDef = ...,  # (3)
    OperationId: str = ...,
    CallAs: CallAsType = ...,  # (4)
) -> UpdateStackInstancesOutputTypeDef:  # (5)
    ...

1. See DeploymentTargetsTypeDef
2. See ParameterTypeDef
3. See StackSetOperationPreferencesTypeDef
4. See CallAsType
5. See UpdateStackInstancesOutputTypeDef

Usage example with kwargs

kwargs: UpdateStackInstancesInputRequestTypeDef = {  # (1)
    "StackSetName": ...,
    "Regions": ...,
}

parent.update_stack_instances(**kwargs)

1. See UpdateStackInstancesInputRequestTypeDef

update_stack_set

Updates the stack set, and associated stack instances in the specified accounts and Amazon Web Services Regions.

Type annotations and code completion for boto3.client("cloudformation").update_stack_set method. boto3 documentation

Method definition

def update_stack_set(
    self,
    *,
    StackSetName: str,
    Description: str = ...,
    TemplateBody: str = ...,
    TemplateURL: str = ...,
    UsePreviousTemplate: bool = ...,
    Parameters: Sequence[ParameterTypeDef] = ...,  # (1)
    Capabilities: Sequence[CapabilityType] = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    OperationPreferences: StackSetOperationPreferencesTypeDef = ...,  # (4)
    AdministrationRoleARN: str = ...,
    ExecutionRoleName: str = ...,
    DeploymentTargets: DeploymentTargetsTypeDef = ...,  # (5)
    PermissionModel: PermissionModelsType = ...,  # (6)
    AutoDeployment: AutoDeploymentTypeDef = ...,  # (7)
    OperationId: str = ...,
    Accounts: Sequence[str] = ...,
    Regions: Sequence[str] = ...,
    CallAs: CallAsType = ...,  # (8)
    ManagedExecution: ManagedExecutionTypeDef = ...,  # (9)
) -> UpdateStackSetOutputTypeDef:  # (10)
    ...

1. See ParameterTypeDef
2. See CapabilityType
3. See TagTypeDef
4. See StackSetOperationPreferencesTypeDef
5. See DeploymentTargetsTypeDef
6. See PermissionModelsType
7. See AutoDeploymentTypeDef
8. See CallAsType
9. See ManagedExecutionTypeDef
10. See UpdateStackSetOutputTypeDef

Usage example with kwargs

kwargs: UpdateStackSetInputRequestTypeDef = {  # (1)
    "StackSetName": ...,
}

parent.update_stack_set(**kwargs)

1. See UpdateStackSetInputRequestTypeDef

update_termination_protection

Updates termination protection for the specified stack.

Type annotations and code completion for boto3.client("cloudformation").update_termination_protection method. boto3 documentation

Method definition

def update_termination_protection(
    self,
    *,
    EnableTerminationProtection: bool,
    StackName: str,
) -> UpdateTerminationProtectionOutputTypeDef:  # (1)
    ...

1. See UpdateTerminationProtectionOutputTypeDef

Usage example with kwargs

kwargs: UpdateTerminationProtectionInputRequestTypeDef = {  # (1)
    "EnableTerminationProtection": ...,
    "StackName": ...,
}

parent.update_termination_protection(**kwargs)

1. See UpdateTerminationProtectionInputRequestTypeDef

validate_template

Validates a specified template.

Type annotations and code completion for boto3.client("cloudformation").validate_template method. boto3 documentation

Method definition

def validate_template(
    self,
    *,
    TemplateBody: str = ...,
    TemplateURL: str = ...,
) -> ValidateTemplateOutputTypeDef:  # (1)
    ...

1. See ValidateTemplateOutputTypeDef

Usage example with kwargs

kwargs: ValidateTemplateInputRequestTypeDef = {  # (1)
    "TemplateBody": ...,
}

parent.validate_template(**kwargs)

1. See ValidateTemplateInputRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("cloudformation").get_paginator method with overloads.

• client.get_paginator("describe_account_limits") -> DescribeAccountLimitsPaginator
• client.get_paginator("describe_change_set") -> DescribeChangeSetPaginator
• client.get_paginator("describe_stack_events") -> DescribeStackEventsPaginator
• client.get_paginator("describe_stacks") -> DescribeStacksPaginator
• client.get_paginator("list_change_sets") -> ListChangeSetsPaginator
• client.get_paginator("list_exports") -> ListExportsPaginator
• client.get_paginator("list_imports") -> ListImportsPaginator
• client.get_paginator("list_stack_instances") -> ListStackInstancesPaginator
• client.get_paginator("list_stack_resources") -> ListStackResourcesPaginator
• client.get_paginator("list_stack_set_operation_results") -> ListStackSetOperationResultsPaginator
• client.get_paginator("list_stack_set_operations") -> ListStackSetOperationsPaginator
• client.get_paginator("list_stack_sets") -> ListStackSetsPaginator
• client.get_paginator("list_stacks") -> ListStacksPaginator
• client.get_paginator("list_types") -> ListTypesPaginator

get_waiter

Type annotations and code completion for boto3.client("cloudformation").get_waiter method with overloads.

• client.get_waiter("change_set_create_complete") -> ChangeSetCreateCompleteWaiter
• client.get_waiter("stack_create_complete") -> StackCreateCompleteWaiter
• client.get_waiter("stack_delete_complete") -> StackDeleteCompleteWaiter
• client.get_waiter("stack_exists") -> StackExistsWaiter
• client.get_waiter("stack_import_complete") -> StackImportCompleteWaiter
• client.get_waiter("stack_rollback_complete") -> StackRollbackCompleteWaiter
• client.get_waiter("stack_update_complete") -> StackUpdateCompleteWaiter
• client.get_waiter("type_registration_complete") -> TypeRegistrationCompleteWaiter