Typed dictionaries
Index > CloudFormation > Typed dictionaries
Auto-generated documentation for CloudFormation type annotations stubs module mypy-boto3-cloudformation.
AccountGateResultTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import AccountGateResultTypeDef
def get_value() -> AccountGateResultTypeDef:
return {
"Status": ...,
}
Definition
class AccountGateResultTypeDef(TypedDict):
Status: NotRequired[AccountGateStatusType], # (1)
StatusReason: NotRequired[str],
AccountLimitTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import AccountLimitTypeDef
def get_value() -> AccountLimitTypeDef:
return {
"Name": ...,
}
LoggingConfigTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import LoggingConfigTypeDef
def get_value() -> LoggingConfigTypeDef:
return {
"LogRoleArn": ...,
"LogGroupName": ...,
}
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
AutoDeploymentTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import AutoDeploymentTypeDef
def get_value() -> AutoDeploymentTypeDef:
return {
"Enabled": ...,
}
Definition
class AutoDeploymentTypeDef(TypedDict):
Enabled: NotRequired[bool],
RetainStacksOnAccountRemoval: NotRequired[bool],
TypeConfigurationIdentifierTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import TypeConfigurationIdentifierTypeDef
def get_value() -> TypeConfigurationIdentifierTypeDef:
return {
"TypeArn": ...,
}
Definition
class TypeConfigurationIdentifierTypeDef(TypedDict):
TypeArn: NotRequired[str],
TypeConfigurationAlias: NotRequired[str],
TypeConfigurationArn: NotRequired[str],
Type: NotRequired[ThirdPartyTypeType], # (1)
TypeName: NotRequired[str],
TypeConfigurationDetailsTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import TypeConfigurationDetailsTypeDef
def get_value() -> TypeConfigurationDetailsTypeDef:
return {
"Arn": ...,
}
Definition
class TypeConfigurationDetailsTypeDef(TypedDict):
Arn: NotRequired[str],
Alias: NotRequired[str],
Configuration: NotRequired[str],
LastUpdated: NotRequired[datetime],
TypeArn: NotRequired[str],
TypeName: NotRequired[str],
IsDefaultConfiguration: NotRequired[bool],
CancelUpdateStackInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import CancelUpdateStackInputRequestTypeDef
def get_value() -> CancelUpdateStackInputRequestTypeDef:
return {
"StackName": ...,
}
Definition
class CancelUpdateStackInputRequestTypeDef(TypedDict):
StackName: str,
ClientRequestToken: NotRequired[str],
CancelUpdateStackInputStackCancelUpdateTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import CancelUpdateStackInputStackCancelUpdateTypeDef
def get_value() -> CancelUpdateStackInputStackCancelUpdateTypeDef:
return {
"ClientRequestToken": ...,
}
Definition
class CancelUpdateStackInputStackCancelUpdateTypeDef(TypedDict):
ClientRequestToken: NotRequired[str],
ChangeSetHookResourceTargetDetailsTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ChangeSetHookResourceTargetDetailsTypeDef
def get_value() -> ChangeSetHookResourceTargetDetailsTypeDef:
return {
"LogicalResourceId": ...,
}
Definition
class ChangeSetHookResourceTargetDetailsTypeDef(TypedDict):
LogicalResourceId: NotRequired[str],
ResourceType: NotRequired[str],
ResourceAction: NotRequired[ChangeActionType], # (1)
- See ChangeActionType
ChangeSetSummaryTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ChangeSetSummaryTypeDef
def get_value() -> ChangeSetSummaryTypeDef:
return {
"StackId": ...,
}
Definition
class ChangeSetSummaryTypeDef(TypedDict):
StackId: NotRequired[str],
StackName: NotRequired[str],
ChangeSetId: NotRequired[str],
ChangeSetName: NotRequired[str],
ExecutionStatus: NotRequired[ExecutionStatusType], # (1)
Status: NotRequired[ChangeSetStatusType], # (2)
StatusReason: NotRequired[str],
CreationTime: NotRequired[datetime],
Description: NotRequired[str],
IncludeNestedStacks: NotRequired[bool],
ParentChangeSetId: NotRequired[str],
RootChangeSetId: NotRequired[str],
ContinueUpdateRollbackInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ContinueUpdateRollbackInputRequestTypeDef
def get_value() -> ContinueUpdateRollbackInputRequestTypeDef:
return {
"StackName": ...,
}
Definition
class ContinueUpdateRollbackInputRequestTypeDef(TypedDict):
StackName: str,
RoleARN: NotRequired[str],
ResourcesToSkip: NotRequired[Sequence[str]],
ClientRequestToken: NotRequired[str],
ParameterTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ParameterTypeDef
def get_value() -> ParameterTypeDef:
return {
"ParameterKey": ...,
}
Definition
class ParameterTypeDef(TypedDict):
ParameterKey: NotRequired[str],
ParameterValue: NotRequired[str],
UsePreviousValue: NotRequired[bool],
ResolvedValue: NotRequired[str],
ResourceToImportTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ResourceToImportTypeDef
def get_value() -> ResourceToImportTypeDef:
return {
"ResourceType": ...,
"LogicalResourceId": ...,
"ResourceIdentifier": ...,
}
Definition
class ResourceToImportTypeDef(TypedDict):
ResourceType: str,
LogicalResourceId: str,
ResourceIdentifier: Mapping[str, str],
TagTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
DeploymentTargetsTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DeploymentTargetsTypeDef
def get_value() -> DeploymentTargetsTypeDef:
return {
"Accounts": ...,
}
Definition
class DeploymentTargetsTypeDef(TypedDict):
Accounts: NotRequired[Sequence[str]],
AccountsUrl: NotRequired[str],
OrganizationalUnitIds: NotRequired[Sequence[str]],
AccountFilterType: NotRequired[AccountFilterTypeType], # (1)
StackSetOperationPreferencesTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import StackSetOperationPreferencesTypeDef
def get_value() -> StackSetOperationPreferencesTypeDef:
return {
"RegionConcurrencyType": ...,
}
Definition
class StackSetOperationPreferencesTypeDef(TypedDict):
RegionConcurrencyType: NotRequired[RegionConcurrencyTypeType], # (1)
RegionOrder: NotRequired[Sequence[str]],
FailureToleranceCount: NotRequired[int],
FailureTolerancePercentage: NotRequired[int],
MaxConcurrentCount: NotRequired[int],
MaxConcurrentPercentage: NotRequired[int],
ManagedExecutionTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ManagedExecutionTypeDef
def get_value() -> ManagedExecutionTypeDef:
return {
"Active": ...,
}
DeactivateTypeInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DeactivateTypeInputRequestTypeDef
def get_value() -> DeactivateTypeInputRequestTypeDef:
return {
"TypeName": ...,
}
Definition
class DeactivateTypeInputRequestTypeDef(TypedDict):
TypeName: NotRequired[str],
Type: NotRequired[ThirdPartyTypeType], # (1)
Arn: NotRequired[str],
DeleteChangeSetInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DeleteChangeSetInputRequestTypeDef
def get_value() -> DeleteChangeSetInputRequestTypeDef:
return {
"ChangeSetName": ...,
}
Definition
class DeleteChangeSetInputRequestTypeDef(TypedDict):
ChangeSetName: str,
StackName: NotRequired[str],
DeleteStackInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DeleteStackInputRequestTypeDef
def get_value() -> DeleteStackInputRequestTypeDef:
return {
"StackName": ...,
}
Definition
class DeleteStackInputRequestTypeDef(TypedDict):
StackName: str,
RetainResources: NotRequired[Sequence[str]],
RoleARN: NotRequired[str],
ClientRequestToken: NotRequired[str],
DeleteStackInputStackDeleteTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DeleteStackInputStackDeleteTypeDef
def get_value() -> DeleteStackInputStackDeleteTypeDef:
return {
"RetainResources": ...,
}
Definition
class DeleteStackInputStackDeleteTypeDef(TypedDict):
RetainResources: NotRequired[Sequence[str]],
RoleARN: NotRequired[str],
ClientRequestToken: NotRequired[str],
DeleteStackSetInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DeleteStackSetInputRequestTypeDef
def get_value() -> DeleteStackSetInputRequestTypeDef:
return {
"StackSetName": ...,
}
Definition
class DeleteStackSetInputRequestTypeDef(TypedDict):
StackSetName: str,
CallAs: NotRequired[CallAsType], # (1)
- See CallAsType
DeregisterTypeInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DeregisterTypeInputRequestTypeDef
def get_value() -> DeregisterTypeInputRequestTypeDef:
return {
"Arn": ...,
}
Definition
class DeregisterTypeInputRequestTypeDef(TypedDict):
Arn: NotRequired[str],
Type: NotRequired[RegistryTypeType], # (1)
TypeName: NotRequired[str],
VersionId: NotRequired[str],
- See RegistryTypeType
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeAccountLimitsInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DescribeAccountLimitsInputRequestTypeDef
def get_value() -> DescribeAccountLimitsInputRequestTypeDef:
return {
"NextToken": ...,
}
DescribeChangeSetHooksInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DescribeChangeSetHooksInputRequestTypeDef
def get_value() -> DescribeChangeSetHooksInputRequestTypeDef:
return {
"ChangeSetName": ...,
}
Definition
class DescribeChangeSetHooksInputRequestTypeDef(TypedDict):
ChangeSetName: str,
StackName: NotRequired[str],
NextToken: NotRequired[str],
LogicalResourceId: NotRequired[str],
WaiterConfigTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import WaiterConfigTypeDef
def get_value() -> WaiterConfigTypeDef:
return {
"Delay": ...,
}
Definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],
DescribeChangeSetInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DescribeChangeSetInputRequestTypeDef
def get_value() -> DescribeChangeSetInputRequestTypeDef:
return {
"ChangeSetName": ...,
}
Definition
class DescribeChangeSetInputRequestTypeDef(TypedDict):
ChangeSetName: str,
StackName: NotRequired[str],
NextToken: NotRequired[str],
DescribePublisherInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DescribePublisherInputRequestTypeDef
def get_value() -> DescribePublisherInputRequestTypeDef:
return {
"PublisherId": ...,
}
DescribeStackDriftDetectionStatusInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DescribeStackDriftDetectionStatusInputRequestTypeDef
def get_value() -> DescribeStackDriftDetectionStatusInputRequestTypeDef:
return {
"StackDriftDetectionId": ...,
}
Definition
class DescribeStackDriftDetectionStatusInputRequestTypeDef(TypedDict):
StackDriftDetectionId: str,
DescribeStackEventsInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DescribeStackEventsInputRequestTypeDef
def get_value() -> DescribeStackEventsInputRequestTypeDef:
return {
"StackName": ...,
}
Definition
class DescribeStackEventsInputRequestTypeDef(TypedDict):
StackName: NotRequired[str],
NextToken: NotRequired[str],
StackEventTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import StackEventTypeDef
def get_value() -> StackEventTypeDef:
return {
"StackId": ...,
"EventId": ...,
"StackName": ...,
"Timestamp": ...,
}
Definition
class StackEventTypeDef(TypedDict):
StackId: str,
EventId: str,
StackName: str,
Timestamp: datetime,
LogicalResourceId: NotRequired[str],
PhysicalResourceId: NotRequired[str],
ResourceType: NotRequired[str],
ResourceStatus: NotRequired[ResourceStatusType], # (1)
ResourceStatusReason: NotRequired[str],
ResourceProperties: NotRequired[str],
ClientRequestToken: NotRequired[str],
HookType: NotRequired[str],
HookStatus: NotRequired[HookStatusType], # (2)
HookStatusReason: NotRequired[str],
HookInvocationPoint: NotRequired[HookInvocationPointType], # (3)
HookFailureMode: NotRequired[HookFailureModeType], # (4)
- See ResourceStatusType
- See HookStatusType
- See HookInvocationPointType
- See HookFailureModeType
DescribeStackInstanceInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DescribeStackInstanceInputRequestTypeDef
def get_value() -> DescribeStackInstanceInputRequestTypeDef:
return {
"StackSetName": ...,
"StackInstanceAccount": ...,
"StackInstanceRegion": ...,
}
Definition
class DescribeStackInstanceInputRequestTypeDef(TypedDict):
StackSetName: str,
StackInstanceAccount: str,
StackInstanceRegion: str,
CallAs: NotRequired[CallAsType], # (1)
- See CallAsType
DescribeStackResourceDriftsInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DescribeStackResourceDriftsInputRequestTypeDef
def get_value() -> DescribeStackResourceDriftsInputRequestTypeDef:
return {
"StackName": ...,
}
Definition
class DescribeStackResourceDriftsInputRequestTypeDef(TypedDict):
StackName: str,
StackResourceDriftStatusFilters: NotRequired[Sequence[StackResourceDriftStatusType]], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
DescribeStackResourceInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DescribeStackResourceInputRequestTypeDef
def get_value() -> DescribeStackResourceInputRequestTypeDef:
return {
"StackName": ...,
"LogicalResourceId": ...,
}
Definition
class DescribeStackResourceInputRequestTypeDef(TypedDict):
StackName: str,
LogicalResourceId: str,
DescribeStackResourcesInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DescribeStackResourcesInputRequestTypeDef
def get_value() -> DescribeStackResourcesInputRequestTypeDef:
return {
"StackName": ...,
}
Definition
class DescribeStackResourcesInputRequestTypeDef(TypedDict):
StackName: NotRequired[str],
LogicalResourceId: NotRequired[str],
PhysicalResourceId: NotRequired[str],
DescribeStackSetInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DescribeStackSetInputRequestTypeDef
def get_value() -> DescribeStackSetInputRequestTypeDef:
return {
"StackSetName": ...,
}
Definition
class DescribeStackSetInputRequestTypeDef(TypedDict):
StackSetName: str,
CallAs: NotRequired[CallAsType], # (1)
- See CallAsType
DescribeStackSetOperationInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DescribeStackSetOperationInputRequestTypeDef
def get_value() -> DescribeStackSetOperationInputRequestTypeDef:
return {
"StackSetName": ...,
"OperationId": ...,
}
Definition
class DescribeStackSetOperationInputRequestTypeDef(TypedDict):
StackSetName: str,
OperationId: str,
CallAs: NotRequired[CallAsType], # (1)
- See CallAsType
DescribeStacksInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DescribeStacksInputRequestTypeDef
def get_value() -> DescribeStacksInputRequestTypeDef:
return {
"StackName": ...,
}
Definition
class DescribeStacksInputRequestTypeDef(TypedDict):
StackName: NotRequired[str],
NextToken: NotRequired[str],
DescribeTypeInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DescribeTypeInputRequestTypeDef
def get_value() -> DescribeTypeInputRequestTypeDef:
return {
"Type": ...,
}
Definition
class DescribeTypeInputRequestTypeDef(TypedDict):
Type: NotRequired[RegistryTypeType], # (1)
TypeName: NotRequired[str],
Arn: NotRequired[str],
VersionId: NotRequired[str],
PublisherId: NotRequired[str],
PublicVersionNumber: NotRequired[str],
- See RegistryTypeType
RequiredActivatedTypeTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import RequiredActivatedTypeTypeDef
def get_value() -> RequiredActivatedTypeTypeDef:
return {
"TypeNameAlias": ...,
}
Definition
class RequiredActivatedTypeTypeDef(TypedDict):
TypeNameAlias: NotRequired[str],
OriginalTypeName: NotRequired[str],
PublisherId: NotRequired[str],
SupportedMajorVersions: NotRequired[List[int]],
DescribeTypeRegistrationInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DescribeTypeRegistrationInputRequestTypeDef
def get_value() -> DescribeTypeRegistrationInputRequestTypeDef:
return {
"RegistrationToken": ...,
}
DetectStackDriftInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DetectStackDriftInputRequestTypeDef
def get_value() -> DetectStackDriftInputRequestTypeDef:
return {
"StackName": ...,
}
Definition
class DetectStackDriftInputRequestTypeDef(TypedDict):
StackName: str,
LogicalResourceIds: NotRequired[Sequence[str]],
DetectStackResourceDriftInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import DetectStackResourceDriftInputRequestTypeDef
def get_value() -> DetectStackResourceDriftInputRequestTypeDef:
return {
"StackName": ...,
"LogicalResourceId": ...,
}
Definition
class DetectStackResourceDriftInputRequestTypeDef(TypedDict):
StackName: str,
LogicalResourceId: str,
ExecuteChangeSetInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ExecuteChangeSetInputRequestTypeDef
def get_value() -> ExecuteChangeSetInputRequestTypeDef:
return {
"ChangeSetName": ...,
}
Definition
class ExecuteChangeSetInputRequestTypeDef(TypedDict):
ChangeSetName: str,
StackName: NotRequired[str],
ClientRequestToken: NotRequired[str],
DisableRollback: NotRequired[bool],
ExportTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ExportTypeDef
def get_value() -> ExportTypeDef:
return {
"ExportingStackId": ...,
}
Definition
class ExportTypeDef(TypedDict):
ExportingStackId: NotRequired[str],
Name: NotRequired[str],
Value: NotRequired[str],
GetStackPolicyInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import GetStackPolicyInputRequestTypeDef
def get_value() -> GetStackPolicyInputRequestTypeDef:
return {
"StackName": ...,
}
GetTemplateInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import GetTemplateInputRequestTypeDef
def get_value() -> GetTemplateInputRequestTypeDef:
return {
"StackName": ...,
}
Definition
class GetTemplateInputRequestTypeDef(TypedDict):
StackName: NotRequired[str],
ChangeSetName: NotRequired[str],
TemplateStage: NotRequired[TemplateStageType], # (1)
GetTemplateSummaryInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import GetTemplateSummaryInputRequestTypeDef
def get_value() -> GetTemplateSummaryInputRequestTypeDef:
return {
"TemplateBody": ...,
}
Definition
class GetTemplateSummaryInputRequestTypeDef(TypedDict):
TemplateBody: NotRequired[str],
TemplateURL: NotRequired[str],
StackName: NotRequired[str],
StackSetName: NotRequired[str],
CallAs: NotRequired[CallAsType], # (1)
- See CallAsType
ResourceIdentifierSummaryTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ResourceIdentifierSummaryTypeDef
def get_value() -> ResourceIdentifierSummaryTypeDef:
return {
"ResourceType": ...,
}
Definition
class ResourceIdentifierSummaryTypeDef(TypedDict):
ResourceType: NotRequired[str],
LogicalResourceIds: NotRequired[List[str]],
ResourceIdentifiers: NotRequired[List[str]],
ListChangeSetsInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ListChangeSetsInputRequestTypeDef
def get_value() -> ListChangeSetsInputRequestTypeDef:
return {
"StackName": ...,
}
Definition
class ListChangeSetsInputRequestTypeDef(TypedDict):
StackName: str,
NextToken: NotRequired[str],
ListExportsInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ListExportsInputRequestTypeDef
def get_value() -> ListExportsInputRequestTypeDef:
return {
"NextToken": ...,
}
ListImportsInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ListImportsInputRequestTypeDef
def get_value() -> ListImportsInputRequestTypeDef:
return {
"ExportName": ...,
}
Definition
class ListImportsInputRequestTypeDef(TypedDict):
ExportName: str,
NextToken: NotRequired[str],
StackInstanceFilterTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import StackInstanceFilterTypeDef
def get_value() -> StackInstanceFilterTypeDef:
return {
"Name": ...,
}
Definition
class StackInstanceFilterTypeDef(TypedDict):
Name: NotRequired[StackInstanceFilterNameType], # (1)
Values: NotRequired[str],
ListStackResourcesInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ListStackResourcesInputRequestTypeDef
def get_value() -> ListStackResourcesInputRequestTypeDef:
return {
"StackName": ...,
}
Definition
class ListStackResourcesInputRequestTypeDef(TypedDict):
StackName: str,
NextToken: NotRequired[str],
OperationResultFilterTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import OperationResultFilterTypeDef
def get_value() -> OperationResultFilterTypeDef:
return {
"Name": ...,
}
Definition
class OperationResultFilterTypeDef(TypedDict):
Name: NotRequired[OperationResultFilterNameType], # (1)
Values: NotRequired[str],
ListStackSetOperationsInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ListStackSetOperationsInputRequestTypeDef
def get_value() -> ListStackSetOperationsInputRequestTypeDef:
return {
"StackSetName": ...,
}
Definition
class ListStackSetOperationsInputRequestTypeDef(TypedDict):
StackSetName: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
CallAs: NotRequired[CallAsType], # (1)
- See CallAsType
ListStackSetsInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ListStackSetsInputRequestTypeDef
def get_value() -> ListStackSetsInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListStackSetsInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Status: NotRequired[StackSetStatusType], # (1)
CallAs: NotRequired[CallAsType], # (2)
- See StackSetStatusType
- See CallAsType
ListStacksInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ListStacksInputRequestTypeDef
def get_value() -> ListStacksInputRequestTypeDef:
return {
"NextToken": ...,
}
Definition
class ListStacksInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
StackStatusFilter: NotRequired[Sequence[StackStatusType]], # (1)
- See StackStatusType
ListTypeRegistrationsInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ListTypeRegistrationsInputRequestTypeDef
def get_value() -> ListTypeRegistrationsInputRequestTypeDef:
return {
"Type": ...,
}
Definition
class ListTypeRegistrationsInputRequestTypeDef(TypedDict):
Type: NotRequired[RegistryTypeType], # (1)
TypeName: NotRequired[str],
TypeArn: NotRequired[str],
RegistrationStatusFilter: NotRequired[RegistrationStatusType], # (2)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListTypeVersionsInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ListTypeVersionsInputRequestTypeDef
def get_value() -> ListTypeVersionsInputRequestTypeDef:
return {
"Type": ...,
}
Definition
class ListTypeVersionsInputRequestTypeDef(TypedDict):
Type: NotRequired[RegistryTypeType], # (1)
TypeName: NotRequired[str],
Arn: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
DeprecatedStatus: NotRequired[DeprecatedStatusType], # (2)
PublisherId: NotRequired[str],
- See RegistryTypeType
- See DeprecatedStatusType
TypeVersionSummaryTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import TypeVersionSummaryTypeDef
def get_value() -> TypeVersionSummaryTypeDef:
return {
"Type": ...,
}
Definition
class TypeVersionSummaryTypeDef(TypedDict):
Type: NotRequired[RegistryTypeType], # (1)
TypeName: NotRequired[str],
VersionId: NotRequired[str],
IsDefaultVersion: NotRequired[bool],
Arn: NotRequired[str],
TimeCreated: NotRequired[datetime],
Description: NotRequired[str],
PublicVersionNumber: NotRequired[str],
- See RegistryTypeType
TypeFiltersTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import TypeFiltersTypeDef
def get_value() -> TypeFiltersTypeDef:
return {
"Category": ...,
}
Definition
class TypeFiltersTypeDef(TypedDict):
Category: NotRequired[CategoryType], # (1)
PublisherId: NotRequired[str],
TypeNamePrefix: NotRequired[str],
- See CategoryType
TypeSummaryTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import TypeSummaryTypeDef
def get_value() -> TypeSummaryTypeDef:
return {
"Type": ...,
}
Definition
class TypeSummaryTypeDef(TypedDict):
Type: NotRequired[RegistryTypeType], # (1)
TypeName: NotRequired[str],
DefaultVersionId: NotRequired[str],
TypeArn: NotRequired[str],
LastUpdated: NotRequired[datetime],
Description: NotRequired[str],
PublisherId: NotRequired[str],
OriginalTypeName: NotRequired[str],
PublicVersionNumber: NotRequired[str],
LatestPublicVersion: NotRequired[str],
PublisherIdentity: NotRequired[IdentityProviderType], # (2)
PublisherName: NotRequired[str],
IsActivated: NotRequired[bool],
- See RegistryTypeType
- See IdentityProviderType
ModuleInfoTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ModuleInfoTypeDef
def get_value() -> ModuleInfoTypeDef:
return {
"TypeHierarchy": ...,
}
Definition
class ModuleInfoTypeDef(TypedDict):
TypeHierarchy: NotRequired[str],
LogicalIdHierarchy: NotRequired[str],
OutputTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import OutputTypeDef
def get_value() -> OutputTypeDef:
return {
"OutputKey": ...,
}
Definition
class OutputTypeDef(TypedDict):
OutputKey: NotRequired[str],
OutputValue: NotRequired[str],
Description: NotRequired[str],
ExportName: NotRequired[str],
ParameterConstraintsTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ParameterConstraintsTypeDef
def get_value() -> ParameterConstraintsTypeDef:
return {
"AllowedValues": ...,
}
PhysicalResourceIdContextKeyValuePairTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import PhysicalResourceIdContextKeyValuePairTypeDef
def get_value() -> PhysicalResourceIdContextKeyValuePairTypeDef:
return {
"Key": ...,
"Value": ...,
}
PropertyDifferenceTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import PropertyDifferenceTypeDef
def get_value() -> PropertyDifferenceTypeDef:
return {
"PropertyPath": ...,
"ExpectedValue": ...,
"ActualValue": ...,
"DifferenceType": ...,
}
Definition
class PropertyDifferenceTypeDef(TypedDict):
PropertyPath: str,
ExpectedValue: str,
ActualValue: str,
DifferenceType: DifferenceTypeType, # (1)
PublishTypeInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import PublishTypeInputRequestTypeDef
def get_value() -> PublishTypeInputRequestTypeDef:
return {
"Type": ...,
}
Definition
class PublishTypeInputRequestTypeDef(TypedDict):
Type: NotRequired[ThirdPartyTypeType], # (1)
Arn: NotRequired[str],
TypeName: NotRequired[str],
PublicVersionNumber: NotRequired[str],
RecordHandlerProgressInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import RecordHandlerProgressInputRequestTypeDef
def get_value() -> RecordHandlerProgressInputRequestTypeDef:
return {
"BearerToken": ...,
"OperationStatus": ...,
}
Definition
class RecordHandlerProgressInputRequestTypeDef(TypedDict):
BearerToken: str,
OperationStatus: OperationStatusType, # (1)
CurrentOperationStatus: NotRequired[OperationStatusType], # (1)
StatusMessage: NotRequired[str],
ErrorCode: NotRequired[HandlerErrorCodeType], # (3)
ResourceModel: NotRequired[str],
ClientRequestToken: NotRequired[str],
RegisterPublisherInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import RegisterPublisherInputRequestTypeDef
def get_value() -> RegisterPublisherInputRequestTypeDef:
return {
"AcceptTermsAndConditions": ...,
}
Definition
class RegisterPublisherInputRequestTypeDef(TypedDict):
AcceptTermsAndConditions: NotRequired[bool],
ConnectionArn: NotRequired[str],
ResourceTargetDefinitionTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ResourceTargetDefinitionTypeDef
def get_value() -> ResourceTargetDefinitionTypeDef:
return {
"Attribute": ...,
}
Definition
class ResourceTargetDefinitionTypeDef(TypedDict):
Attribute: NotRequired[ResourceAttributeType], # (1)
Name: NotRequired[str],
RequiresRecreation: NotRequired[RequiresRecreationType], # (2)
RollbackTriggerTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import RollbackTriggerTypeDef
def get_value() -> RollbackTriggerTypeDef:
return {
"Arn": ...,
"Type": ...,
}
RollbackStackInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import RollbackStackInputRequestTypeDef
def get_value() -> RollbackStackInputRequestTypeDef:
return {
"StackName": ...,
}
Definition
class RollbackStackInputRequestTypeDef(TypedDict):
StackName: str,
RoleARN: NotRequired[str],
ClientRequestToken: NotRequired[str],
ServiceResourceEventRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ServiceResourceEventRequestTypeDef
def get_value() -> ServiceResourceEventRequestTypeDef:
return {
"id": ...,
}
ServiceResourceStackRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ServiceResourceStackRequestTypeDef
def get_value() -> ServiceResourceStackRequestTypeDef:
return {
"name": ...,
}
ServiceResourceStackResourceRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ServiceResourceStackResourceRequestTypeDef
def get_value() -> ServiceResourceStackResourceRequestTypeDef:
return {
"stack_name": ...,
"logical_id": ...,
}
Definition
class ServiceResourceStackResourceRequestTypeDef(TypedDict):
stack_name: str,
logical_id: str,
ServiceResourceStackResourceSummaryRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ServiceResourceStackResourceSummaryRequestTypeDef
def get_value() -> ServiceResourceStackResourceSummaryRequestTypeDef:
return {
"stack_name": ...,
"logical_id": ...,
}
Definition
class ServiceResourceStackResourceSummaryRequestTypeDef(TypedDict):
stack_name: str,
logical_id: str,
SetStackPolicyInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import SetStackPolicyInputRequestTypeDef
def get_value() -> SetStackPolicyInputRequestTypeDef:
return {
"StackName": ...,
}
Definition
class SetStackPolicyInputRequestTypeDef(TypedDict):
StackName: str,
StackPolicyBody: NotRequired[str],
StackPolicyURL: NotRequired[str],
SetTypeConfigurationInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import SetTypeConfigurationInputRequestTypeDef
def get_value() -> SetTypeConfigurationInputRequestTypeDef:
return {
"Configuration": ...,
}
Definition
class SetTypeConfigurationInputRequestTypeDef(TypedDict):
Configuration: str,
TypeArn: NotRequired[str],
ConfigurationAlias: NotRequired[str],
TypeName: NotRequired[str],
Type: NotRequired[ThirdPartyTypeType], # (1)
SetTypeDefaultVersionInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import SetTypeDefaultVersionInputRequestTypeDef
def get_value() -> SetTypeDefaultVersionInputRequestTypeDef:
return {
"Arn": ...,
}
Definition
class SetTypeDefaultVersionInputRequestTypeDef(TypedDict):
Arn: NotRequired[str],
Type: NotRequired[RegistryTypeType], # (1)
TypeName: NotRequired[str],
VersionId: NotRequired[str],
- See RegistryTypeType
SignalResourceInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import SignalResourceInputRequestTypeDef
def get_value() -> SignalResourceInputRequestTypeDef:
return {
"StackName": ...,
"LogicalResourceId": ...,
"UniqueId": ...,
"Status": ...,
}
Definition
class SignalResourceInputRequestTypeDef(TypedDict):
StackName: str,
LogicalResourceId: str,
UniqueId: str,
Status: ResourceSignalStatusType, # (1)
StackDriftInformationSummaryTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import StackDriftInformationSummaryTypeDef
def get_value() -> StackDriftInformationSummaryTypeDef:
return {
"StackDriftStatus": ...,
}
Definition
class StackDriftInformationSummaryTypeDef(TypedDict):
StackDriftStatus: StackDriftStatusType, # (1)
LastCheckTimestamp: NotRequired[datetime],
StackDriftInformationTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import StackDriftInformationTypeDef
def get_value() -> StackDriftInformationTypeDef:
return {
"StackDriftStatus": ...,
}
Definition
class StackDriftInformationTypeDef(TypedDict):
StackDriftStatus: StackDriftStatusType, # (1)
LastCheckTimestamp: NotRequired[datetime],
StackInstanceComprehensiveStatusTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import StackInstanceComprehensiveStatusTypeDef
def get_value() -> StackInstanceComprehensiveStatusTypeDef:
return {
"DetailedStatus": ...,
}
Definition
class StackInstanceComprehensiveStatusTypeDef(TypedDict):
DetailedStatus: NotRequired[StackInstanceDetailedStatusType], # (1)
StackResourceDriftInformationTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import StackResourceDriftInformationTypeDef
def get_value() -> StackResourceDriftInformationTypeDef:
return {
"StackResourceDriftStatus": ...,
}
Definition
class StackResourceDriftInformationTypeDef(TypedDict):
StackResourceDriftStatus: StackResourceDriftStatusType, # (1)
LastCheckTimestamp: NotRequired[datetime],
StackResourceDriftInformationSummaryTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import StackResourceDriftInformationSummaryTypeDef
def get_value() -> StackResourceDriftInformationSummaryTypeDef:
return {
"StackResourceDriftStatus": ...,
}
Definition
class StackResourceDriftInformationSummaryTypeDef(TypedDict):
StackResourceDriftStatus: StackResourceDriftStatusType, # (1)
LastCheckTimestamp: NotRequired[datetime],
StackResourceRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import StackResourceRequestTypeDef
def get_value() -> StackResourceRequestTypeDef:
return {
"logical_id": ...,
}
StackSetDriftDetectionDetailsTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import StackSetDriftDetectionDetailsTypeDef
def get_value() -> StackSetDriftDetectionDetailsTypeDef:
return {
"DriftStatus": ...,
}
Definition
class StackSetDriftDetectionDetailsTypeDef(TypedDict):
DriftStatus: NotRequired[StackSetDriftStatusType], # (1)
DriftDetectionStatus: NotRequired[StackSetDriftDetectionStatusType], # (2)
LastDriftCheckTimestamp: NotRequired[datetime],
TotalStackInstancesCount: NotRequired[int],
DriftedStackInstancesCount: NotRequired[int],
InSyncStackInstancesCount: NotRequired[int],
InProgressStackInstancesCount: NotRequired[int],
FailedStackInstancesCount: NotRequired[int],
StackSetOperationStatusDetailsTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import StackSetOperationStatusDetailsTypeDef
def get_value() -> StackSetOperationStatusDetailsTypeDef:
return {
"FailedStackInstancesCount": ...,
}
Definition
class StackSetOperationStatusDetailsTypeDef(TypedDict):
FailedStackInstancesCount: NotRequired[int],
StopStackSetOperationInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import StopStackSetOperationInputRequestTypeDef
def get_value() -> StopStackSetOperationInputRequestTypeDef:
return {
"StackSetName": ...,
"OperationId": ...,
}
Definition
class StopStackSetOperationInputRequestTypeDef(TypedDict):
StackSetName: str,
OperationId: str,
CallAs: NotRequired[CallAsType], # (1)
- See CallAsType
TemplateParameterTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import TemplateParameterTypeDef
def get_value() -> TemplateParameterTypeDef:
return {
"ParameterKey": ...,
}
Definition
class TemplateParameterTypeDef(TypedDict):
ParameterKey: NotRequired[str],
DefaultValue: NotRequired[str],
NoEcho: NotRequired[bool],
Description: NotRequired[str],
TestTypeInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import TestTypeInputRequestTypeDef
def get_value() -> TestTypeInputRequestTypeDef:
return {
"Arn": ...,
}
Definition
class TestTypeInputRequestTypeDef(TypedDict):
Arn: NotRequired[str],
Type: NotRequired[ThirdPartyTypeType], # (1)
TypeName: NotRequired[str],
VersionId: NotRequired[str],
LogDeliveryBucket: NotRequired[str],
UpdateTerminationProtectionInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import UpdateTerminationProtectionInputRequestTypeDef
def get_value() -> UpdateTerminationProtectionInputRequestTypeDef:
return {
"EnableTerminationProtection": ...,
"StackName": ...,
}
Definition
class UpdateTerminationProtectionInputRequestTypeDef(TypedDict):
EnableTerminationProtection: bool,
StackName: str,
ValidateTemplateInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ValidateTemplateInputRequestTypeDef
def get_value() -> ValidateTemplateInputRequestTypeDef:
return {
"TemplateBody": ...,
}
Definition
class ValidateTemplateInputRequestTypeDef(TypedDict):
TemplateBody: NotRequired[str],
TemplateURL: NotRequired[str],
StackSetOperationResultSummaryTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import StackSetOperationResultSummaryTypeDef
def get_value() -> StackSetOperationResultSummaryTypeDef:
return {
"Account": ...,
}
Definition
class StackSetOperationResultSummaryTypeDef(TypedDict):
Account: NotRequired[str],
Region: NotRequired[str],
Status: NotRequired[StackSetOperationResultStatusType], # (1)
StatusReason: NotRequired[str],
AccountGateResult: NotRequired[AccountGateResultTypeDef], # (2)
OrganizationalUnitId: NotRequired[str],
ActivateTypeInputRequestTypeDef
Usage Example
from mypy_boto3_cloudformation.type_defs import ActivateTypeInputRequestTypeDef
def get_value() -> ActivateTypeInputRequestTypeDef:
return {
"Type": ...,
}
Definition
class ActivateTypeInputRequestTypeDef(TypedDict):
Type: NotRequired[ThirdPartyTypeType], # (1)
PublicTypeArn: NotRequired[str],
PublisherId: NotRequired[str],
TypeName: NotRequired[str],
TypeNameAlias: NotRequired[str],
AutoUpdate: NotRequired[bool],
LoggingConfig: NotRequired[LoggingConfigTypeDef], # (2)
ExecutionRoleArn: NotRequired[str],
VersionBump: NotRequired[VersionBumpType], # (3)
MajorVersion: NotRequired[int],
- See ThirdPartyTypeType
- See LoggingConfigTypeDef
- See VersionBumpType