Skip to content

Type definitions#

Index > OpsWorksCM > Type definitions

Auto-generated documentation for OpsWorksCM type annotations stubs module mypy-boto3-opsworkscm.

AccountAttributeTypeDef#

# AccountAttributeTypeDef definition

class AccountAttributeTypeDef(TypedDict):
    Name: NotRequired[str],
    Maximum: NotRequired[int],
    Used: NotRequired[int],

EngineAttributeTypeDef#

# EngineAttributeTypeDef definition

class EngineAttributeTypeDef(TypedDict):
    Name: NotRequired[str],
    Value: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

BackupTypeDef#

# BackupTypeDef definition

class BackupTypeDef(TypedDict):
    BackupArn: NotRequired[str],
    BackupId: NotRequired[str],
    BackupType: NotRequired[BackupTypeType],  # (1)
    CreatedAt: NotRequired[datetime],
    Description: NotRequired[str],
    Engine: NotRequired[str],
    EngineModel: NotRequired[str],
    EngineVersion: NotRequired[str],
    InstanceProfileArn: NotRequired[str],
    InstanceType: NotRequired[str],
    KeyPair: NotRequired[str],
    PreferredBackupWindow: NotRequired[str],
    PreferredMaintenanceWindow: NotRequired[str],
    S3DataSize: NotRequired[int],
    S3DataUrl: NotRequired[str],
    S3LogUrl: NotRequired[str],
    SecurityGroupIds: NotRequired[List[str]],
    ServerName: NotRequired[str],
    ServiceRoleArn: NotRequired[str],
    Status: NotRequired[BackupStatusType],  # (2)
    StatusDescription: NotRequired[str],
    SubnetIds: NotRequired[List[str]],
    ToolsVersion: NotRequired[str],
    UserArn: NotRequired[str],
  1. See BackupTypeType
  2. See BackupStatusType

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

DeleteBackupRequestRequestTypeDef#

# DeleteBackupRequestRequestTypeDef definition

class DeleteBackupRequestRequestTypeDef(TypedDict):
    BackupId: str,

DeleteServerRequestRequestTypeDef#

# DeleteServerRequestRequestTypeDef definition

class DeleteServerRequestRequestTypeDef(TypedDict):
    ServerName: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

DescribeBackupsRequestRequestTypeDef#

# DescribeBackupsRequestRequestTypeDef definition

class DescribeBackupsRequestRequestTypeDef(TypedDict):
    BackupId: NotRequired[str],
    ServerName: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

DescribeEventsRequestRequestTypeDef#

# DescribeEventsRequestRequestTypeDef definition

class DescribeEventsRequestRequestTypeDef(TypedDict):
    ServerName: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ServerEventTypeDef#

# ServerEventTypeDef definition

class ServerEventTypeDef(TypedDict):
    CreatedAt: NotRequired[datetime],
    ServerName: NotRequired[str],
    Message: NotRequired[str],
    LogUrl: NotRequired[str],

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

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

DescribeNodeAssociationStatusRequestRequestTypeDef#

# DescribeNodeAssociationStatusRequestRequestTypeDef definition

class DescribeNodeAssociationStatusRequestRequestTypeDef(TypedDict):
    NodeAssociationStatusToken: str,
    ServerName: str,

DescribeServersRequestRequestTypeDef#

# DescribeServersRequestRequestTypeDef definition

class DescribeServersRequestRequestTypeDef(TypedDict):
    ServerName: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

RestoreServerRequestRequestTypeDef#

# RestoreServerRequestRequestTypeDef definition

