Typed dictionaries

Index > CloudControlApi > Typed dictionaries

Auto-generated documentation for CloudControlApi type annotations stubs module mypy-boto3-cloudcontrol.

CancelResourceRequestInputRequestTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import CancelResourceRequestInputRequestTypeDef

def get_value() -> CancelResourceRequestInputRequestTypeDef:
    return {
        "RequestToken": ...,
    }

Definition

class CancelResourceRequestInputRequestTypeDef(TypedDict):
    RequestToken: str,

ProgressEventTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import ProgressEventTypeDef

def get_value() -> ProgressEventTypeDef:
    return {
        "TypeName": ...,
    }

Definition

class ProgressEventTypeDef(TypedDict):
    TypeName: NotRequired[str],
    Identifier: NotRequired[str],
    RequestToken: NotRequired[str],
    Operation: NotRequired[OperationType],  # (1)
    OperationStatus: NotRequired[OperationStatusType],  # (2)
    EventTime: NotRequired[datetime],
    ResourceModel: NotRequired[str],
    StatusMessage: NotRequired[str],
    ErrorCode: NotRequired[HandlerErrorCodeType],  # (3)
    RetryAfter: NotRequired[datetime],

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

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_cloudcontrol.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,

CreateResourceInputRequestTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import CreateResourceInputRequestTypeDef

def get_value() -> CreateResourceInputRequestTypeDef:
    return {
        "TypeName": ...,
        "DesiredState": ...,
    }

Definition

class CreateResourceInputRequestTypeDef(TypedDict):
    TypeName: str,
    DesiredState: str,
    TypeVersionId: NotRequired[str],
    RoleArn: NotRequired[str],
    ClientToken: NotRequired[str],

DeleteResourceInputRequestTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import DeleteResourceInputRequestTypeDef

def get_value() -> DeleteResourceInputRequestTypeDef:
    return {
        "TypeName": ...,
        "Identifier": ...,
    }

Definition

class DeleteResourceInputRequestTypeDef(TypedDict):
    TypeName: str,
    Identifier: str,
    TypeVersionId: NotRequired[str],
    RoleArn: NotRequired[str],
    ClientToken: NotRequired[str],

GetResourceInputRequestTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import GetResourceInputRequestTypeDef

def get_value() -> GetResourceInputRequestTypeDef:
    return {
        "TypeName": ...,
        "Identifier": ...,
    }

Definition

class GetResourceInputRequestTypeDef(TypedDict):
    TypeName: str,
    Identifier: str,
    TypeVersionId: NotRequired[str],
    RoleArn: NotRequired[str],

ResourceDescriptionTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import ResourceDescriptionTypeDef

def get_value() -> ResourceDescriptionTypeDef:
    return {
        "Identifier": ...,
    }

Definition

class ResourceDescriptionTypeDef(TypedDict):
    Identifier: NotRequired[str],
    Properties: NotRequired[str],

GetResourceRequestStatusInputRequestTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import GetResourceRequestStatusInputRequestTypeDef

def get_value() -> GetResourceRequestStatusInputRequestTypeDef:
    return {
        "RequestToken": ...,
    }

Definition

class GetResourceRequestStatusInputRequestTypeDef(TypedDict):
    RequestToken: str,

WaiterConfigTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import WaiterConfigTypeDef

def get_value() -> WaiterConfigTypeDef:
    return {
        "Delay": ...,
    }

Definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }

Definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ResourceRequestStatusFilterTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import ResourceRequestStatusFilterTypeDef

def get_value() -> ResourceRequestStatusFilterTypeDef:
    return {
        "Operations": ...,
    }

Definition

class ResourceRequestStatusFilterTypeDef(TypedDict):
    Operations: NotRequired[Sequence[OperationType]],  # (1)
    OperationStatuses: NotRequired[Sequence[OperationStatusType]],  # (2)

1. See OperationType
2. See OperationStatusType

ListResourcesInputRequestTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import ListResourcesInputRequestTypeDef

def get_value() -> ListResourcesInputRequestTypeDef:
    return {
        "TypeName": ...,
    }

Definition

class ListResourcesInputRequestTypeDef(TypedDict):
    TypeName: str,
    TypeVersionId: NotRequired[str],
    RoleArn: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    ResourceModel: NotRequired[str],

UpdateResourceInputRequestTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import UpdateResourceInputRequestTypeDef

def get_value() -> UpdateResourceInputRequestTypeDef:
    return {
        "TypeName": ...,
        "Identifier": ...,
        "PatchDocument": ...,
    }

Definition

class UpdateResourceInputRequestTypeDef(TypedDict):
    TypeName: str,
    Identifier: str,
    PatchDocument: str,
    TypeVersionId: NotRequired[str],
    RoleArn: NotRequired[str],
    ClientToken: NotRequired[str],

CancelResourceRequestOutputTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import CancelResourceRequestOutputTypeDef

def get_value() -> CancelResourceRequestOutputTypeDef:
    return {
        "ProgressEvent": ...,
        "ResponseMetadata": ...,
    }

