Skip to content

CloudFormationClient#

Index > CloudFormation > CloudFormationClient

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

CloudFormationClient#

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

# CloudFormationClient usage example

from boto3.session import Session
from types_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.

# Exceptions.exceptions usage example

client = boto3.client("cloudformation")

try:
    do_something(client)
except (
    client.exceptions.AlreadyExistsException,
    client.exceptions.CFNRegistryException,
    client.exceptions.ChangeSetNotFoundException,
    client.exceptions.ClientError,
    client.exceptions.ConcurrentResourcesLimitExceededException,
    client.exceptions.CreatedButModifiedException,
    client.exceptions.GeneratedTemplateNotFoundException,
    client.exceptions.HookResultNotFoundException,
    client.exceptions.InsufficientCapabilitiesException,
    client.exceptions.InvalidChangeSetStatusException,
    client.exceptions.InvalidOperationException,
    client.exceptions.InvalidStateTransitionException,
    client.exceptions.LimitExceededException,
    client.exceptions.NameAlreadyExistsException,
    client.exceptions.OperationIdAlreadyExistsException,
    client.exceptions.OperationInProgressException,
    client.exceptions.OperationNotFoundException,
    client.exceptions.OperationStatusCheckFailedException,
    client.exceptions.ResourceScanInProgressException,
    client.exceptions.ResourceScanLimitExceededException,
    client.exceptions.ResourceScanNotFoundException,
    client.exceptions.StackInstanceNotFoundException,
    client.exceptions.StackNotFoundException,
    client.exceptions.StackRefactorNotFoundException,
    client.exceptions.StackSetNotEmptyException,
    client.exceptions.StackSetNotFoundException,
    client.exceptions.StaleRequestException,
    client.exceptions.TokenAlreadyExistsException,
    client.exceptions.TypeConfigurationNotFoundException,
    client.exceptions.TypeNotFoundException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_cloudformation.client import Exceptions

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

Methods#

can_paginate#

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

# can_paginate method definition

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

generate_presigned_url#

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

# generate_presigned_url method definition

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

activate_organizations_access#

Activate trusted access with Organizations.

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

# activate_organizations_access method definition

def activate_organizations_access(
    self,
) -> Dict[str, Any]:
    ...

activate_type#

Activates a public third-party extension, such as a resource or module, to make it available for use in stack templates in your current account and Region.

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

# activate_type 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
# activate_type method usage example with argument unpacking

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

parent.activate_type(**kwargs)
  1. See ActivateTypeInputTypeDef

batch_describe_type_configurations#

Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry in your current account and Region.

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

# batch_describe_type_configurations method definition

def batch_describe_type_configurations(
    self,
    *,
    TypeConfigurationIdentifiers: Sequence[TypeConfigurationIdentifierTypeDef],  # (1)
) -> BatchDescribeTypeConfigurationsOutputTypeDef:  # (2)
    ...
  1. See Sequence[TypeConfigurationIdentifierTypeDef]
  2. See BatchDescribeTypeConfigurationsOutputTypeDef
# batch_describe_type_configurations method usage example with argument unpacking

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

parent.batch_describe_type_configurations(**kwargs)
  1. See BatchDescribeTypeConfigurationsInputTypeDef

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

# cancel_update_stack method definition

def cancel_update_stack(
    self,
    *,
    StackName: str,
    ClientRequestToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# cancel_update_stack method usage example with argument unpacking

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

parent.cancel_update_stack(**kwargs)
  1. See CancelUpdateStackInputTypeDef

continue_update_rollback#

Continues rolling back a stack from UPDATE_ROLLBACK_FAILED to UPDATE_ROLLBACK_COMPLETE state.

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

# continue_update_rollback method definition

def continue_update_rollback(
    self,
    *,
    StackName: str,
    RoleARN: str = ...,
    ResourcesToSkip: Sequence[str] = ...,
    ClientRequestToken: str = ...,
) -> Dict[str, Any]:
    ...
# continue_update_rollback method usage example with argument unpacking

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

parent.continue_update_rollback(**kwargs)
  1. See ContinueUpdateRollbackInputTypeDef

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

# create_change_set 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: RollbackConfigurationUnionTypeDef = ...,  # (3)
    NotificationARNs: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    ClientToken: str = ...,
    Description: str = ...,
    ChangeSetType: ChangeSetTypeType = ...,  # (5)
    ResourcesToImport: Sequence[ResourceToImportTypeDef] = ...,  # (6)
    IncludeNestedStacks: bool = ...,
    OnStackFailure: OnStackFailureType = ...,  # (7)
    ImportExistingResources: bool = ...,
) -> CreateChangeSetOutputTypeDef:  # (8)
    ...
  1. See Sequence[ParameterTypeDef]
  2. See Sequence[CapabilityType]
  3. See RollbackConfigurationUnionTypeDef
  4. See Sequence[TagTypeDef]
  5. See ChangeSetTypeType
  6. See Sequence[ResourceToImportTypeDef]
  7. See OnStackFailureType
  8. See CreateChangeSetOutputTypeDef
# create_change_set method usage example with argument unpacking

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

parent.create_change_set(**kwargs)
  1. See CreateChangeSetInputTypeDef

create_generated_template#

Creates a template from existing resources that are not already managed with CloudFormation.

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

# create_generated_template method definition

def create_generated_template(
    self,
    *,
    GeneratedTemplateName: str,
    Resources: Sequence[ResourceDefinitionTypeDef] = ...,  # (1)
    StackName: str = ...,
    TemplateConfiguration: TemplateConfigurationTypeDef = ...,  # (2)
) -> CreateGeneratedTemplateOutputTypeDef:  # (3)
    ...
  1. See Sequence[ResourceDefinitionTypeDef]
  2. See TemplateConfigurationTypeDef
  3. See CreateGeneratedTemplateOutputTypeDef
# create_generated_template method usage example with argument unpacking

kwargs: CreateGeneratedTemplateInputTypeDef = {  # (1)
    "GeneratedTemplateName": ...,
}

parent.create_generated_template(**kwargs)
  1. See CreateGeneratedTemplateInputTypeDef

create_stack#

Creates a stack as specified in the template.

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

# create_stack method definition

def create_stack(
    self,
    *,
    StackName: str,
    TemplateBody: str = ...,
    TemplateURL: str = ...,
    Parameters: Sequence[ParameterTypeDef] = ...,  # (1)
    DisableRollback: bool = ...,
    RollbackConfiguration: RollbackConfigurationUnionTypeDef = ...,  # (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 = ...,
    RetainExceptOnCreate: bool = ...,
) -> CreateStackOutputTypeDef:  # (6)
    ...
  1. See Sequence[ParameterTypeDef]
  2. See RollbackConfigurationUnionTypeDef
  3. See Sequence[CapabilityType]
  4. See OnFailureType
  5. See Sequence[TagTypeDef]
  6. See CreateStackOutputTypeDef
# create_stack method usage example with argument unpacking

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

parent.create_stack(**kwargs)
  1. See CreateStackInputTypeDef

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

# create_stack_instances method definition

def create_stack_instances(
    self,
    *,
    StackSetName: str,
    Regions: Sequence[str],
    Accounts: Sequence[str] = ...,
    DeploymentTargets: DeploymentTargetsUnionTypeDef = ...,  # (1)
    ParameterOverrides: Sequence[ParameterTypeDef] = ...,  # (2)
    OperationPreferences: StackSetOperationPreferencesUnionTypeDef = ...,  # (3)
    OperationId: str = ...,
    CallAs: CallAsType = ...,  # (4)
) -> CreateStackInstancesOutputTypeDef:  # (5)
    ...
  1. See DeploymentTargetsUnionTypeDef
  2. See Sequence[ParameterTypeDef]
  3. See StackSetOperationPreferencesUnionTypeDef
  4. See CallAsType
  5. See CreateStackInstancesOutputTypeDef
# create_stack_instances method usage example with argument unpacking

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

parent.create_stack_instances(**kwargs)
  1. See CreateStackInstancesInputTypeDef

create_stack_refactor#

Creates a refactor across multiple stacks, with the list of stacks and resources that are affected.

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

# create_stack_refactor method definition

def create_stack_refactor(
    self,
    *,
    StackDefinitions: Sequence[StackDefinitionTypeDef],  # (1)
    Description: str = ...,
    EnableStackCreation: bool = ...,
    ResourceMappings: Sequence[ResourceMappingTypeDef] = ...,  # (2)
) -> CreateStackRefactorOutputTypeDef:  # (3)
    ...
  1. See Sequence[StackDefinitionTypeDef]
  2. See Sequence[ResourceMappingTypeDef]
  3. See CreateStackRefactorOutputTypeDef
# create_stack_refactor method usage example with argument unpacking

kwargs: CreateStackRefactorInputTypeDef = {  # (1)
    "StackDefinitions": ...,
}

parent.create_stack_refactor(**kwargs)
  1. See CreateStackRefactorInputTypeDef

create_stack_set#

Creates a StackSet.

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

# create_stack_set 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 Sequence[ParameterTypeDef]
  2. See Sequence[CapabilityType]
  3. See Sequence[TagTypeDef]
  4. See PermissionModelsType
  5. See AutoDeploymentTypeDef
  6. See CallAsType
  7. See ManagedExecutionTypeDef
  8. See CreateStackSetOutputTypeDef
# create_stack_set method usage example with argument unpacking

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

parent.create_stack_set(**kwargs)
  1. See CreateStackSetInputTypeDef

deactivate_organizations_access#

Deactivates trusted access with Organizations.

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

# deactivate_organizations_access method definition

def deactivate_organizations_access(
    self,
) -> Dict[str, Any]:
    ...

deactivate_type#

Deactivates a public third-party extension, such as a resource or module, or a CloudFormation Hook when you no longer use it.

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

# deactivate_type method definition

def deactivate_type(
    self,
    *,
    TypeName: str = ...,
    Type: ThirdPartyTypeType = ...,  # (1)
    Arn: str = ...,
) -> Dict[str, Any]:
    ...
  1. See ThirdPartyTypeType
# deactivate_type method usage example with argument unpacking

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

parent.deactivate_type(**kwargs)
  1. See DeactivateTypeInputTypeDef

delete_change_set#

Deletes the specified change set.

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

# delete_change_set method definition

def delete_change_set(
    self,
    *,
    ChangeSetName: str,
    StackName: str = ...,
) -> Dict[str, Any]:
    ...
# delete_change_set method usage example with argument unpacking

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

parent.delete_change_set(**kwargs)
  1. See DeleteChangeSetInputTypeDef

delete_generated_template#

Deleted a generated template.

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

# delete_generated_template method definition

def delete_generated_template(
    self,
    *,
    GeneratedTemplateName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_generated_template method usage example with argument unpacking

kwargs: DeleteGeneratedTemplateInputTypeDef = {  # (1)
    "GeneratedTemplateName": ...,
}

parent.delete_generated_template(**kwargs)
  1. See DeleteGeneratedTemplateInputTypeDef

delete_stack#

Deletes a specified stack.

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

# delete_stack method definition

def delete_stack(
    self,
    *,
    StackName: str,
    RetainResources: Sequence[str] = ...,
    RoleARN: str = ...,
    ClientRequestToken: str = ...,
    DeletionMode: DeletionModeType = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See DeletionModeType
  2. See EmptyResponseMetadataTypeDef
# delete_stack method usage example with argument unpacking

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

parent.delete_stack(**kwargs)
  1. See DeleteStackInputTypeDef

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

# delete_stack_instances method definition

def delete_stack_instances(
    self,
    *,
    StackSetName: str,
    Regions: Sequence[str],
    RetainStacks: bool,
    Accounts: Sequence[str] = ...,
    DeploymentTargets: DeploymentTargetsUnionTypeDef = ...,  # (1)
    OperationPreferences: StackSetOperationPreferencesUnionTypeDef = ...,  # (2)
    OperationId: str = ...,
    CallAs: CallAsType = ...,  # (3)
) -> DeleteStackInstancesOutputTypeDef:  # (4)
    ...
  1. See DeploymentTargetsUnionTypeDef
  2. See StackSetOperationPreferencesUnionTypeDef
  3. See CallAsType
  4. See DeleteStackInstancesOutputTypeDef
# delete_stack_instances method usage example with argument unpacking

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

parent.delete_stack_instances(**kwargs)
  1. See DeleteStackInstancesInputTypeDef

delete_stack_set#

Deletes a StackSet.

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

# delete_stack_set method definition

def delete_stack_set(
    self,
    *,
    StackSetName: str,
    CallAs: CallAsType = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See CallAsType
# delete_stack_set method usage example with argument unpacking

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

parent.delete_stack_set(**kwargs)
  1. See DeleteStackSetInputTypeDef

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

# deregister_type method definition

def deregister_type(
    self,
    *,
    Arn: str = ...,
    Type: RegistryTypeType = ...,  # (1)
    TypeName: str = ...,
    VersionId: str = ...,
) -> Dict[str, Any]:
    ...
  1. See RegistryTypeType
# deregister_type method usage example with argument unpacking

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

parent.deregister_type(**kwargs)
  1. See DeregisterTypeInputTypeDef

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

# describe_account_limits method definition

def describe_account_limits(
    self,
    *,
    NextToken: str = ...,
) -> DescribeAccountLimitsOutputTypeDef:  # (1)
    ...
  1. See DescribeAccountLimitsOutputTypeDef
# describe_account_limits method usage example with argument unpacking

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

parent.describe_account_limits(**kwargs)
  1. See DescribeAccountLimitsInputTypeDef

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

# describe_change_set method definition

def describe_change_set(
    self,
    *,
    ChangeSetName: str,
    StackName: str = ...,
    NextToken: str = ...,
    IncludePropertyValues: bool = ...,
) -> DescribeChangeSetOutputTypeDef:  # (1)
    ...
  1. See DescribeChangeSetOutputTypeDef
# describe_change_set method usage example with argument unpacking

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

parent.describe_change_set(**kwargs)
  1. See DescribeChangeSetInputTypeDef

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

# describe_change_set_hooks method definition

def describe_change_set_hooks(
    self,
    *,
    ChangeSetName: str,
    StackName: str = ...,
    NextToken: str = ...,
    LogicalResourceId: str = ...,
) -> DescribeChangeSetHooksOutputTypeDef:  # (1)
    ...
  1. See DescribeChangeSetHooksOutputTypeDef
# describe_change_set_hooks method usage example with argument unpacking

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

parent.describe_change_set_hooks(**kwargs)
  1. See DescribeChangeSetHooksInputTypeDef

describe_generated_template#

Describes a generated template.

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

# describe_generated_template method definition

def describe_generated_template(
    self,
    *,
    GeneratedTemplateName: str,
) -> DescribeGeneratedTemplateOutputTypeDef:  # (1)
    ...
  1. See DescribeGeneratedTemplateOutputTypeDef
# describe_generated_template method usage example with argument unpacking

kwargs: DescribeGeneratedTemplateInputTypeDef = {  # (1)
    "GeneratedTemplateName": ...,
}

parent.describe_generated_template(**kwargs)
  1. See DescribeGeneratedTemplateInputTypeDef

describe_organizations_access#

Retrieves information about the account's OrganizationAccess status.

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

# describe_organizations_access method definition

def describe_organizations_access(
    self,
    *,
    CallAs: CallAsType = ...,  # (1)
) -> DescribeOrganizationsAccessOutputTypeDef:  # (2)
    ...
  1. See CallAsType
  2. See DescribeOrganizationsAccessOutputTypeDef
# describe_organizations_access method usage example with argument unpacking

kwargs: DescribeOrganizationsAccessInputTypeDef = {  # (1)
    "CallAs": ...,
}

parent.describe_organizations_access(**kwargs)
  1. See DescribeOrganizationsAccessInputTypeDef

describe_publisher#

Returns information about a CloudFormation extension publisher.

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

# describe_publisher method definition

def describe_publisher(
    self,
    *,
    PublisherId: str = ...,
) -> DescribePublisherOutputTypeDef:  # (1)
    ...
  1. See DescribePublisherOutputTypeDef
# describe_publisher method usage example with argument unpacking

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

parent.describe_publisher(**kwargs)
  1. See DescribePublisherInputTypeDef

describe_resource_scan#

Describes details of a resource scan.

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

# describe_resource_scan method definition

def describe_resource_scan(
    self,
    *,
    ResourceScanId: str,
) -> DescribeResourceScanOutputTypeDef:  # (1)
    ...
  1. See DescribeResourceScanOutputTypeDef
# describe_resource_scan method usage example with argument unpacking

kwargs: DescribeResourceScanInputTypeDef = {  # (1)
    "ResourceScanId": ...,
}

parent.describe_resource_scan(**kwargs)
  1. See DescribeResourceScanInputTypeDef

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

# describe_stack_drift_detection_status method definition

def describe_stack_drift_detection_status(
    self,
    *,
    StackDriftDetectionId: str,
) -> DescribeStackDriftDetectionStatusOutputTypeDef:  # (1)
    ...
  1. See DescribeStackDriftDetectionStatusOutputTypeDef
# describe_stack_drift_detection_status method usage example with argument unpacking

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

parent.describe_stack_drift_detection_status(**kwargs)
  1. See DescribeStackDriftDetectionStatusInputTypeDef

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

# describe_stack_events method definition

def describe_stack_events(
    self,
    *,
    StackName: str = ...,
    NextToken: str = ...,
) -> DescribeStackEventsOutputTypeDef:  # (1)
    ...
  1. See DescribeStackEventsOutputTypeDef
# describe_stack_events method usage example with argument unpacking

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

parent.describe_stack_events(**kwargs)
  1. See DescribeStackEventsInputTypeDef

describe_stack_instance#

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

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

# describe_stack_instance method definition

def describe_stack_instance(
    self,
    *,
    StackSetName: str,
    StackInstanceAccount: str,
    StackInstanceRegion: str,
    CallAs: CallAsType = ...,  # (1)
) -> DescribeStackInstanceOutputTypeDef:  # (2)
    ...
  1. See CallAsType
  2. See DescribeStackInstanceOutputTypeDef
# describe_stack_instance method usage example with argument unpacking

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

parent.describe_stack_instance(**kwargs)
  1. See DescribeStackInstanceInputTypeDef

describe_stack_refactor#

Describes the stack refactor status.

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

# describe_stack_refactor method definition

def describe_stack_refactor(
    self,
    *,
    StackRefactorId: str,
) -> DescribeStackRefactorOutputTypeDef:  # (1)
    ...
  1. See DescribeStackRefactorOutputTypeDef
# describe_stack_refactor method usage example with argument unpacking

kwargs: DescribeStackRefactorInputTypeDef = {  # (1)
    "StackRefactorId": ...,
}

parent.describe_stack_refactor(**kwargs)
  1. See DescribeStackRefactorInputTypeDef

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

# describe_stack_resource method definition

def describe_stack_resource(
    self,
    *,
    StackName: str,
    LogicalResourceId: str,
) -> DescribeStackResourceOutputTypeDef:  # (1)
    ...
  1. See DescribeStackResourceOutputTypeDef
# describe_stack_resource method usage example with argument unpacking

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

parent.describe_stack_resource(**kwargs)
  1. See DescribeStackResourceInputTypeDef

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

# describe_stack_resource_drifts method definition

def describe_stack_resource_drifts(
    self,
    *,
    StackName: str,
    StackResourceDriftStatusFilters: Sequence[StackResourceDriftStatusType] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeStackResourceDriftsOutputTypeDef:  # (2)
    ...
  1. See Sequence[StackResourceDriftStatusType]
  2. See DescribeStackResourceDriftsOutputTypeDef
# describe_stack_resource_drifts method usage example with argument unpacking

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

parent.describe_stack_resource_drifts(**kwargs)
  1. See DescribeStackResourceDriftsInputTypeDef

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

# describe_stack_resources method definition

def describe_stack_resources(
    self,
    *,
    StackName: str = ...,
    LogicalResourceId: str = ...,
    PhysicalResourceId: str = ...,
) -> DescribeStackResourcesOutputTypeDef:  # (1)
    ...
  1. See DescribeStackResourcesOutputTypeDef
# describe_stack_resources method usage example with argument unpacking

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

parent.describe_stack_resources(**kwargs)
  1. See DescribeStackResourcesInputTypeDef

describe_stack_set#

Returns the description of the specified StackSet.

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

# describe_stack_set method definition

def describe_stack_set(
    self,
    *,
    StackSetName: str,
    CallAs: CallAsType = ...,  # (1)
) -> DescribeStackSetOutputTypeDef:  # (2)
    ...
  1. See CallAsType
  2. See DescribeStackSetOutputTypeDef
# describe_stack_set method usage example with argument unpacking

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

parent.describe_stack_set(**kwargs)
  1. See DescribeStackSetInputTypeDef

describe_stack_set_operation#

Returns the description of the specified StackSet operation.

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

# describe_stack_set_operation method definition

def describe_stack_set_operation(
    self,
    *,
    StackSetName: str,
    OperationId: str,
    CallAs: CallAsType = ...,  # (1)
) -> DescribeStackSetOperationOutputTypeDef:  # (2)
    ...
  1. See CallAsType
  2. See DescribeStackSetOperationOutputTypeDef
# describe_stack_set_operation method usage example with argument unpacking

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

parent.describe_stack_set_operation(**kwargs)
  1. See DescribeStackSetOperationInputTypeDef

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

# describe_stacks method definition

def describe_stacks(
    self,
    *,
    StackName: str = ...,
    NextToken: str = ...,
) -> DescribeStacksOutputTypeDef:  # (1)
    ...
  1. See DescribeStacksOutputTypeDef
# describe_stacks method usage example with argument unpacking

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

parent.describe_stacks(**kwargs)
  1. See DescribeStacksInputTypeDef

describe_type#

Returns detailed information about an extension from the CloudFormation registry in your current account and Region.

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

# describe_type 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
# describe_type method usage example with argument unpacking

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

parent.describe_type(**kwargs)
  1. See DescribeTypeInputTypeDef

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

# describe_type_registration method definition

def describe_type_registration(
    self,
    *,
    RegistrationToken: str,
) -> DescribeTypeRegistrationOutputTypeDef:  # (1)
    ...
  1. See DescribeTypeRegistrationOutputTypeDef
# describe_type_registration method usage example with argument unpacking

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

parent.describe_type_registration(**kwargs)
  1. See DescribeTypeRegistrationInputTypeDef

detect_stack_drift#

Detects whether a stack's actual configuration differs, or has drifted, from its 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

# detect_stack_drift method definition

def detect_stack_drift(
    self,
    *,
    StackName: str,
    LogicalResourceIds: Sequence[str] = ...,
) -> DetectStackDriftOutputTypeDef:  # (1)
    ...
  1. See DetectStackDriftOutputTypeDef
# detect_stack_drift method usage example with argument unpacking

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

parent.detect_stack_drift(**kwargs)
  1. See DetectStackDriftInputTypeDef

detect_stack_resource_drift#

Returns information about whether a resource's actual configuration differs, or has drifted, from its 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

# detect_stack_resource_drift method definition

def detect_stack_resource_drift(
    self,
    *,
    StackName: str,
    LogicalResourceId: str,
) -> DetectStackResourceDriftOutputTypeDef:  # (1)
    ...
  1. See DetectStackResourceDriftOutputTypeDef
# detect_stack_resource_drift method usage example with argument unpacking

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

parent.detect_stack_resource_drift(**kwargs)
  1. See DetectStackResourceDriftInputTypeDef

detect_stack_set_drift#

Detect drift on a StackSet.

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

# detect_stack_set_drift method definition

def detect_stack_set_drift(
    self,
    *,
    StackSetName: str,
    OperationPreferences: StackSetOperationPreferencesUnionTypeDef = ...,  # (1)
    OperationId: str = ...,
    CallAs: CallAsType = ...,  # (2)
) -> DetectStackSetDriftOutputTypeDef:  # (3)
    ...
  1. See StackSetOperationPreferencesUnionTypeDef
  2. See CallAsType
  3. See DetectStackSetDriftOutputTypeDef
# detect_stack_set_drift method usage example with argument unpacking

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

parent.detect_stack_set_drift(**kwargs)
  1. See DetectStackSetDriftInputTypeDef

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

# estimate_template_cost method definition

def estimate_template_cost(
    self,
    *,
    TemplateBody: str = ...,
    TemplateURL: str = ...,
    Parameters: Sequence[ParameterTypeDef] = ...,  # (1)
) -> EstimateTemplateCostOutputTypeDef:  # (2)
    ...
  1. See Sequence[ParameterTypeDef]
  2. See EstimateTemplateCostOutputTypeDef
# estimate_template_cost method usage example with argument unpacking

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

parent.estimate_template_cost(**kwargs)
  1. See EstimateTemplateCostInputTypeDef

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

# execute_change_set method definition

def execute_change_set(
    self,
    *,
    ChangeSetName: str,
    StackName: str = ...,
    ClientRequestToken: str = ...,
    DisableRollback: bool = ...,
    RetainExceptOnCreate: bool = ...,
) -> Dict[str, Any]:
    ...
# execute_change_set method usage example with argument unpacking

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

parent.execute_change_set(**kwargs)
  1. See ExecuteChangeSetInputTypeDef

execute_stack_refactor#

Executes the stack refactor operation.

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

# execute_stack_refactor method definition

def execute_stack_refactor(
    self,
    *,
    StackRefactorId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# execute_stack_refactor method usage example with argument unpacking

kwargs: ExecuteStackRefactorInputTypeDef = {  # (1)
    "StackRefactorId": ...,
}

parent.execute_stack_refactor(**kwargs)
  1. See ExecuteStackRefactorInputTypeDef

get_generated_template#

Retrieves a generated template.

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

# get_generated_template method definition

def get_generated_template(
    self,
    *,
    GeneratedTemplateName: str,
    Format: TemplateFormatType = ...,  # (1)
) -> GetGeneratedTemplateOutputTypeDef:  # (2)
    ...
  1. See TemplateFormatType
  2. See GetGeneratedTemplateOutputTypeDef
# get_generated_template method usage example with argument unpacking

kwargs: GetGeneratedTemplateInputTypeDef = {  # (1)
    "GeneratedTemplateName": ...,
}

parent.get_generated_template(**kwargs)
  1. See GetGeneratedTemplateInputTypeDef

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

# get_stack_policy method definition

def get_stack_policy(
    self,
    *,
    StackName: str,
) -> GetStackPolicyOutputTypeDef:  # (1)
    ...
  1. See GetStackPolicyOutputTypeDef
# get_stack_policy method usage example with argument unpacking

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

parent.get_stack_policy(**kwargs)
  1. See GetStackPolicyInputTypeDef

get_template#

Returns the template body for a specified stack.

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

# get_template method definition

def get_template(
    self,
    *,
    StackName: str = ...,
    ChangeSetName: str = ...,
    TemplateStage: TemplateStageType = ...,  # (1)
) -> GetTemplateOutputTypeDef:  # (2)
    ...
  1. See TemplateStageType
  2. See GetTemplateOutputTypeDef
# get_template method usage example with argument unpacking

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

parent.get_template(**kwargs)
  1. See GetTemplateInputTypeDef

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

# get_template_summary method definition

def get_template_summary(
    self,
    *,
    TemplateBody: str = ...,
    TemplateURL: str = ...,
    StackName: str = ...,
    StackSetName: str = ...,
    CallAs: CallAsType = ...,  # (1)
    TemplateSummaryConfig: TemplateSummaryConfigTypeDef = ...,  # (2)
) -> GetTemplateSummaryOutputTypeDef:  # (3)
    ...
  1. See CallAsType
  2. See TemplateSummaryConfigTypeDef
  3. See GetTemplateSummaryOutputTypeDef
# get_template_summary method usage example with argument unpacking

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

parent.get_template_summary(**kwargs)
  1. See GetTemplateSummaryInputTypeDef

import_stacks_to_stack_set#

Import existing stacks into a new StackSets.

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

# import_stacks_to_stack_set method definition

def import_stacks_to_stack_set(
    self,
    *,
    StackSetName: str,
    StackIds: Sequence[str] = ...,
    StackIdsUrl: str = ...,
    OrganizationalUnitIds: Sequence[str] = ...,
    OperationPreferences: StackSetOperationPreferencesUnionTypeDef = ...,  # (1)
    OperationId: str = ...,
    CallAs: CallAsType = ...,  # (2)
) -> ImportStacksToStackSetOutputTypeDef:  # (3)
    ...
  1. See StackSetOperationPreferencesUnionTypeDef
  2. See CallAsType
  3. See ImportStacksToStackSetOutputTypeDef
# import_stacks_to_stack_set method usage example with argument unpacking

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

parent.import_stacks_to_stack_set(**kwargs)
  1. See ImportStacksToStackSetInputTypeDef

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

# list_change_sets method definition

def list_change_sets(
    self,
    *,
    StackName: str,
    NextToken: str = ...,
) -> ListChangeSetsOutputTypeDef:  # (1)
    ...
  1. See ListChangeSetsOutputTypeDef
# list_change_sets method usage example with argument unpacking

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

parent.list_change_sets(**kwargs)
  1. See ListChangeSetsInputTypeDef

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

# list_exports method definition

def list_exports(
    self,
    *,
    NextToken: str = ...,
) -> ListExportsOutputTypeDef:  # (1)
    ...
  1. See ListExportsOutputTypeDef
# list_exports method usage example with argument unpacking

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

parent.list_exports(**kwargs)
  1. See ListExportsInputTypeDef

list_generated_templates#

Lists your generated templates in this Region.

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

# list_generated_templates method definition

def list_generated_templates(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListGeneratedTemplatesOutputTypeDef:  # (1)
    ...
  1. See ListGeneratedTemplatesOutputTypeDef
# list_generated_templates method usage example with argument unpacking

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

parent.list_generated_templates(**kwargs)
  1. See ListGeneratedTemplatesInputTypeDef

list_hook_results#

Returns summaries of invoked Hooks.

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

# list_hook_results method definition

def list_hook_results(
    self,
    *,
    TargetType: ListHookResultsTargetTypeType = ...,  # (1)
    TargetId: str = ...,
    TypeArn: str = ...,
    Status: HookStatusType = ...,  # (2)
    NextToken: str = ...,
) -> ListHookResultsOutputTypeDef:  # (3)
    ...
  1. See ListHookResultsTargetTypeType
  2. See HookStatusType
  3. See ListHookResultsOutputTypeDef
# list_hook_results method usage example with argument unpacking

kwargs: ListHookResultsInputTypeDef = {  # (1)
    "TargetType": ...,
}

parent.list_hook_results(**kwargs)
  1. See ListHookResultsInputTypeDef

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

# list_imports method definition

def list_imports(
    self,
    *,
    ExportName: str,
    NextToken: str = ...,
) -> ListImportsOutputTypeDef:  # (1)
    ...
  1. See ListImportsOutputTypeDef
# list_imports method usage example with argument unpacking

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

parent.list_imports(**kwargs)
  1. See ListImportsInputTypeDef

Lists the related resources for a list of resources from a resource scan.

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

# list_resource_scan_related_resources method definition

def list_resource_scan_related_resources(
    self,
    *,
    ResourceScanId: str,
    Resources: Sequence[ScannedResourceIdentifierTypeDef],  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListResourceScanRelatedResourcesOutputTypeDef:  # (2)
    ...
  1. See Sequence[ScannedResourceIdentifierTypeDef]
  2. See ListResourceScanRelatedResourcesOutputTypeDef
# list_resource_scan_related_resources method usage example with argument unpacking

kwargs: ListResourceScanRelatedResourcesInputTypeDef = {  # (1)
    "ResourceScanId": ...,
    "Resources": ...,
}

parent.list_resource_scan_related_resources(**kwargs)
  1. See ListResourceScanRelatedResourcesInputTypeDef

list_resource_scan_resources#

Lists the resources from a resource scan.

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

# list_resource_scan_resources method definition

def list_resource_scan_resources(
    self,
    *,
    ResourceScanId: str,
    ResourceIdentifier: str = ...,
    ResourceTypePrefix: str = ...,
    TagKey: str = ...,
    TagValue: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListResourceScanResourcesOutputTypeDef:  # (1)
    ...
  1. See ListResourceScanResourcesOutputTypeDef
# list_resource_scan_resources method usage example with argument unpacking

kwargs: ListResourceScanResourcesInputTypeDef = {  # (1)
    "ResourceScanId": ...,
}

parent.list_resource_scan_resources(**kwargs)
  1. See ListResourceScanResourcesInputTypeDef

list_resource_scans#

List the resource scans from newest to oldest.

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

# list_resource_scans method definition

def list_resource_scans(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    ScanTypeFilter: ScanTypeType = ...,  # (1)
) -> ListResourceScansOutputTypeDef:  # (2)
    ...
  1. See ScanTypeType
  2. See ListResourceScansOutputTypeDef
# list_resource_scans method usage example with argument unpacking

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

parent.list_resource_scans(**kwargs)
  1. See ListResourceScansInputTypeDef

list_stack_instance_resource_drifts#

Returns drift information for resources in a stack instance.

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

# list_stack_instance_resource_drifts method definition

def list_stack_instance_resource_drifts(
    self,
    *,
    StackSetName: str,
    StackInstanceAccount: str,
    StackInstanceRegion: str,
    OperationId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    StackInstanceResourceDriftStatuses: Sequence[StackResourceDriftStatusType] = ...,  # (1)
    CallAs: CallAsType = ...,  # (2)
) -> ListStackInstanceResourceDriftsOutputTypeDef:  # (3)
    ...
  1. See Sequence[StackResourceDriftStatusType]
  2. See CallAsType
  3. See ListStackInstanceResourceDriftsOutputTypeDef
# list_stack_instance_resource_drifts method usage example with argument unpacking

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

parent.list_stack_instance_resource_drifts(**kwargs)
  1. See ListStackInstanceResourceDriftsInputTypeDef

list_stack_instances#

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

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

# list_stack_instances 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 Sequence[StackInstanceFilterTypeDef]
  2. See CallAsType
  3. See ListStackInstancesOutputTypeDef
# list_stack_instances method usage example with argument unpacking

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

parent.list_stack_instances(**kwargs)
  1. See ListStackInstancesInputTypeDef

list_stack_refactor_actions#

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

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

# list_stack_refactor_actions method definition

def list_stack_refactor_actions(
    self,
    *,
    StackRefactorId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListStackRefactorActionsOutputTypeDef:  # (1)
    ...
  1. See ListStackRefactorActionsOutputTypeDef
# list_stack_refactor_actions method usage example with argument unpacking

kwargs: ListStackRefactorActionsInputTypeDef = {  # (1)
    "StackRefactorId": ...,
}

parent.list_stack_refactor_actions(**kwargs)
  1. See ListStackRefactorActionsInputTypeDef

list_stack_refactors#

Lists all account stack refactor operations and their statuses.

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

# list_stack_refactors method definition

def list_stack_refactors(
    self,
    *,
    ExecutionStatusFilter: Sequence[StackRefactorExecutionStatusType] = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListStackRefactorsOutputTypeDef:  # (2)
    ...
  1. See Sequence[StackRefactorExecutionStatusType]
  2. See ListStackRefactorsOutputTypeDef
# list_stack_refactors method usage example with argument unpacking

kwargs: ListStackRefactorsInputTypeDef = {  # (1)
    "ExecutionStatusFilter": ...,
}

parent.list_stack_refactors(**kwargs)
  1. See ListStackRefactorsInputTypeDef

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

# list_stack_resources method definition

def list_stack_resources(
    self,
    *,
    StackName: str,
    NextToken: str = ...,
) -> ListStackResourcesOutputTypeDef:  # (1)
    ...
  1. See ListStackResourcesOutputTypeDef
# list_stack_resources method usage example with argument unpacking

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

parent.list_stack_resources(**kwargs)
  1. See ListStackResourcesInputTypeDef

list_stack_set_auto_deployment_targets#

Returns summary information about deployment targets for a StackSet.

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

# list_stack_set_auto_deployment_targets method definition

def list_stack_set_auto_deployment_targets(
    self,
    *,
    StackSetName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    CallAs: CallAsType = ...,  # (1)
) -> ListStackSetAutoDeploymentTargetsOutputTypeDef:  # (2)
    ...
  1. See CallAsType
  2. See ListStackSetAutoDeploymentTargetsOutputTypeDef
# list_stack_set_auto_deployment_targets method usage example with argument unpacking

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

parent.list_stack_set_auto_deployment_targets(**kwargs)
  1. See ListStackSetAutoDeploymentTargetsInputTypeDef

list_stack_set_operation_results#

Returns summary information about the results of a StackSet operation.

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

# list_stack_set_operation_results 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 Sequence[OperationResultFilterTypeDef]
  3. See ListStackSetOperationResultsOutputTypeDef
# list_stack_set_operation_results method usage example with argument unpacking

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

parent.list_stack_set_operation_results(**kwargs)
  1. See ListStackSetOperationResultsInputTypeDef

list_stack_set_operations#

Returns summary information about operations performed on a StackSet.

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

# list_stack_set_operations 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
# list_stack_set_operations method usage example with argument unpacking

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

parent.list_stack_set_operations(**kwargs)
  1. See ListStackSetOperationsInputTypeDef

list_stack_sets#

Returns summary information about StackSets that are associated with the user.

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

# list_stack_sets 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
# list_stack_sets method usage example with argument unpacking

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

parent.list_stack_sets(**kwargs)
  1. See ListStackSetsInputTypeDef

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

# list_stacks method definition

def list_stacks(
    self,
    *,
    NextToken: str = ...,
    StackStatusFilter: Sequence[StackStatusType] = ...,  # (1)
) -> ListStacksOutputTypeDef:  # (2)
    ...
  1. See Sequence[StackStatusType]
  2. See ListStacksOutputTypeDef
# list_stacks method usage example with argument unpacking

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

parent.list_stacks(**kwargs)
  1. See ListStacksInputTypeDef

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

# list_type_registrations 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
# list_type_registrations method usage example with argument unpacking

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

parent.list_type_registrations(**kwargs)
  1. See ListTypeRegistrationsInputTypeDef

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

# list_type_versions 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
# list_type_versions method usage example with argument unpacking

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

parent.list_type_versions(**kwargs)
  1. See ListTypeVersionsInputTypeDef

list_types#

Returns summary information about all extensions, including your private resource types, modules, and Hooks as well as all public extensions from Amazon Web Services and third-party publishers.

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

# list_types 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
# list_types method usage example with argument unpacking

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

parent.list_types(**kwargs)
  1. See ListTypesInputTypeDef

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

# publish_type method definition

def publish_type(
    self,
    *,
    Type: ThirdPartyTypeType = ...,  # (1)
    Arn: str = ...,
    TypeName: str = ...,
    PublicVersionNumber: str = ...,
) -> PublishTypeOutputTypeDef:  # (2)
    ...
  1. See ThirdPartyTypeType
  2. See PublishTypeOutputTypeDef
# publish_type method usage example with argument unpacking

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

parent.publish_type(**kwargs)
  1. See PublishTypeInputTypeDef

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

# record_handler_progress 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
# record_handler_progress method usage example with argument unpacking

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

parent.record_handler_progress(**kwargs)
  1. See RecordHandlerProgressInputTypeDef

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

# register_publisher method definition

def register_publisher(
    self,
    *,
    AcceptTermsAndConditions: bool = ...,
    ConnectionArn: str = ...,
) -> RegisterPublisherOutputTypeDef:  # (1)
    ...
  1. See RegisterPublisherOutputTypeDef
# register_publisher method usage example with argument unpacking

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

parent.register_publisher(**kwargs)
  1. See RegisterPublisherInputTypeDef

register_type#

Registers an extension with the CloudFormation service.

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

# register_type 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
# register_type method usage example with argument unpacking

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

parent.register_type(**kwargs)
  1. See RegisterTypeInputTypeDef

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

# rollback_stack method definition

def rollback_stack(
    self,
    *,
    StackName: str,
    RoleARN: str = ...,
    ClientRequestToken: str = ...,
    RetainExceptOnCreate: bool = ...,
) -> RollbackStackOutputTypeDef:  # (1)
    ...
  1. See RollbackStackOutputTypeDef
# rollback_stack method usage example with argument unpacking

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

parent.rollback_stack(**kwargs)
  1. See RollbackStackInputTypeDef

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

# set_stack_policy method definition

def set_stack_policy(
    self,
    *,
    StackName: str,
    StackPolicyBody: str = ...,
    StackPolicyURL: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# set_stack_policy method usage example with argument unpacking

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

parent.set_stack_policy(**kwargs)
  1. See SetStackPolicyInputTypeDef

set_type_configuration#

Specifies the configuration data for a CloudFormation extension, such as a resource or Hook, in the given account and Region.

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

# set_type_configuration 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
# set_type_configuration method usage example with argument unpacking

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

parent.set_type_configuration(**kwargs)
  1. See SetTypeConfigurationInputTypeDef

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

# set_type_default_version method definition

def set_type_default_version(
    self,
    *,
    Arn: str = ...,
    Type: RegistryTypeType = ...,  # (1)
    TypeName: str = ...,
    VersionId: str = ...,
) -> Dict[str, Any]:
    ...
  1. See RegistryTypeType
# set_type_default_version method usage example with argument unpacking

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

parent.set_type_default_version(**kwargs)
  1. See SetTypeDefaultVersionInputTypeDef

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

# signal_resource method definition

def signal_resource(
    self,
    *,
    StackName: str,
    LogicalResourceId: str,
    UniqueId: str,
    Status: ResourceSignalStatusType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See ResourceSignalStatusType
  2. See EmptyResponseMetadataTypeDef
# signal_resource method usage example with argument unpacking

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

parent.signal_resource(**kwargs)
  1. See SignalResourceInputTypeDef

start_resource_scan#

Starts a scan of the resources in this account in this Region.

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

# start_resource_scan method definition

def start_resource_scan(
    self,
    *,
    ClientRequestToken: str = ...,
    ScanFilters: Sequence[ScanFilterUnionTypeDef] = ...,  # (1)
) -> StartResourceScanOutputTypeDef:  # (2)
    ...
  1. See Sequence[ScanFilterUnionTypeDef]
  2. See StartResourceScanOutputTypeDef
# start_resource_scan method usage example with argument unpacking

kwargs: StartResourceScanInputTypeDef = {  # (1)
    "ClientRequestToken": ...,
}

parent.start_resource_scan(**kwargs)
  1. See StartResourceScanInputTypeDef

stop_stack_set_operation#

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

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

# stop_stack_set_operation method definition

def stop_stack_set_operation(
    self,
    *,
    StackSetName: str,
    OperationId: str,
    CallAs: CallAsType = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See CallAsType
# stop_stack_set_operation method usage example with argument unpacking

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

parent.stop_stack_set_operation(**kwargs)
  1. See StopStackSetOperationInputTypeDef

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

# test_type 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
# test_type method usage example with argument unpacking

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

parent.test_type(**kwargs)
  1. See TestTypeInputTypeDef

update_generated_template#

Updates a generated template.

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

# update_generated_template method definition

def update_generated_template(
    self,
    *,
    GeneratedTemplateName: str,
    NewGeneratedTemplateName: str = ...,
    AddResources: Sequence[ResourceDefinitionTypeDef] = ...,  # (1)
    RemoveResources: Sequence[str] = ...,
    RefreshAllResources: bool = ...,
    TemplateConfiguration: TemplateConfigurationTypeDef = ...,  # (2)
) -> UpdateGeneratedTemplateOutputTypeDef:  # (3)
    ...
  1. See Sequence[ResourceDefinitionTypeDef]
  2. See TemplateConfigurationTypeDef
  3. See UpdateGeneratedTemplateOutputTypeDef
# update_generated_template method usage example with argument unpacking

kwargs: UpdateGeneratedTemplateInputTypeDef = {  # (1)
    "GeneratedTemplateName": ...,
}

parent.update_generated_template(**kwargs)
  1. See UpdateGeneratedTemplateInputTypeDef

update_stack#

Updates a stack as specified in the template.

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

# update_stack 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: RollbackConfigurationUnionTypeDef = ...,  # (3)
    StackPolicyBody: str = ...,
    StackPolicyURL: str = ...,
    NotificationARNs: Sequence[str] = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    DisableRollback: bool = ...,
    ClientRequestToken: str = ...,
    RetainExceptOnCreate: bool = ...,
) -> UpdateStackOutputTypeDef:  # (5)
    ...
  1. See Sequence[ParameterTypeDef]
  2. See Sequence[CapabilityType]
  3. See RollbackConfigurationUnionTypeDef
  4. See Sequence[TagTypeDef]
  5. See UpdateStackOutputTypeDef
# update_stack method usage example with argument unpacking

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

parent.update_stack(**kwargs)
  1. See UpdateStackInputTypeDef

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

# update_stack_instances method definition

def update_stack_instances(
    self,
    *,
    StackSetName: str,
    Regions: Sequence[str],
    Accounts: Sequence[str] = ...,
    DeploymentTargets: DeploymentTargetsUnionTypeDef = ...,  # (1)
    ParameterOverrides: Sequence[ParameterTypeDef] = ...,  # (2)
    OperationPreferences: StackSetOperationPreferencesUnionTypeDef = ...,  # (3)
    OperationId: str = ...,
    CallAs: CallAsType = ...,  # (4)
) -> UpdateStackInstancesOutputTypeDef:  # (5)
    ...
  1. See DeploymentTargetsUnionTypeDef
  2. See Sequence[ParameterTypeDef]
  3. See StackSetOperationPreferencesUnionTypeDef
  4. See CallAsType
  5. See UpdateStackInstancesOutputTypeDef
# update_stack_instances method usage example with argument unpacking

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

parent.update_stack_instances(**kwargs)
  1. See UpdateStackInstancesInputTypeDef

update_stack_set#

Updates the StackSet 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

# update_stack_set 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: StackSetOperationPreferencesUnionTypeDef = ...,  # (4)
    AdministrationRoleARN: str = ...,
    ExecutionRoleName: str = ...,
    DeploymentTargets: DeploymentTargetsUnionTypeDef = ...,  # (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 Sequence[ParameterTypeDef]
  2. See Sequence[CapabilityType]
  3. See Sequence[TagTypeDef]
  4. See StackSetOperationPreferencesUnionTypeDef
  5. See DeploymentTargetsUnionTypeDef
  6. See PermissionModelsType
  7. See AutoDeploymentTypeDef
  8. See CallAsType
  9. See ManagedExecutionTypeDef
  10. See UpdateStackSetOutputTypeDef
# update_stack_set method usage example with argument unpacking

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

parent.update_stack_set(**kwargs)
  1. See UpdateStackSetInputTypeDef

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

# update_termination_protection method definition

def update_termination_protection(
    self,
    *,
    EnableTerminationProtection: bool,
    StackName: str,
) -> UpdateTerminationProtectionOutputTypeDef:  # (1)
    ...
  1. See UpdateTerminationProtectionOutputTypeDef
# update_termination_protection method usage example with argument unpacking

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

parent.update_termination_protection(**kwargs)
  1. See UpdateTerminationProtectionInputTypeDef

validate_template#

Validates a specified template.

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

# validate_template method definition

def validate_template(
    self,
    *,
    TemplateBody: str = ...,
    TemplateURL: str = ...,
) -> ValidateTemplateOutputTypeDef:  # (1)
    ...
  1. See ValidateTemplateOutputTypeDef
# validate_template method usage example with argument unpacking

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

parent.validate_template(**kwargs)
  1. See ValidateTemplateInputTypeDef

get_paginator#

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

get_waiter#

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