class RestoreServerRequestRequestTypeDef(TypedDict):
    BackupId: str,
    ServerName: str,
    InstanceType: NotRequired[str],
    KeyPair: NotRequired[str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateServerEngineAttributesRequestRequestTypeDef#

# UpdateServerEngineAttributesRequestRequestTypeDef definition

class UpdateServerEngineAttributesRequestRequestTypeDef(TypedDict):
    ServerName: str,
    AttributeName: str,
    AttributeValue: NotRequired[str],

UpdateServerRequestRequestTypeDef#

# UpdateServerRequestRequestTypeDef definition

class UpdateServerRequestRequestTypeDef(TypedDict):
    ServerName: str,
    DisableAutomatedBackup: NotRequired[bool],
    BackupRetentionCount: NotRequired[int],
    PreferredMaintenanceWindow: NotRequired[str],
    PreferredBackupWindow: NotRequired[str],

AssociateNodeRequestRequestTypeDef#

# AssociateNodeRequestRequestTypeDef definition

class AssociateNodeRequestRequestTypeDef(TypedDict):
    ServerName: str,
    NodeName: str,
    EngineAttributes: Sequence[EngineAttributeTypeDef],  # (1)
  1. See EngineAttributeTypeDef

DisassociateNodeRequestRequestTypeDef#

# DisassociateNodeRequestRequestTypeDef definition

class DisassociateNodeRequestRequestTypeDef(TypedDict):
    ServerName: str,
    NodeName: str,
    EngineAttributes: NotRequired[Sequence[EngineAttributeTypeDef]],  # (1)
  1. See EngineAttributeTypeDef

ExportServerEngineAttributeRequestRequestTypeDef#

# ExportServerEngineAttributeRequestRequestTypeDef definition

class ExportServerEngineAttributeRequestRequestTypeDef(TypedDict):
    ExportAttributeName: str,
    ServerName: str,
    InputAttributes: NotRequired[Sequence[EngineAttributeTypeDef]],  # (1)
  1. See EngineAttributeTypeDef

ServerTypeDef#

# ServerTypeDef definition

class ServerTypeDef(TypedDict):
    AssociatePublicIpAddress: NotRequired[bool],
    BackupRetentionCount: NotRequired[int],
    ServerName: NotRequired[str],
    CreatedAt: NotRequired[datetime],
    CloudFormationStackArn: NotRequired[str],
    CustomDomain: NotRequired[str],
    DisableAutomatedBackup: NotRequired[bool],
    Endpoint: NotRequired[str],
    Engine: NotRequired[str],
    EngineModel: NotRequired[str],
    EngineAttributes: NotRequired[List[EngineAttributeTypeDef]],  # (1)
    EngineVersion: NotRequired[str],
    InstanceProfileArn: NotRequired[str],
    InstanceType: NotRequired[str],
    KeyPair: NotRequired[str],
    MaintenanceStatus: NotRequired[MaintenanceStatusType],  # (2)
    PreferredMaintenanceWindow: NotRequired[str],
    PreferredBackupWindow: NotRequired[str],
    SecurityGroupIds: NotRequired[List[str]],
    ServiceRoleArn: NotRequired[str],
    Status: NotRequired[ServerStatusType],  # (3)
    StatusReason: NotRequired[str],
    SubnetIds: NotRequired[List[str]],
    ServerArn: NotRequired[str],
  1. See EngineAttributeTypeDef
  2. See MaintenanceStatusType
  3. See ServerStatusType

StartMaintenanceRequestRequestTypeDef#

# StartMaintenanceRequestRequestTypeDef definition

class StartMaintenanceRequestRequestTypeDef(TypedDict):
    ServerName: str,
    EngineAttributes: NotRequired[Sequence[EngineAttributeTypeDef]],  # (1)
  1. See EngineAttributeTypeDef

AssociateNodeResponseTypeDef#

# AssociateNodeResponseTypeDef definition

class AssociateNodeResponseTypeDef(TypedDict):
    NodeAssociationStatusToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeAccountAttributesResponseTypeDef#

# DescribeAccountAttributesResponseTypeDef definition

class DescribeAccountAttributesResponseTypeDef(TypedDict):
    Attributes: List[AccountAttributeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountAttributeTypeDef
  2. See ResponseMetadataTypeDef

DescribeNodeAssociationStatusResponseTypeDef#

# DescribeNodeAssociationStatusResponseTypeDef definition

class DescribeNodeAssociationStatusResponseTypeDef(TypedDict):
    NodeAssociationStatus: NodeAssociationStatusType,  # (1)
    EngineAttributes: List[EngineAttributeTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See NodeAssociationStatusType
  2. See EngineAttributeTypeDef
  3. See ResponseMetadataTypeDef

DisassociateNodeResponseTypeDef#

# DisassociateNodeResponseTypeDef definition

class DisassociateNodeResponseTypeDef(TypedDict):
    NodeAssociationStatusToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ExportServerEngineAttributeResponseTypeDef#

# ExportServerEngineAttributeResponseTypeDef definition

class ExportServerEngineAttributeResponseTypeDef(TypedDict):
    EngineAttribute: EngineAttributeTypeDef,  # (1)
    ServerName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EngineAttributeTypeDef
  2. See ResponseMetadataTypeDef

CreateBackupResponseTypeDef#

# CreateBackupResponseTypeDef definition

class CreateBackupResponseTypeDef(TypedDict):
    Backup: BackupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BackupTypeDef
  2. See ResponseMetadataTypeDef

DescribeBackupsResponseTypeDef#

# DescribeBackupsResponseTypeDef definition

class DescribeBackupsResponseTypeDef(TypedDict):
    Backups: List[BackupTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BackupTypeDef
  2. See ResponseMetadataTypeDef

CreateBackupRequestRequestTypeDef#

# CreateBackupRequestRequestTypeDef definition

class CreateBackupRequestRequestTypeDef(TypedDict):
    ServerName: str,
    Description: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateServerRequestRequestTypeDef#

# CreateServerRequestRequestTypeDef definition

class CreateServerRequestRequestTypeDef(TypedDict):
    Engine: str,
    ServerName: str,
    InstanceProfileArn: str,
    InstanceType: str,
    ServiceRoleArn: str,
    AssociatePublicIpAddress: NotRequired[bool],
    CustomDomain: NotRequired[str],
    CustomCertificate: NotRequired[str],
    CustomPrivateKey: NotRequired[str],
    DisableAutomatedBackup: NotRequired[bool],
    EngineModel: NotRequired[str],
    EngineVersion: NotRequired[str],
    EngineAttributes: NotRequired[Sequence[EngineAttributeTypeDef]],  # (1)
    BackupRetentionCount: NotRequired[int],
    KeyPair: NotRequired[str],
    PreferredMaintenanceWindow: NotRequired[str],
    PreferredBackupWindow: NotRequired[str],
    SecurityGroupIds: NotRequired[Sequence[str]],
    SubnetIds: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    BackupId: NotRequired[str],
  1. See EngineAttributeTypeDef
  2. See TagTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

DescribeBackupsRequestDescribeBackupsPaginateTypeDef#

# DescribeBackupsRequestDescribeBackupsPaginateTypeDef definition

class DescribeBackupsRequestDescribeBackupsPaginateTypeDef(TypedDict):
    BackupId: NotRequired[str],
    ServerName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeEventsRequestDescribeEventsPaginateTypeDef#

# DescribeEventsRequestDescribeEventsPaginateTypeDef definition

class DescribeEventsRequestDescribeEventsPaginateTypeDef(TypedDict):
    ServerName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeServersRequestDescribeServersPaginateTypeDef#

# DescribeServersRequestDescribeServersPaginateTypeDef definition

class DescribeServersRequestDescribeServersPaginateTypeDef(TypedDict):
    ServerName: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTagsForResourceRequestListTagsForResourcePaginateTypeDef#

# ListTagsForResourceRequestListTagsForResourcePaginateTypeDef definition

class ListTagsForResourceRequestListTagsForResourcePaginateTypeDef(TypedDict):
    ResourceArn: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeEventsResponseTypeDef#

# DescribeEventsResponseTypeDef definition

class DescribeEventsResponseTypeDef(TypedDict):
    ServerEvents: List[ServerEventTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServerEventTypeDef
  2. See ResponseMetadataTypeDef

DescribeNodeAssociationStatusRequestNodeAssociatedWaitTypeDef#

# DescribeNodeAssociationStatusRequestNodeAssociatedWaitTypeDef definition

class DescribeNodeAssociationStatusRequestNodeAssociatedWaitTypeDef(TypedDict):
    NodeAssociationStatusToken: str,
    ServerName: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

CreateServerResponseTypeDef#

# CreateServerResponseTypeDef definition

class CreateServerResponseTypeDef(TypedDict):
    Server: ServerTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServerTypeDef
  2. See ResponseMetadataTypeDef

DescribeServersResponseTypeDef#

# DescribeServersResponseTypeDef definition

class DescribeServersResponseTypeDef(TypedDict):
    Servers: List[ServerTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServerTypeDef
  2. See ResponseMetadataTypeDef

RestoreServerResponseTypeDef#

# RestoreServerResponseTypeDef definition

class RestoreServerResponseTypeDef(TypedDict):
    Server: ServerTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServerTypeDef
  2. See ResponseMetadataTypeDef

StartMaintenanceResponseTypeDef#

# StartMaintenanceResponseTypeDef definition

class StartMaintenanceResponseTypeDef(TypedDict):
    Server: ServerTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServerTypeDef
  2. See ResponseMetadataTypeDef

UpdateServerEngineAttributesResponseTypeDef#

# UpdateServerEngineAttributesResponseTypeDef definition

class UpdateServerEngineAttributesResponseTypeDef(TypedDict):
    Server: ServerTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServerTypeDef
  2. See ResponseMetadataTypeDef

UpdateServerResponseTypeDef#

# UpdateServerResponseTypeDef definition

class UpdateServerResponseTypeDef(TypedDict):
    Server: ServerTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServerTypeDef
  2. See ResponseMetadataTypeDef