Skip to content

Type definitions#

Index > CloudControlApi > Type definitions

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

CancelResourceRequestInputRequestTypeDef#

# CancelResourceRequestInputRequestTypeDef definition

class CancelResourceRequestInputRequestTypeDef(TypedDict):
    RequestToken: str,

ProgressEventTypeDef#

# ProgressEventTypeDef definition

class ProgressEventTypeDef(TypedDict):
    TypeName: NotRequired[str],
    Identifier: NotRequired[str],
    RequestToken: NotRequired[str],
    HooksRequestToken: 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#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CreateResourceInputRequestTypeDef#

# CreateResourceInputRequestTypeDef definition

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

DeleteResourceInputRequestTypeDef#

# DeleteResourceInputRequestTypeDef definition

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

GetResourceInputRequestTypeDef#

# GetResourceInputRequestTypeDef definition

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

ResourceDescriptionTypeDef#

# ResourceDescriptionTypeDef definition

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

GetResourceRequestStatusInputRequestTypeDef#

# GetResourceRequestStatusInputRequestTypeDef definition

class GetResourceRequestStatusInputRequestTypeDef(TypedDict):
    RequestToken: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

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

HookProgressEventTypeDef#

# HookProgressEventTypeDef definition

class HookProgressEventTypeDef(TypedDict):
    HookTypeName: NotRequired[str],
    HookTypeVersionId: NotRequired[str],
    HookTypeArn: NotRequired[str],
    InvocationPoint: NotRequired[str],
    HookStatus: NotRequired[str],
    HookEventTime: NotRequired[datetime],
    HookStatusMessage: NotRequired[str],
    FailureMode: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ResourceRequestStatusFilterTypeDef#

# ResourceRequestStatusFilterTypeDef definition

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

ListResourcesInputRequestTypeDef#

# ListResourcesInputRequestTypeDef definition

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

UpdateResourceInputRequestTypeDef#

# UpdateResourceInputRequestTypeDef definition

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

CancelResourceRequestOutputTypeDef#

# CancelResourceRequestOutputTypeDef definition

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

CreateResourceOutputTypeDef#

# CreateResourceOutputTypeDef definition

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

DeleteResourceOutputTypeDef#

# DeleteResourceOutputTypeDef definition

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

ListResourceRequestsOutputTypeDef#

# ListResourceRequestsOutputTypeDef definition

class ListResourceRequestsOutputTypeDef(TypedDict):
    ResourceRequestStatusSummaries: list[ProgressEventTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ProgressEventTypeDef
  2. See ResponseMetadataTypeDef

UpdateResourceOutputTypeDef#

# UpdateResourceOutputTypeDef definition

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

GetResourceOutputTypeDef#

# GetResourceOutputTypeDef definition

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

ListResourcesOutputTypeDef#

# ListResourcesOutputTypeDef definition

class ListResourcesOutputTypeDef(TypedDict):
    TypeName: str,
    ResourceDescriptions: list[ResourceDescriptionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ResourceDescriptionTypeDef
  2. See ResponseMetadataTypeDef

GetResourceRequestStatusInputWaitTypeDef#

# GetResourceRequestStatusInputWaitTypeDef definition

class GetResourceRequestStatusInputWaitTypeDef(TypedDict):
    RequestToken: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

GetResourceRequestStatusOutputTypeDef#

# GetResourceRequestStatusOutputTypeDef definition

class GetResourceRequestStatusOutputTypeDef(TypedDict):
    ProgressEvent: ProgressEventTypeDef,  # (1)
    HooksProgressEvent: list[HookProgressEventTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ProgressEventTypeDef
  2. See HookProgressEventTypeDef
  3. See ResponseMetadataTypeDef

ListResourcesInputPaginateTypeDef#

# ListResourcesInputPaginateTypeDef definition

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

ListResourceRequestsInputPaginateTypeDef#

# ListResourceRequestsInputPaginateTypeDef definition

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

ListResourceRequestsInputRequestTypeDef#

# ListResourceRequestsInputRequestTypeDef definition

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