Definition

class CancelResourceRequestOutputTypeDef(TypedDict):
    ProgressEvent: ProgressEventTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ProgressEventTypeDef
2. See ResponseMetadataTypeDef

CreateResourceOutputTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import CreateResourceOutputTypeDef

def get_value() -> CreateResourceOutputTypeDef:
    return {
        "ProgressEvent": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateResourceOutputTypeDef(TypedDict):
    ProgressEvent: ProgressEventTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ProgressEventTypeDef
2. See ResponseMetadataTypeDef

DeleteResourceOutputTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import DeleteResourceOutputTypeDef

def get_value() -> DeleteResourceOutputTypeDef:
    return {
        "ProgressEvent": ...,
        "ResponseMetadata": ...,
    }

Definition

class DeleteResourceOutputTypeDef(TypedDict):
    ProgressEvent: ProgressEventTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ProgressEventTypeDef
2. See ResponseMetadataTypeDef

GetResourceRequestStatusOutputTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import GetResourceRequestStatusOutputTypeDef

def get_value() -> GetResourceRequestStatusOutputTypeDef:
    return {
        "ProgressEvent": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetResourceRequestStatusOutputTypeDef(TypedDict):
    ProgressEvent: ProgressEventTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ProgressEventTypeDef
2. See ResponseMetadataTypeDef

ListResourceRequestsOutputTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import ListResourceRequestsOutputTypeDef

def get_value() -> ListResourceRequestsOutputTypeDef:
    return {
        "ResourceRequestStatusSummaries": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListResourceRequestsOutputTypeDef(TypedDict):
    ResourceRequestStatusSummaries: List[ProgressEventTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ProgressEventTypeDef
2. See ResponseMetadataTypeDef

UpdateResourceOutputTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import UpdateResourceOutputTypeDef

def get_value() -> UpdateResourceOutputTypeDef:
    return {
        "ProgressEvent": ...,
        "ResponseMetadata": ...,
    }

Definition

class UpdateResourceOutputTypeDef(TypedDict):
    ProgressEvent: ProgressEventTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ProgressEventTypeDef
2. See ResponseMetadataTypeDef

GetResourceOutputTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import GetResourceOutputTypeDef

def get_value() -> GetResourceOutputTypeDef:
    return {
        "TypeName": ...,
        "ResourceDescription": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetResourceOutputTypeDef(TypedDict):
    TypeName: str,
    ResourceDescription: ResourceDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ResourceDescriptionTypeDef
2. See ResponseMetadataTypeDef

ListResourcesOutputTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import ListResourcesOutputTypeDef

def get_value() -> ListResourcesOutputTypeDef:
    return {
        "TypeName": ...,
        "ResourceDescriptions": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListResourcesOutputTypeDef(TypedDict):
    TypeName: str,
    ResourceDescriptions: List[ResourceDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ResourceDescriptionTypeDef
2. See ResponseMetadataTypeDef

GetResourceRequestStatusInputResourceRequestSuccessWaitTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import GetResourceRequestStatusInputResourceRequestSuccessWaitTypeDef

def get_value() -> GetResourceRequestStatusInputResourceRequestSuccessWaitTypeDef:
    return {
        "RequestToken": ...,
    }

Definition

class GetResourceRequestStatusInputResourceRequestSuccessWaitTypeDef(TypedDict):
    RequestToken: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)

1. See WaiterConfigTypeDef

ListResourcesInputListResourcesPaginateTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import ListResourcesInputListResourcesPaginateTypeDef

def get_value() -> ListResourcesInputListResourcesPaginateTypeDef:
    return {
        "TypeName": ...,
    }

Definition

class ListResourcesInputListResourcesPaginateTypeDef(TypedDict):
    TypeName: str,
    TypeVersionId: NotRequired[str],
    RoleArn: NotRequired[str],
    ResourceModel: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListResourceRequestsInputListResourceRequestsPaginateTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import ListResourceRequestsInputListResourceRequestsPaginateTypeDef

def get_value() -> ListResourceRequestsInputListResourceRequestsPaginateTypeDef:
    return {
        "ResourceRequestStatusFilter": ...,
    }

Definition

class ListResourceRequestsInputListResourceRequestsPaginateTypeDef(TypedDict):
    ResourceRequestStatusFilter: NotRequired[ResourceRequestStatusFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

1. See ResourceRequestStatusFilterTypeDef
2. See PaginatorConfigTypeDef

ListResourceRequestsInputRequestTypeDef

Usage Example

from mypy_boto3_cloudcontrol.type_defs import ListResourceRequestsInputRequestTypeDef

def get_value() -> ListResourceRequestsInputRequestTypeDef:
    return {
        "MaxResults": ...,
    }

Definition

class ListResourceRequestsInputRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    ResourceRequestStatusFilter: NotRequired[ResourceRequestStatusFilterTypeDef],  # (1)

1. See ResourceRequestStatusFilterTypeDef