Skip to content

Type definitions#

Index > OpsWorks > Type definitions

Auto-generated documentation for OpsWorks type annotations stubs module mypy-boto3-opsworks.

StackConfigurationManagerTypeDef#

# StackConfigurationManagerTypeDef definition

class StackConfigurationManagerTypeDef(TypedDict):
    Name: NotRequired[str],
    Version: NotRequired[str],

DataSourceTypeDef#

# DataSourceTypeDef definition

class DataSourceTypeDef(TypedDict):
    Type: NotRequired[str],
    Arn: NotRequired[str],
    DatabaseName: NotRequired[str],

EnvironmentVariableTypeDef#

# EnvironmentVariableTypeDef definition

class EnvironmentVariableTypeDef(TypedDict):
    Key: str,
    Value: str,
    Secure: NotRequired[bool],

SourceTypeDef#

# SourceTypeDef definition

class SourceTypeDef(TypedDict):
    Type: NotRequired[SourceTypeType],  # (1)
    Url: NotRequired[str],
    Username: NotRequired[str],
    Password: NotRequired[str],
    SshKey: NotRequired[str],
    Revision: NotRequired[str],
  1. See SourceTypeType

SslConfigurationTypeDef#

# SslConfigurationTypeDef definition

class SslConfigurationTypeDef(TypedDict):
    Certificate: str,
    PrivateKey: str,
    Chain: NotRequired[str],

AssignInstanceRequestRequestTypeDef#

# AssignInstanceRequestRequestTypeDef definition

class AssignInstanceRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    LayerIds: Sequence[str],

AssignVolumeRequestRequestTypeDef#

# AssignVolumeRequestRequestTypeDef definition

class AssignVolumeRequestRequestTypeDef(TypedDict):
    VolumeId: str,
    InstanceId: NotRequired[str],

AssociateElasticIpRequestRequestTypeDef#

# AssociateElasticIpRequestRequestTypeDef definition

class AssociateElasticIpRequestRequestTypeDef(TypedDict):
    ElasticIp: str,
    InstanceId: NotRequired[str],

AttachElasticLoadBalancerRequestRequestTypeDef#

# AttachElasticLoadBalancerRequestRequestTypeDef definition

class AttachElasticLoadBalancerRequestRequestTypeDef(TypedDict):
    ElasticLoadBalancerName: str,
    LayerId: str,

AutoScalingThresholdsTypeDef#

# AutoScalingThresholdsTypeDef definition

class AutoScalingThresholdsTypeDef(TypedDict):
    InstanceCount: NotRequired[int],
    ThresholdsWaitTime: NotRequired[int],
    IgnoreMetricsTime: NotRequired[int],
    CpuThreshold: NotRequired[float],
    MemoryThreshold: NotRequired[float],
    LoadThreshold: NotRequired[float],
    Alarms: NotRequired[List[str]],

EbsBlockDeviceTypeDef#

# EbsBlockDeviceTypeDef definition

class EbsBlockDeviceTypeDef(TypedDict):
    SnapshotId: NotRequired[str],
    Iops: NotRequired[int],
    VolumeSize: NotRequired[int],
    VolumeType: NotRequired[VolumeTypeType],  # (1)
    DeleteOnTermination: NotRequired[bool],
  1. See VolumeTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

ChefConfigurationTypeDef#

# ChefConfigurationTypeDef definition

class ChefConfigurationTypeDef(TypedDict):
    ManageBerkshelf: NotRequired[bool],
    BerkshelfVersion: NotRequired[str],

CloudWatchLogsLogStreamTypeDef#

# CloudWatchLogsLogStreamTypeDef definition

class CloudWatchLogsLogStreamTypeDef(TypedDict):
    LogGroupName: NotRequired[str],
    DatetimeFormat: NotRequired[str],
    TimeZone: NotRequired[CloudWatchLogsTimeZoneType],  # (1)
    File: NotRequired[str],
    FileFingerprintLines: NotRequired[str],
    MultiLineStartPattern: NotRequired[str],
    InitialPosition: NotRequired[CloudWatchLogsInitialPositionType],  # (2)
    Encoding: NotRequired[CloudWatchLogsEncodingType],  # (3)
    BufferDuration: NotRequired[int],
    BatchCount: NotRequired[int],
    BatchSize: NotRequired[int],
  1. See CloudWatchLogsTimeZoneType
  2. See CloudWatchLogsInitialPositionType
  3. See CloudWatchLogsEncodingType

CommandTypeDef#

# CommandTypeDef definition

class CommandTypeDef(TypedDict):
    CommandId: NotRequired[str],
    InstanceId: NotRequired[str],
    DeploymentId: NotRequired[str],
    CreatedAt: NotRequired[str],
    AcknowledgedAt: NotRequired[str],
    CompletedAt: NotRequired[str],
    Status: NotRequired[str],
    ExitCode: NotRequired[int],
    LogUrl: NotRequired[str],
    Type: NotRequired[str],

DeploymentCommandTypeDef#

# DeploymentCommandTypeDef definition

class DeploymentCommandTypeDef(TypedDict):
    Name: DeploymentCommandNameType,  # (1)
    Args: NotRequired[Mapping[str, Sequence[str]]],
  1. See DeploymentCommandNameType

RecipesTypeDef#

# RecipesTypeDef definition

class RecipesTypeDef(TypedDict):
    Setup: NotRequired[Sequence[str]],
    Configure: NotRequired[Sequence[str]],
    Deploy: NotRequired[Sequence[str]],
    Undeploy: NotRequired[Sequence[str]],
    Shutdown: NotRequired[Sequence[str]],

VolumeConfigurationTypeDef#

# VolumeConfigurationTypeDef definition

class VolumeConfigurationTypeDef(TypedDict):
    MountPoint: str,
    NumberOfDisks: int,
    Size: int,
    RaidLevel: NotRequired[int],
    VolumeType: NotRequired[str],
    Iops: NotRequired[int],
    Encrypted: NotRequired[bool],

CreateUserProfileRequestRequestTypeDef#

# CreateUserProfileRequestRequestTypeDef definition

class CreateUserProfileRequestRequestTypeDef(TypedDict):
    IamUserArn: str,
    SshUsername: NotRequired[str],
    SshPublicKey: NotRequired[str],
    AllowSelfManagement: NotRequired[bool],

DeleteAppRequestRequestTypeDef#

# DeleteAppRequestRequestTypeDef definition

class DeleteAppRequestRequestTypeDef(TypedDict):
    AppId: str,

DeleteInstanceRequestRequestTypeDef#

# DeleteInstanceRequestRequestTypeDef definition

class DeleteInstanceRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    DeleteElasticIp: NotRequired[bool],
    DeleteVolumes: NotRequired[bool],

DeleteLayerRequestRequestTypeDef#

# DeleteLayerRequestRequestTypeDef definition

class DeleteLayerRequestRequestTypeDef(TypedDict):
    LayerId: str,

DeleteStackRequestRequestTypeDef#

# DeleteStackRequestRequestTypeDef definition

class DeleteStackRequestRequestTypeDef(TypedDict):
    StackId: str,

DeleteUserProfileRequestRequestTypeDef#

# DeleteUserProfileRequestRequestTypeDef definition

class DeleteUserProfileRequestRequestTypeDef(TypedDict):
    IamUserArn: str,

DeregisterEcsClusterRequestRequestTypeDef#

# DeregisterEcsClusterRequestRequestTypeDef definition

class DeregisterEcsClusterRequestRequestTypeDef(TypedDict):
    EcsClusterArn: str,

DeregisterElasticIpRequestRequestTypeDef#

# DeregisterElasticIpRequestRequestTypeDef definition

class DeregisterElasticIpRequestRequestTypeDef(TypedDict):
    ElasticIp: str,

DeregisterInstanceRequestRequestTypeDef#

# DeregisterInstanceRequestRequestTypeDef definition

class DeregisterInstanceRequestRequestTypeDef(TypedDict):
    InstanceId: str,

DeregisterRdsDbInstanceRequestRequestTypeDef#

# DeregisterRdsDbInstanceRequestRequestTypeDef definition

class DeregisterRdsDbInstanceRequestRequestTypeDef(TypedDict):
    RdsDbInstanceArn: str,

DeregisterVolumeRequestRequestTypeDef#

# DeregisterVolumeRequestRequestTypeDef definition

class DeregisterVolumeRequestRequestTypeDef(TypedDict):
    VolumeId: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

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

DescribeAppsRequestRequestTypeDef#

# DescribeAppsRequestRequestTypeDef definition

class DescribeAppsRequestRequestTypeDef(TypedDict):
    StackId: NotRequired[str],
    AppIds: NotRequired[Sequence[str]],

DescribeCommandsRequestRequestTypeDef#

# DescribeCommandsRequestRequestTypeDef definition

class DescribeCommandsRequestRequestTypeDef(TypedDict):
    DeploymentId: NotRequired[str],
    InstanceId: NotRequired[str],
    CommandIds: NotRequired[Sequence[str]],

DescribeDeploymentsRequestRequestTypeDef#

# DescribeDeploymentsRequestRequestTypeDef definition

class DescribeDeploymentsRequestRequestTypeDef(TypedDict):
    StackId: NotRequired[str],
    AppId: NotRequired[str],
    DeploymentIds: NotRequired[Sequence[str]],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

DescribeEcsClustersRequestRequestTypeDef#

# DescribeEcsClustersRequestRequestTypeDef definition

class DescribeEcsClustersRequestRequestTypeDef(TypedDict):
    EcsClusterArns: NotRequired[Sequence[str]],
    StackId: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

EcsClusterTypeDef#

# EcsClusterTypeDef definition

class EcsClusterTypeDef(TypedDict):
    EcsClusterArn: NotRequired[str],
    EcsClusterName: NotRequired[str],
    StackId: NotRequired[str],
    RegisteredAt: NotRequired[str],

DescribeElasticIpsRequestRequestTypeDef#

# DescribeElasticIpsRequestRequestTypeDef definition

class DescribeElasticIpsRequestRequestTypeDef(TypedDict):
    InstanceId: NotRequired[str],
    StackId: NotRequired[str],
    Ips: NotRequired[Sequence[str]],

ElasticIpTypeDef#

# ElasticIpTypeDef definition

class ElasticIpTypeDef(TypedDict):
    Ip: NotRequired[str],
    Name: NotRequired[str],
    Domain: NotRequired[str],
    Region: NotRequired[str],
    InstanceId: NotRequired[str],

DescribeElasticLoadBalancersRequestRequestTypeDef#

# DescribeElasticLoadBalancersRequestRequestTypeDef definition

class DescribeElasticLoadBalancersRequestRequestTypeDef(TypedDict):
    StackId: NotRequired[str],
    LayerIds: NotRequired[Sequence[str]],

ElasticLoadBalancerTypeDef#

# ElasticLoadBalancerTypeDef definition

class ElasticLoadBalancerTypeDef(TypedDict):
    ElasticLoadBalancerName: NotRequired[str],
    Region: NotRequired[str],
    DnsName: NotRequired[str],
    StackId: NotRequired[str],
    LayerId: NotRequired[str],
    VpcId: NotRequired[str],
    AvailabilityZones: NotRequired[List[str]],
    SubnetIds: NotRequired[List[str]],
    Ec2InstanceIds: NotRequired[List[str]],

DescribeInstancesRequestRequestTypeDef#

# DescribeInstancesRequestRequestTypeDef definition

class DescribeInstancesRequestRequestTypeDef(TypedDict):
    StackId: NotRequired[str],
    LayerId: NotRequired[str],
    InstanceIds: NotRequired[Sequence[str]],

DescribeLayersRequestRequestTypeDef#

# DescribeLayersRequestRequestTypeDef definition

class DescribeLayersRequestRequestTypeDef(TypedDict):
    StackId: NotRequired[str],
    LayerIds: NotRequired[Sequence[str]],

DescribeLoadBasedAutoScalingRequestRequestTypeDef#

# DescribeLoadBasedAutoScalingRequestRequestTypeDef definition

class DescribeLoadBasedAutoScalingRequestRequestTypeDef(TypedDict):
    LayerIds: Sequence[str],

SelfUserProfileTypeDef#

# SelfUserProfileTypeDef definition

class SelfUserProfileTypeDef(TypedDict):
    IamUserArn: NotRequired[str],
    Name: NotRequired[str],
    SshUsername: NotRequired[str],
    SshPublicKey: NotRequired[str],

DescribePermissionsRequestRequestTypeDef#

# DescribePermissionsRequestRequestTypeDef definition

class DescribePermissionsRequestRequestTypeDef(TypedDict):
    IamUserArn: NotRequired[str],
    StackId: NotRequired[str],

PermissionTypeDef#

# PermissionTypeDef definition

class PermissionTypeDef(TypedDict):
    StackId: NotRequired[str],
    IamUserArn: NotRequired[str],
    AllowSsh: NotRequired[bool],
    AllowSudo: NotRequired[bool],
    Level: NotRequired[str],

DescribeRaidArraysRequestRequestTypeDef#

# DescribeRaidArraysRequestRequestTypeDef definition

class DescribeRaidArraysRequestRequestTypeDef(TypedDict):
    InstanceId: NotRequired[str],
    StackId: NotRequired[str],
    RaidArrayIds: NotRequired[Sequence[str]],

RaidArrayTypeDef#

# RaidArrayTypeDef definition

class RaidArrayTypeDef(TypedDict):
    RaidArrayId: NotRequired[str],
    InstanceId: NotRequired[str],
    Name: NotRequired[str],
    RaidLevel: NotRequired[int],
    NumberOfDisks: NotRequired[int],
    Size: NotRequired[int],
    Device: NotRequired[str],
    MountPoint: NotRequired[str],
    AvailabilityZone: NotRequired[str],
    CreatedAt: NotRequired[str],
    StackId: NotRequired[str],
    VolumeType: NotRequired[str],
    Iops: NotRequired[int],

DescribeRdsDbInstancesRequestRequestTypeDef#

# DescribeRdsDbInstancesRequestRequestTypeDef definition

class DescribeRdsDbInstancesRequestRequestTypeDef(TypedDict):
    StackId: str,
    RdsDbInstanceArns: NotRequired[Sequence[str]],

RdsDbInstanceTypeDef#

# RdsDbInstanceTypeDef definition

class RdsDbInstanceTypeDef(TypedDict):
    RdsDbInstanceArn: NotRequired[str],
    DbInstanceIdentifier: NotRequired[str],
    DbUser: NotRequired[str],
    DbPassword: NotRequired[str],
    Region: NotRequired[str],
    Address: NotRequired[str],
    Engine: NotRequired[str],
    StackId: NotRequired[str],
    MissingOnRds: NotRequired[bool],

DescribeServiceErrorsRequestRequestTypeDef#

# DescribeServiceErrorsRequestRequestTypeDef definition

class DescribeServiceErrorsRequestRequestTypeDef(TypedDict):
    StackId: NotRequired[str],
    InstanceId: NotRequired[str],
    ServiceErrorIds: NotRequired[Sequence[str]],

ServiceErrorTypeDef#

# ServiceErrorTypeDef definition

class ServiceErrorTypeDef(TypedDict):
    ServiceErrorId: NotRequired[str],
    StackId: NotRequired[str],
    InstanceId: NotRequired[str],
    Type: NotRequired[str],
    Message: NotRequired[str],
    CreatedAt: NotRequired[str],

DescribeStackProvisioningParametersRequestRequestTypeDef#

# DescribeStackProvisioningParametersRequestRequestTypeDef definition

class DescribeStackProvisioningParametersRequestRequestTypeDef(TypedDict):
    StackId: str,

DescribeStackSummaryRequestRequestTypeDef#

# DescribeStackSummaryRequestRequestTypeDef definition

class DescribeStackSummaryRequestRequestTypeDef(TypedDict):
    StackId: str,

DescribeStacksRequestRequestTypeDef#

# DescribeStacksRequestRequestTypeDef definition

class DescribeStacksRequestRequestTypeDef(TypedDict):
    StackIds: NotRequired[Sequence[str]],

DescribeTimeBasedAutoScalingRequestRequestTypeDef#

# DescribeTimeBasedAutoScalingRequestRequestTypeDef definition

class DescribeTimeBasedAutoScalingRequestRequestTypeDef(TypedDict):
    InstanceIds: Sequence[str],

DescribeUserProfilesRequestRequestTypeDef#

# DescribeUserProfilesRequestRequestTypeDef definition

class DescribeUserProfilesRequestRequestTypeDef(TypedDict):
    IamUserArns: NotRequired[Sequence[str]],

UserProfileTypeDef#

# UserProfileTypeDef definition

class UserProfileTypeDef(TypedDict):
    IamUserArn: NotRequired[str],
    Name: NotRequired[str],
    SshUsername: NotRequired[str],
    SshPublicKey: NotRequired[str],
    AllowSelfManagement: NotRequired[bool],

DescribeVolumesRequestRequestTypeDef#

# DescribeVolumesRequestRequestTypeDef definition

class DescribeVolumesRequestRequestTypeDef(TypedDict):
    InstanceId: NotRequired[str],
    StackId: NotRequired[str],
    RaidArrayId: NotRequired[str],
    VolumeIds: NotRequired[Sequence[str]],

VolumeTypeDef#

# VolumeTypeDef definition

class VolumeTypeDef(TypedDict):
    VolumeId: NotRequired[str],
    Ec2VolumeId: NotRequired[str],
    Name: NotRequired[str],
    RaidArrayId: NotRequired[str],
    InstanceId: NotRequired[str],
    Status: NotRequired[str],
    Size: NotRequired[int],
    Device: NotRequired[str],
    MountPoint: NotRequired[str],
    Region: NotRequired[str],
    AvailabilityZone: NotRequired[str],
    VolumeType: NotRequired[str],
    Iops: NotRequired[int],
    Encrypted: NotRequired[bool],

DetachElasticLoadBalancerRequestRequestTypeDef#

# DetachElasticLoadBalancerRequestRequestTypeDef definition

class DetachElasticLoadBalancerRequestRequestTypeDef(TypedDict):
    ElasticLoadBalancerName: str,
    LayerId: str,

DisassociateElasticIpRequestRequestTypeDef#

# DisassociateElasticIpRequestRequestTypeDef definition

class DisassociateElasticIpRequestRequestTypeDef(TypedDict):
    ElasticIp: str,

GetHostnameSuggestionRequestRequestTypeDef#

# GetHostnameSuggestionRequestRequestTypeDef definition

class GetHostnameSuggestionRequestRequestTypeDef(TypedDict):
    LayerId: str,

GrantAccessRequestRequestTypeDef#

# GrantAccessRequestRequestTypeDef definition

class GrantAccessRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    ValidForInMinutes: NotRequired[int],

TemporaryCredentialTypeDef#

# TemporaryCredentialTypeDef definition

class TemporaryCredentialTypeDef(TypedDict):
    Username: NotRequired[str],
    Password: NotRequired[str],
    ValidForInMinutes: NotRequired[int],
    InstanceId: NotRequired[str],

InstanceIdentityTypeDef#

# InstanceIdentityTypeDef definition

class InstanceIdentityTypeDef(TypedDict):
    Document: NotRequired[str],
    Signature: NotRequired[str],

ReportedOsTypeDef#

# ReportedOsTypeDef definition

class ReportedOsTypeDef(TypedDict):
    Family: NotRequired[str],
    Name: NotRequired[str],
    Version: NotRequired[str],

InstancesCountTypeDef#

# InstancesCountTypeDef definition

class InstancesCountTypeDef(TypedDict):
    Assigning: NotRequired[int],
    Booting: NotRequired[int],
    ConnectionLost: NotRequired[int],
    Deregistering: NotRequired[int],
    Online: NotRequired[int],
    Pending: NotRequired[int],
    Rebooting: NotRequired[int],
    Registered: NotRequired[int],
    Registering: NotRequired[int],
    Requested: NotRequired[int],
    RunningSetup: NotRequired[int],
    SetupFailed: NotRequired[int],
    ShuttingDown: NotRequired[int],
    StartFailed: NotRequired[int],
    StopFailed: NotRequired[int],
    Stopped: NotRequired[int],
    Stopping: NotRequired[int],
    Terminated: NotRequired[int],
    Terminating: NotRequired[int],
    Unassigning: NotRequired[int],

ShutdownEventConfigurationTypeDef#

# ShutdownEventConfigurationTypeDef definition

class ShutdownEventConfigurationTypeDef(TypedDict):
    ExecutionTimeout: NotRequired[int],
    DelayUntilElbConnectionsDrained: NotRequired[bool],

ListTagsRequestRequestTypeDef#

# ListTagsRequestRequestTypeDef definition

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

OperatingSystemConfigurationManagerTypeDef#

# OperatingSystemConfigurationManagerTypeDef definition

class OperatingSystemConfigurationManagerTypeDef(TypedDict):
    Name: NotRequired[str],
    Version: NotRequired[str],

RebootInstanceRequestRequestTypeDef#

# RebootInstanceRequestRequestTypeDef definition

class RebootInstanceRequestRequestTypeDef(TypedDict):
    InstanceId: str,

RegisterEcsClusterRequestRequestTypeDef#

# RegisterEcsClusterRequestRequestTypeDef definition

class RegisterEcsClusterRequestRequestTypeDef(TypedDict):
    EcsClusterArn: str,
    StackId: str,

RegisterElasticIpRequestRequestTypeDef#

# RegisterElasticIpRequestRequestTypeDef definition

class RegisterElasticIpRequestRequestTypeDef(TypedDict):
    ElasticIp: str,
    StackId: str,

RegisterRdsDbInstanceRequestRequestTypeDef#

# RegisterRdsDbInstanceRequestRequestTypeDef definition

class RegisterRdsDbInstanceRequestRequestTypeDef(TypedDict):
    StackId: str,
    RdsDbInstanceArn: str,
    DbUser: str,
    DbPassword: str,

RegisterVolumeRequestRequestTypeDef#

# RegisterVolumeRequestRequestTypeDef definition

class RegisterVolumeRequestRequestTypeDef(TypedDict):
    StackId: str,
    Ec2VolumeId: NotRequired[str],

SetPermissionRequestRequestTypeDef#

# SetPermissionRequestRequestTypeDef definition

class SetPermissionRequestRequestTypeDef(TypedDict):
    StackId: str,
    IamUserArn: str,
    AllowSsh: NotRequired[bool],
    AllowSudo: NotRequired[bool],
    Level: NotRequired[str],

WeeklyAutoScalingScheduleTypeDef#

# WeeklyAutoScalingScheduleTypeDef definition

class WeeklyAutoScalingScheduleTypeDef(TypedDict):
    Monday: NotRequired[Dict[str, str]],
    Tuesday: NotRequired[Dict[str, str]],
    Wednesday: NotRequired[Dict[str, str]],
    Thursday: NotRequired[Dict[str, str]],
    Friday: NotRequired[Dict[str, str]],
    Saturday: NotRequired[Dict[str, str]],
    Sunday: NotRequired[Dict[str, str]],

StartInstanceRequestRequestTypeDef#

# StartInstanceRequestRequestTypeDef definition

class StartInstanceRequestRequestTypeDef(TypedDict):
    InstanceId: str,

StartStackRequestRequestTypeDef#

# StartStackRequestRequestTypeDef definition

class StartStackRequestRequestTypeDef(TypedDict):
    StackId: str,

StopInstanceRequestRequestTypeDef#

# StopInstanceRequestRequestTypeDef definition

class StopInstanceRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    Force: NotRequired[bool],

StopStackRequestRequestTypeDef#

# StopStackRequestRequestTypeDef definition

class StopStackRequestRequestTypeDef(TypedDict):
    StackId: str,

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UnassignInstanceRequestRequestTypeDef#

# UnassignInstanceRequestRequestTypeDef definition

class UnassignInstanceRequestRequestTypeDef(TypedDict):
    InstanceId: str,

UnassignVolumeRequestRequestTypeDef#

# UnassignVolumeRequestRequestTypeDef definition

class UnassignVolumeRequestRequestTypeDef(TypedDict):
    VolumeId: str,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateElasticIpRequestRequestTypeDef#

# UpdateElasticIpRequestRequestTypeDef definition

class UpdateElasticIpRequestRequestTypeDef(TypedDict):
    ElasticIp: str,
    Name: NotRequired[str],

UpdateInstanceRequestRequestTypeDef#

# UpdateInstanceRequestRequestTypeDef definition

class UpdateInstanceRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    LayerIds: NotRequired[Sequence[str]],
    InstanceType: NotRequired[str],
    AutoScalingType: NotRequired[AutoScalingTypeType],  # (1)
    Hostname: NotRequired[str],
    Os: NotRequired[str],
    AmiId: NotRequired[str],
    SshKeyName: NotRequired[str],
    Architecture: NotRequired[ArchitectureType],  # (2)
    InstallUpdatesOnBoot: NotRequired[bool],
    EbsOptimized: NotRequired[bool],
    AgentVersion: NotRequired[str],
  1. See AutoScalingTypeType
  2. See ArchitectureType

UpdateMyUserProfileRequestRequestTypeDef#

# UpdateMyUserProfileRequestRequestTypeDef definition

class UpdateMyUserProfileRequestRequestTypeDef(TypedDict):
    SshPublicKey: NotRequired[str],

UpdateRdsDbInstanceRequestRequestTypeDef#

# UpdateRdsDbInstanceRequestRequestTypeDef definition

class UpdateRdsDbInstanceRequestRequestTypeDef(TypedDict):
    RdsDbInstanceArn: str,
    DbUser: NotRequired[str],
    DbPassword: NotRequired[str],

UpdateUserProfileRequestRequestTypeDef#

# UpdateUserProfileRequestRequestTypeDef definition

class UpdateUserProfileRequestRequestTypeDef(TypedDict):
    IamUserArn: str,
    SshUsername: NotRequired[str],
    SshPublicKey: NotRequired[str],
    AllowSelfManagement: NotRequired[bool],

UpdateVolumeRequestRequestTypeDef#

# UpdateVolumeRequestRequestTypeDef definition

class UpdateVolumeRequestRequestTypeDef(TypedDict):
    VolumeId: str,
    Name: NotRequired[str],
    MountPoint: NotRequired[str],

AgentVersionTypeDef#

# AgentVersionTypeDef definition

class AgentVersionTypeDef(TypedDict):
    Version: NotRequired[str],
    ConfigurationManager: NotRequired[StackConfigurationManagerTypeDef],  # (1)
  1. See StackConfigurationManagerTypeDef

DescribeAgentVersionsRequestRequestTypeDef#

# DescribeAgentVersionsRequestRequestTypeDef definition

class DescribeAgentVersionsRequestRequestTypeDef(TypedDict):
    StackId: NotRequired[str],
    ConfigurationManager: NotRequired[StackConfigurationManagerTypeDef],  # (1)
  1. See StackConfigurationManagerTypeDef

AppTypeDef#

# AppTypeDef definition

class AppTypeDef(TypedDict):
    AppId: NotRequired[str],
    StackId: NotRequired[str],
    Shortname: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],
    DataSources: NotRequired[List[DataSourceTypeDef]],  # (1)
    Type: NotRequired[AppTypeType],  # (2)
    AppSource: NotRequired[SourceTypeDef],  # (3)
    Domains: NotRequired[List[str]],
    EnableSsl: NotRequired[bool],
    SslConfiguration: NotRequired[SslConfigurationTypeDef],  # (4)
    Attributes: NotRequired[Dict[AppAttributesKeysType, str]],  # (5)
    CreatedAt: NotRequired[str],
    Environment: NotRequired[List[EnvironmentVariableTypeDef]],  # (6)
  1. See DataSourceTypeDef
  2. See AppTypeType
  3. See SourceTypeDef
  4. See SslConfigurationTypeDef
  5. See AppAttributesKeysType
  6. See EnvironmentVariableTypeDef

CreateAppRequestRequestTypeDef#

# CreateAppRequestRequestTypeDef definition

class CreateAppRequestRequestTypeDef(TypedDict):
    StackId: str,
    Name: str,
    Type: AppTypeType,  # (1)
    Shortname: NotRequired[str],
    Description: NotRequired[str],
    DataSources: NotRequired[Sequence[DataSourceTypeDef]],  # (2)
    AppSource: NotRequired[SourceTypeDef],  # (3)
    Domains: NotRequired[Sequence[str]],
    EnableSsl: NotRequired[bool],
    SslConfiguration: NotRequired[SslConfigurationTypeDef],  # (4)
    Attributes: NotRequired[Mapping[AppAttributesKeysType, str]],  # (5)
    Environment: NotRequired[Sequence[EnvironmentVariableTypeDef]],  # (6)
  1. See AppTypeType
  2. See DataSourceTypeDef
  3. See SourceTypeDef
  4. See SslConfigurationTypeDef
  5. See AppAttributesKeysType
  6. See EnvironmentVariableTypeDef

UpdateAppRequestRequestTypeDef#

# UpdateAppRequestRequestTypeDef definition

class UpdateAppRequestRequestTypeDef(TypedDict):
    AppId: str,
    Name: NotRequired[str],
    Description: NotRequired[str],
    DataSources: NotRequired[Sequence[DataSourceTypeDef]],  # (1)
    Type: NotRequired[AppTypeType],  # (2)
    AppSource: NotRequired[SourceTypeDef],  # (3)
    Domains: NotRequired[Sequence[str]],
    EnableSsl: NotRequired[bool],
    SslConfiguration: NotRequired[SslConfigurationTypeDef],  # (4)
    Attributes: NotRequired[Mapping[AppAttributesKeysType, str]],  # (5)
    Environment: NotRequired[Sequence[EnvironmentVariableTypeDef]],  # (6)
  1. See DataSourceTypeDef
  2. See AppTypeType
  3. See SourceTypeDef
  4. See SslConfigurationTypeDef
  5. See AppAttributesKeysType
  6. See EnvironmentVariableTypeDef

LoadBasedAutoScalingConfigurationTypeDef#

# LoadBasedAutoScalingConfigurationTypeDef definition

class LoadBasedAutoScalingConfigurationTypeDef(TypedDict):
    LayerId: NotRequired[str],
    Enable: NotRequired[bool],
    UpScaling: NotRequired[AutoScalingThresholdsTypeDef],  # (1)
    DownScaling: NotRequired[AutoScalingThresholdsTypeDef],  # (1)
  1. See AutoScalingThresholdsTypeDef
  2. See AutoScalingThresholdsTypeDef

SetLoadBasedAutoScalingRequestRequestTypeDef#

# SetLoadBasedAutoScalingRequestRequestTypeDef definition

class SetLoadBasedAutoScalingRequestRequestTypeDef(TypedDict):
    LayerId: str,
    Enable: NotRequired[bool],
    UpScaling: NotRequired[AutoScalingThresholdsTypeDef],  # (1)
    DownScaling: NotRequired[AutoScalingThresholdsTypeDef],  # (1)
  1. See AutoScalingThresholdsTypeDef
  2. See AutoScalingThresholdsTypeDef

BlockDeviceMappingTypeDef#

# BlockDeviceMappingTypeDef definition

class BlockDeviceMappingTypeDef(TypedDict):
    DeviceName: NotRequired[str],
    NoDevice: NotRequired[str],
    VirtualName: NotRequired[str],
    Ebs: NotRequired[EbsBlockDeviceTypeDef],  # (1)
  1. See EbsBlockDeviceTypeDef

ChefConfigurationResponseTypeDef#

# ChefConfigurationResponseTypeDef definition

class ChefConfigurationResponseTypeDef(TypedDict):
    ManageBerkshelf: bool,
    BerkshelfVersion: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CloneStackResultTypeDef#

# CloneStackResultTypeDef definition

class CloneStackResultTypeDef(TypedDict):
    StackId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateAppResultTypeDef#

# CreateAppResultTypeDef definition

class CreateAppResultTypeDef(TypedDict):
    AppId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDeploymentResultTypeDef#

# CreateDeploymentResultTypeDef definition

class CreateDeploymentResultTypeDef(TypedDict):
    DeploymentId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateInstanceResultTypeDef#

# CreateInstanceResultTypeDef definition

class CreateInstanceResultTypeDef(TypedDict):
    InstanceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateLayerResultTypeDef#

# CreateLayerResultTypeDef definition

class CreateLayerResultTypeDef(TypedDict):
    LayerId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateStackResultTypeDef#

# CreateStackResultTypeDef definition

class CreateStackResultTypeDef(TypedDict):
    StackId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateUserProfileResultTypeDef#

# CreateUserProfileResultTypeDef definition

class CreateUserProfileResultTypeDef(TypedDict):
    IamUserArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeStackProvisioningParametersResultTypeDef#

# DescribeStackProvisioningParametersResultTypeDef definition

class DescribeStackProvisioningParametersResultTypeDef(TypedDict):
    AgentInstallerUrl: str,
    Parameters: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetHostnameSuggestionResultTypeDef#

# GetHostnameSuggestionResultTypeDef definition

class GetHostnameSuggestionResultTypeDef(TypedDict):
    LayerId: str,
    Hostname: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

InstancesCountResponseTypeDef#

# InstancesCountResponseTypeDef definition

class InstancesCountResponseTypeDef(TypedDict):
    Assigning: int,
    Booting: int,
    ConnectionLost: int,
    Deregistering: int,
    Online: int,
    Pending: int,
    Rebooting: int,
    Registered: int,
    Registering: int,
    Requested: int,
    RunningSetup: int,
    SetupFailed: int,
    ShuttingDown: int,
    StartFailed: int,
    StopFailed: int,
    Stopped: int,
    Stopping: int,
    Terminated: int,
    Terminating: int,
    Unassigning: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsResultTypeDef#

# ListTagsResultTypeDef definition

class ListTagsResultTypeDef(TypedDict):
    Tags: Dict[str, str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RecipesResponseTypeDef#

# RecipesResponseTypeDef definition

class RecipesResponseTypeDef(TypedDict):
    Setup: List[str],
    Configure: List[str],
    Deploy: List[str],
    Undeploy: List[str],
    Shutdown: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RegisterEcsClusterResultTypeDef#

# RegisterEcsClusterResultTypeDef definition

class RegisterEcsClusterResultTypeDef(TypedDict):
    EcsClusterArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RegisterElasticIpResultTypeDef#

# RegisterElasticIpResultTypeDef definition

class RegisterElasticIpResultTypeDef(TypedDict):
    ElasticIp: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RegisterInstanceResultTypeDef#

# RegisterInstanceResultTypeDef definition

class RegisterInstanceResultTypeDef(TypedDict):
    InstanceId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RegisterVolumeResultTypeDef#

# RegisterVolumeResultTypeDef definition

class RegisterVolumeResultTypeDef(TypedDict):
    VolumeId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SourceResponseTypeDef#

# SourceResponseTypeDef definition

class SourceResponseTypeDef(TypedDict):
    Type: SourceTypeType,  # (1)
    Url: str,
    Username: str,
    Password: str,
    SshKey: str,
    Revision: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SourceTypeType
  2. See ResponseMetadataTypeDef

StackConfigurationManagerResponseTypeDef#

# StackConfigurationManagerResponseTypeDef definition

class StackConfigurationManagerResponseTypeDef(TypedDict):
    Name: str,
    Version: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CloneStackRequestRequestTypeDef#

# CloneStackRequestRequestTypeDef definition

class CloneStackRequestRequestTypeDef(TypedDict):
    SourceStackId: str,
    ServiceRoleArn: str,
    Name: NotRequired[str],
    Region: NotRequired[str],
    VpcId: NotRequired[str],
    Attributes: NotRequired[Mapping[StackAttributesKeysType, str]],  # (1)
    DefaultInstanceProfileArn: NotRequired[str],
    DefaultOs: NotRequired[str],
    HostnameTheme: NotRequired[str],
    DefaultAvailabilityZone: NotRequired[str],
    DefaultSubnetId: NotRequired[str],
    CustomJson: NotRequired[str],
    ConfigurationManager: NotRequired[StackConfigurationManagerTypeDef],  # (2)
    ChefConfiguration: NotRequired[ChefConfigurationTypeDef],  # (3)
    UseCustomCookbooks: NotRequired[bool],
    UseOpsworksSecurityGroups: NotRequired[bool],
    CustomCookbooksSource: NotRequired[SourceTypeDef],  # (4)
    DefaultSshKeyName: NotRequired[str],
    ClonePermissions: NotRequired[bool],
    CloneAppIds: NotRequired[Sequence[str]],
    DefaultRootDeviceType: NotRequired[RootDeviceTypeType],  # (5)
    AgentVersion: NotRequired[str],
  1. See StackAttributesKeysType
  2. See StackConfigurationManagerTypeDef
  3. See ChefConfigurationTypeDef
  4. See SourceTypeDef
  5. See RootDeviceTypeType

CreateStackRequestRequestTypeDef#

# CreateStackRequestRequestTypeDef definition

class CreateStackRequestRequestTypeDef(TypedDict):
    Name: str,
    Region: str,
    ServiceRoleArn: str,
    DefaultInstanceProfileArn: str,
    VpcId: NotRequired[str],
    Attributes: NotRequired[Mapping[StackAttributesKeysType, str]],  # (1)
    DefaultOs: NotRequired[str],
    HostnameTheme: NotRequired[str],
    DefaultAvailabilityZone: NotRequired[str],
    DefaultSubnetId: NotRequired[str],
    CustomJson: NotRequired[str],
    ConfigurationManager: NotRequired[StackConfigurationManagerTypeDef],  # (2)
    ChefConfiguration: NotRequired[ChefConfigurationTypeDef],  # (3)
    UseCustomCookbooks: NotRequired[bool],
    UseOpsworksSecurityGroups: NotRequired[bool],
    CustomCookbooksSource: NotRequired[SourceTypeDef],  # (4)
    DefaultSshKeyName: NotRequired[str],
    DefaultRootDeviceType: NotRequired[RootDeviceTypeType],  # (5)
    AgentVersion: NotRequired[str],
  1. See StackAttributesKeysType
  2. See StackConfigurationManagerTypeDef
  3. See ChefConfigurationTypeDef
  4. See SourceTypeDef
  5. See RootDeviceTypeType

CreateStackRequestServiceResourceCreateStackTypeDef#

# CreateStackRequestServiceResourceCreateStackTypeDef definition

class CreateStackRequestServiceResourceCreateStackTypeDef(TypedDict):
    Name: str,
    Region: str,
    ServiceRoleArn: str,
    DefaultInstanceProfileArn: str,
    VpcId: NotRequired[str],
    Attributes: NotRequired[Mapping[StackAttributesKeysType, str]],  # (1)
    DefaultOs: NotRequired[str],
    HostnameTheme: NotRequired[str],
    DefaultAvailabilityZone: NotRequired[str],
    DefaultSubnetId: NotRequired[str],
    CustomJson: NotRequired[str],
    ConfigurationManager: NotRequired[StackConfigurationManagerTypeDef],  # (2)
    ChefConfiguration: NotRequired[ChefConfigurationTypeDef],  # (3)
    UseCustomCookbooks: NotRequired[bool],
    UseOpsworksSecurityGroups: NotRequired[bool],
    CustomCookbooksSource: NotRequired[SourceTypeDef],  # (4)
    DefaultSshKeyName: NotRequired[str],
    DefaultRootDeviceType: NotRequired[RootDeviceTypeType],  # (5)
    AgentVersion: NotRequired[str],
  1. See StackAttributesKeysType
  2. See StackConfigurationManagerTypeDef
  3. See ChefConfigurationTypeDef
  4. See SourceTypeDef
  5. See RootDeviceTypeType

StackTypeDef#

# StackTypeDef definition

class StackTypeDef(TypedDict):
    StackId: NotRequired[str],
    Name: NotRequired[str],
    Arn: NotRequired[str],
    Region: NotRequired[str],
    VpcId: NotRequired[str],
    Attributes: NotRequired[Dict[StackAttributesKeysType, str]],  # (1)
    ServiceRoleArn: NotRequired[str],
    DefaultInstanceProfileArn: NotRequired[str],
    DefaultOs: NotRequired[str],
    HostnameTheme: NotRequired[str],
    DefaultAvailabilityZone: NotRequired[str],
    DefaultSubnetId: NotRequired[str],
    CustomJson: NotRequired[str],
    ConfigurationManager: NotRequired[StackConfigurationManagerTypeDef],  # (2)
    ChefConfiguration: NotRequired[ChefConfigurationTypeDef],  # (3)
    UseCustomCookbooks: NotRequired[bool],
    UseOpsworksSecurityGroups: NotRequired[bool],
    CustomCookbooksSource: NotRequired[SourceTypeDef],  # (4)
    DefaultSshKeyName: NotRequired[str],
    CreatedAt: NotRequired[str],
    DefaultRootDeviceType: NotRequired[RootDeviceTypeType],  # (5)
    AgentVersion: NotRequired[str],
  1. See StackAttributesKeysType
  2. See StackConfigurationManagerTypeDef
  3. See ChefConfigurationTypeDef
  4. See SourceTypeDef
  5. See RootDeviceTypeType

UpdateStackRequestRequestTypeDef#

# UpdateStackRequestRequestTypeDef definition

class UpdateStackRequestRequestTypeDef(TypedDict):
    StackId: str,
    Name: NotRequired[str],
    Attributes: NotRequired[Mapping[StackAttributesKeysType, str]],  # (1)
    ServiceRoleArn: NotRequired[str],
    DefaultInstanceProfileArn: NotRequired[str],
    DefaultOs: NotRequired[str],
    HostnameTheme: NotRequired[str],
    DefaultAvailabilityZone: NotRequired[str],
    DefaultSubnetId: NotRequired[str],
    CustomJson: NotRequired[str],
    ConfigurationManager: NotRequired[StackConfigurationManagerTypeDef],  # (2)
    ChefConfiguration: NotRequired[ChefConfigurationTypeDef],  # (3)
    UseCustomCookbooks: NotRequired[bool],
    CustomCookbooksSource: NotRequired[SourceTypeDef],  # (4)
    DefaultSshKeyName: NotRequired[str],
    DefaultRootDeviceType: NotRequired[RootDeviceTypeType],  # (5)
    UseOpsworksSecurityGroups: NotRequired[bool],
    AgentVersion: NotRequired[str],
  1. See StackAttributesKeysType
  2. See StackConfigurationManagerTypeDef
  3. See ChefConfigurationTypeDef
  4. See SourceTypeDef
  5. See RootDeviceTypeType

CloudWatchLogsConfigurationResponseTypeDef#

# CloudWatchLogsConfigurationResponseTypeDef definition

class CloudWatchLogsConfigurationResponseTypeDef(TypedDict):
    Enabled: bool,
    LogStreams: List[CloudWatchLogsLogStreamTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CloudWatchLogsLogStreamTypeDef
  2. See ResponseMetadataTypeDef

CloudWatchLogsConfigurationTypeDef#

# CloudWatchLogsConfigurationTypeDef definition

class CloudWatchLogsConfigurationTypeDef(TypedDict):
    Enabled: NotRequired[bool],
    LogStreams: NotRequired[Sequence[CloudWatchLogsLogStreamTypeDef]],  # (1)
  1. See CloudWatchLogsLogStreamTypeDef

DescribeCommandsResultTypeDef#

# DescribeCommandsResultTypeDef definition

class DescribeCommandsResultTypeDef(TypedDict):
    Commands: List[CommandTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CommandTypeDef
  2. See ResponseMetadataTypeDef

CreateDeploymentRequestRequestTypeDef#

# CreateDeploymentRequestRequestTypeDef definition

class CreateDeploymentRequestRequestTypeDef(TypedDict):
    StackId: str,
    Command: DeploymentCommandTypeDef,  # (1)
    AppId: NotRequired[str],
    InstanceIds: NotRequired[Sequence[str]],
    LayerIds: NotRequired[Sequence[str]],
    Comment: NotRequired[str],
    CustomJson: NotRequired[str],
  1. See DeploymentCommandTypeDef

DeploymentTypeDef#

# DeploymentTypeDef definition

class DeploymentTypeDef(TypedDict):
    DeploymentId: NotRequired[str],
    StackId: NotRequired[str],
    AppId: NotRequired[str],
    CreatedAt: NotRequired[str],
    CompletedAt: NotRequired[str],
    Duration: NotRequired[int],
    IamUserArn: NotRequired[str],
    Comment: NotRequired[str],
    Command: NotRequired[DeploymentCommandTypeDef],  # (1)
    Status: NotRequired[str],
    CustomJson: NotRequired[str],
    InstanceIds: NotRequired[List[str]],
  1. See DeploymentCommandTypeDef

DescribeAppsRequestAppExistsWaitTypeDef#

# DescribeAppsRequestAppExistsWaitTypeDef definition

class DescribeAppsRequestAppExistsWaitTypeDef(TypedDict):
    StackId: NotRequired[str],
    AppIds: NotRequired[Sequence[str]],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeDeploymentsRequestDeploymentSuccessfulWaitTypeDef#

# DescribeDeploymentsRequestDeploymentSuccessfulWaitTypeDef definition

class DescribeDeploymentsRequestDeploymentSuccessfulWaitTypeDef(TypedDict):
    StackId: NotRequired[str],
    AppId: NotRequired[str],
    DeploymentIds: NotRequired[Sequence[str]],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeInstancesRequestInstanceOnlineWaitTypeDef#

# DescribeInstancesRequestInstanceOnlineWaitTypeDef definition

class DescribeInstancesRequestInstanceOnlineWaitTypeDef(TypedDict):
    StackId: NotRequired[str],
    LayerId: NotRequired[str],
    InstanceIds: NotRequired[Sequence[str]],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeInstancesRequestInstanceRegisteredWaitTypeDef#

# DescribeInstancesRequestInstanceRegisteredWaitTypeDef definition

class DescribeInstancesRequestInstanceRegisteredWaitTypeDef(TypedDict):
    StackId: NotRequired[str],
    LayerId: NotRequired[str],
    InstanceIds: NotRequired[Sequence[str]],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeInstancesRequestInstanceStoppedWaitTypeDef#

# DescribeInstancesRequestInstanceStoppedWaitTypeDef definition

class DescribeInstancesRequestInstanceStoppedWaitTypeDef(TypedDict):
    StackId: NotRequired[str],
    LayerId: NotRequired[str],
    InstanceIds: NotRequired[Sequence[str]],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeInstancesRequestInstanceTerminatedWaitTypeDef#

# DescribeInstancesRequestInstanceTerminatedWaitTypeDef definition

class DescribeInstancesRequestInstanceTerminatedWaitTypeDef(TypedDict):
    StackId: NotRequired[str],
    LayerId: NotRequired[str],
    InstanceIds: NotRequired[Sequence[str]],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

DescribeEcsClustersRequestDescribeEcsClustersPaginateTypeDef#

# DescribeEcsClustersRequestDescribeEcsClustersPaginateTypeDef definition

class DescribeEcsClustersRequestDescribeEcsClustersPaginateTypeDef(TypedDict):
    EcsClusterArns: NotRequired[Sequence[str]],
    StackId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeEcsClustersResultTypeDef#

# DescribeEcsClustersResultTypeDef definition

class DescribeEcsClustersResultTypeDef(TypedDict):
    EcsClusters: List[EcsClusterTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EcsClusterTypeDef
  2. See ResponseMetadataTypeDef

DescribeElasticIpsResultTypeDef#

# DescribeElasticIpsResultTypeDef definition

class DescribeElasticIpsResultTypeDef(TypedDict):
    ElasticIps: List[ElasticIpTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ElasticIpTypeDef
  2. See ResponseMetadataTypeDef

DescribeElasticLoadBalancersResultTypeDef#

# DescribeElasticLoadBalancersResultTypeDef definition

class DescribeElasticLoadBalancersResultTypeDef(TypedDict):
    ElasticLoadBalancers: List[ElasticLoadBalancerTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ElasticLoadBalancerTypeDef
  2. See ResponseMetadataTypeDef

DescribeMyUserProfileResultTypeDef#

# DescribeMyUserProfileResultTypeDef definition

class DescribeMyUserProfileResultTypeDef(TypedDict):
    UserProfile: SelfUserProfileTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SelfUserProfileTypeDef
  2. See ResponseMetadataTypeDef

DescribePermissionsResultTypeDef#

# DescribePermissionsResultTypeDef definition

class DescribePermissionsResultTypeDef(TypedDict):
    Permissions: List[PermissionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PermissionTypeDef
  2. See ResponseMetadataTypeDef

DescribeRaidArraysResultTypeDef#

# DescribeRaidArraysResultTypeDef definition

class DescribeRaidArraysResultTypeDef(TypedDict):
    RaidArrays: List[RaidArrayTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RaidArrayTypeDef
  2. See ResponseMetadataTypeDef

DescribeRdsDbInstancesResultTypeDef#

# DescribeRdsDbInstancesResultTypeDef definition

class DescribeRdsDbInstancesResultTypeDef(TypedDict):
    RdsDbInstances: List[RdsDbInstanceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RdsDbInstanceTypeDef
  2. See ResponseMetadataTypeDef

DescribeServiceErrorsResultTypeDef#

# DescribeServiceErrorsResultTypeDef definition

class DescribeServiceErrorsResultTypeDef(TypedDict):
    ServiceErrors: List[ServiceErrorTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ServiceErrorTypeDef
  2. See ResponseMetadataTypeDef

DescribeUserProfilesResultTypeDef#

# DescribeUserProfilesResultTypeDef definition

class DescribeUserProfilesResultTypeDef(TypedDict):
    UserProfiles: List[UserProfileTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserProfileTypeDef
  2. See ResponseMetadataTypeDef

DescribeVolumesResultTypeDef#

# DescribeVolumesResultTypeDef definition

class DescribeVolumesResultTypeDef(TypedDict):
    Volumes: List[VolumeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See VolumeTypeDef
  2. See ResponseMetadataTypeDef

GrantAccessResultTypeDef#

# GrantAccessResultTypeDef definition

class GrantAccessResultTypeDef(TypedDict):
    TemporaryCredential: TemporaryCredentialTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TemporaryCredentialTypeDef
  2. See ResponseMetadataTypeDef

RegisterInstanceRequestRequestTypeDef#

# RegisterInstanceRequestRequestTypeDef definition

class RegisterInstanceRequestRequestTypeDef(TypedDict):
    StackId: str,
    Hostname: NotRequired[str],
    PublicIp: NotRequired[str],
    PrivateIp: NotRequired[str],
    RsaPublicKey: NotRequired[str],
    RsaPublicKeyFingerprint: NotRequired[str],
    InstanceIdentity: NotRequired[InstanceIdentityTypeDef],  # (1)
  1. See InstanceIdentityTypeDef

StackSummaryTypeDef#

# StackSummaryTypeDef definition

class StackSummaryTypeDef(TypedDict):
    StackId: NotRequired[str],
    Name: NotRequired[str],
    Arn: NotRequired[str],
    LayersCount: NotRequired[int],
    AppsCount: NotRequired[int],
    InstancesCount: NotRequired[InstancesCountTypeDef],  # (1)
  1. See InstancesCountTypeDef

LifecycleEventConfigurationResponseTypeDef#

# LifecycleEventConfigurationResponseTypeDef definition

class LifecycleEventConfigurationResponseTypeDef(TypedDict):
    Shutdown: ShutdownEventConfigurationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ShutdownEventConfigurationTypeDef
  2. See ResponseMetadataTypeDef

LifecycleEventConfigurationTypeDef#

# LifecycleEventConfigurationTypeDef definition

class LifecycleEventConfigurationTypeDef(TypedDict):
    Shutdown: NotRequired[ShutdownEventConfigurationTypeDef],  # (1)
  1. See ShutdownEventConfigurationTypeDef

OperatingSystemTypeDef#

# OperatingSystemTypeDef definition

class OperatingSystemTypeDef(TypedDict):
    Name: NotRequired[str],
    Id: NotRequired[str],
    Type: NotRequired[str],
    ConfigurationManagers: NotRequired[List[OperatingSystemConfigurationManagerTypeDef]],  # (1)
    ReportedName: NotRequired[str],
    ReportedVersion: NotRequired[str],
    Supported: NotRequired[bool],
  1. See OperatingSystemConfigurationManagerTypeDef

SetTimeBasedAutoScalingRequestRequestTypeDef#

# SetTimeBasedAutoScalingRequestRequestTypeDef definition

class SetTimeBasedAutoScalingRequestRequestTypeDef(TypedDict):
    InstanceId: str,
    AutoScalingSchedule: NotRequired[WeeklyAutoScalingScheduleTypeDef],  # (1)
  1. See WeeklyAutoScalingScheduleTypeDef

TimeBasedAutoScalingConfigurationTypeDef#

# TimeBasedAutoScalingConfigurationTypeDef definition

class TimeBasedAutoScalingConfigurationTypeDef(TypedDict):
    InstanceId: NotRequired[str],
    AutoScalingSchedule: NotRequired[WeeklyAutoScalingScheduleTypeDef],  # (1)
  1. See WeeklyAutoScalingScheduleTypeDef

DescribeAgentVersionsResultTypeDef#

# DescribeAgentVersionsResultTypeDef definition

class DescribeAgentVersionsResultTypeDef(TypedDict):
    AgentVersions: List[AgentVersionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AgentVersionTypeDef
  2. See ResponseMetadataTypeDef

DescribeAppsResultTypeDef#

# DescribeAppsResultTypeDef definition

class DescribeAppsResultTypeDef(TypedDict):
    Apps: List[AppTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AppTypeDef
  2. See ResponseMetadataTypeDef

DescribeLoadBasedAutoScalingResultTypeDef#

# DescribeLoadBasedAutoScalingResultTypeDef definition

class DescribeLoadBasedAutoScalingResultTypeDef(TypedDict):
    LoadBasedAutoScalingConfigurations: List[LoadBasedAutoScalingConfigurationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LoadBasedAutoScalingConfigurationTypeDef
  2. See ResponseMetadataTypeDef

CreateInstanceRequestRequestTypeDef#

# CreateInstanceRequestRequestTypeDef definition

class CreateInstanceRequestRequestTypeDef(TypedDict):
    StackId: str,
    LayerIds: Sequence[str],
    InstanceType: str,
    AutoScalingType: NotRequired[AutoScalingTypeType],  # (1)
    Hostname: NotRequired[str],
    Os: NotRequired[str],
    AmiId: NotRequired[str],
    SshKeyName: NotRequired[str],
    AvailabilityZone: NotRequired[str],
    VirtualizationType: NotRequired[str],
    SubnetId: NotRequired[str],
    Architecture: NotRequired[ArchitectureType],  # (2)
    RootDeviceType: NotRequired[RootDeviceTypeType],  # (3)
    BlockDeviceMappings: NotRequired[Sequence[BlockDeviceMappingTypeDef]],  # (4)
    InstallUpdatesOnBoot: NotRequired[bool],
    EbsOptimized: NotRequired[bool],
    AgentVersion: NotRequired[str],
    Tenancy: NotRequired[str],
  1. See AutoScalingTypeType
  2. See ArchitectureType
  3. See RootDeviceTypeType
  4. See BlockDeviceMappingTypeDef

InstanceTypeDef#

# InstanceTypeDef definition

class InstanceTypeDef(TypedDict):
    AgentVersion: NotRequired[str],
    AmiId: NotRequired[str],
    Architecture: NotRequired[ArchitectureType],  # (1)
    Arn: NotRequired[str],
    AutoScalingType: NotRequired[AutoScalingTypeType],  # (2)
    AvailabilityZone: NotRequired[str],
    BlockDeviceMappings: NotRequired[List[BlockDeviceMappingTypeDef]],  # (3)
    CreatedAt: NotRequired[str],
    EbsOptimized: NotRequired[bool],
    Ec2InstanceId: NotRequired[str],
    EcsClusterArn: NotRequired[str],
    EcsContainerInstanceArn: NotRequired[str],
    ElasticIp: NotRequired[str],
    Hostname: NotRequired[str],
    InfrastructureClass: NotRequired[str],
    InstallUpdatesOnBoot: NotRequired[bool],
    InstanceId: NotRequired[str],
    InstanceProfileArn: NotRequired[str],
    InstanceType: NotRequired[str],
    LastServiceErrorId: NotRequired[str],
    LayerIds: NotRequired[List[str]],
    Os: NotRequired[str],
    Platform: NotRequired[str],
    PrivateDns: NotRequired[str],
    PrivateIp: NotRequired[str],
    PublicDns: NotRequired[str],
    PublicIp: NotRequired[str],
    RegisteredBy: NotRequired[str],
    ReportedAgentVersion: NotRequired[str],
    ReportedOs: NotRequired[ReportedOsTypeDef],  # (4)
    RootDeviceType: NotRequired[RootDeviceTypeType],  # (5)
    RootDeviceVolumeId: NotRequired[str],
    SecurityGroupIds: NotRequired[List[str]],
    SshHostDsaKeyFingerprint: NotRequired[str],
    SshHostRsaKeyFingerprint: NotRequired[str],
    SshKeyName: NotRequired[str],
    StackId: NotRequired[str],
    Status: NotRequired[str],
    SubnetId: NotRequired[str],
    Tenancy: NotRequired[str],
    VirtualizationType: NotRequired[VirtualizationTypeType],  # (6)
  1. See ArchitectureType
  2. See AutoScalingTypeType
  3. See BlockDeviceMappingTypeDef
  4. See ReportedOsTypeDef
  5. See RootDeviceTypeType
  6. See VirtualizationTypeType

DescribeStacksResultTypeDef#

# DescribeStacksResultTypeDef definition

class DescribeStacksResultTypeDef(TypedDict):
    Stacks: List[StackTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StackTypeDef
  2. See ResponseMetadataTypeDef

DescribeDeploymentsResultTypeDef#

# DescribeDeploymentsResultTypeDef definition

class DescribeDeploymentsResultTypeDef(TypedDict):
    Deployments: List[DeploymentTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DeploymentTypeDef
  2. See ResponseMetadataTypeDef

DescribeStackSummaryResultTypeDef#

# DescribeStackSummaryResultTypeDef definition

class DescribeStackSummaryResultTypeDef(TypedDict):
    StackSummary: StackSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See StackSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateLayerRequestRequestTypeDef#

# CreateLayerRequestRequestTypeDef definition

class CreateLayerRequestRequestTypeDef(TypedDict):
    StackId: str,
    Type: LayerTypeType,  # (1)
    Name: str,
    Shortname: str,
    Attributes: NotRequired[Mapping[LayerAttributesKeysType, str]],  # (2)
    CloudWatchLogsConfiguration: NotRequired[CloudWatchLogsConfigurationTypeDef],  # (3)
    CustomInstanceProfileArn: NotRequired[str],
    CustomJson: NotRequired[str],
    CustomSecurityGroupIds: NotRequired[Sequence[str]],
    Packages: NotRequired[Sequence[str]],
    VolumeConfigurations: NotRequired[Sequence[VolumeConfigurationTypeDef]],  # (4)
    EnableAutoHealing: NotRequired[bool],
    AutoAssignElasticIps: NotRequired[bool],
    AutoAssignPublicIps: NotRequired[bool],
    CustomRecipes: NotRequired[RecipesTypeDef],  # (5)
    InstallUpdatesOnBoot: NotRequired[bool],
    UseEbsOptimizedInstances: NotRequired[bool],
    LifecycleEventConfiguration: NotRequired[LifecycleEventConfigurationTypeDef],  # (6)
  1. See LayerTypeType
  2. See LayerAttributesKeysType
  3. See CloudWatchLogsConfigurationTypeDef
  4. See VolumeConfigurationTypeDef
  5. See RecipesTypeDef
  6. See LifecycleEventConfigurationTypeDef

CreateLayerRequestStackCreateLayerTypeDef#

# CreateLayerRequestStackCreateLayerTypeDef definition

class CreateLayerRequestStackCreateLayerTypeDef(TypedDict):
    Type: LayerTypeType,  # (1)
    Name: str,
    Shortname: str,
    Attributes: NotRequired[Mapping[LayerAttributesKeysType, str]],  # (2)
    CloudWatchLogsConfiguration: NotRequired[CloudWatchLogsConfigurationTypeDef],  # (3)
    CustomInstanceProfileArn: NotRequired[str],
    CustomJson: NotRequired[str],
    CustomSecurityGroupIds: NotRequired[Sequence[str]],
    Packages: NotRequired[Sequence[str]],
    VolumeConfigurations: NotRequired[Sequence[VolumeConfigurationTypeDef]],  # (4)
    EnableAutoHealing: NotRequired[bool],
    AutoAssignElasticIps: NotRequired[bool],
    AutoAssignPublicIps: NotRequired[bool],
    CustomRecipes: NotRequired[RecipesTypeDef],  # (5)
    InstallUpdatesOnBoot: NotRequired[bool],
    UseEbsOptimizedInstances: NotRequired[bool],
    LifecycleEventConfiguration: NotRequired[LifecycleEventConfigurationTypeDef],  # (6)
  1. See LayerTypeType
  2. See LayerAttributesKeysType
  3. See CloudWatchLogsConfigurationTypeDef
  4. See VolumeConfigurationTypeDef
  5. See RecipesTypeDef
  6. See LifecycleEventConfigurationTypeDef

LayerTypeDef#

# LayerTypeDef definition

class LayerTypeDef(TypedDict):
    Arn: NotRequired[str],
    StackId: NotRequired[str],
    LayerId: NotRequired[str],
    Type: NotRequired[LayerTypeType],  # (1)
    Name: NotRequired[str],
    Shortname: NotRequired[str],
    Attributes: NotRequired[Dict[LayerAttributesKeysType, str]],  # (2)
    CloudWatchLogsConfiguration: NotRequired[CloudWatchLogsConfigurationTypeDef],  # (3)
    CustomInstanceProfileArn: NotRequired[str],
    CustomJson: NotRequired[str],
    CustomSecurityGroupIds: NotRequired[List[str]],
    DefaultSecurityGroupNames: NotRequired[List[str]],
    Packages: NotRequired[List[str]],
    VolumeConfigurations: NotRequired[List[VolumeConfigurationTypeDef]],  # (4)
    EnableAutoHealing: NotRequired[bool],
    AutoAssignElasticIps: NotRequired[bool],
    AutoAssignPublicIps: NotRequired[bool],
    DefaultRecipes: NotRequired[RecipesTypeDef],  # (5)
    CustomRecipes: NotRequired[RecipesTypeDef],  # (5)
    CreatedAt: NotRequired[str],
    InstallUpdatesOnBoot: NotRequired[bool],
    UseEbsOptimizedInstances: NotRequired[bool],
    LifecycleEventConfiguration: NotRequired[LifecycleEventConfigurationTypeDef],  # (7)
  1. See LayerTypeType
  2. See LayerAttributesKeysType
  3. See CloudWatchLogsConfigurationTypeDef
  4. See VolumeConfigurationTypeDef
  5. See RecipesTypeDef
  6. See RecipesTypeDef
  7. See LifecycleEventConfigurationTypeDef

UpdateLayerRequestRequestTypeDef#

# UpdateLayerRequestRequestTypeDef definition

class UpdateLayerRequestRequestTypeDef(TypedDict):
    LayerId: str,
    Name: NotRequired[str],
    Shortname: NotRequired[str],
    Attributes: NotRequired[Mapping[LayerAttributesKeysType, str]],  # (1)
    CloudWatchLogsConfiguration: NotRequired[CloudWatchLogsConfigurationTypeDef],  # (2)
    CustomInstanceProfileArn: NotRequired[str],
    CustomJson: NotRequired[str],
    CustomSecurityGroupIds: NotRequired[Sequence[str]],
    Packages: NotRequired[Sequence[str]],
    VolumeConfigurations: NotRequired[Sequence[VolumeConfigurationTypeDef]],  # (3)
    EnableAutoHealing: NotRequired[bool],
    AutoAssignElasticIps: NotRequired[bool],
    AutoAssignPublicIps: NotRequired[bool],
    CustomRecipes: NotRequired[RecipesTypeDef],  # (4)
    InstallUpdatesOnBoot: NotRequired[bool],
    UseEbsOptimizedInstances: NotRequired[bool],
    LifecycleEventConfiguration: NotRequired[LifecycleEventConfigurationTypeDef],  # (5)
  1. See LayerAttributesKeysType
  2. See CloudWatchLogsConfigurationTypeDef
  3. See VolumeConfigurationTypeDef
  4. See RecipesTypeDef
  5. See LifecycleEventConfigurationTypeDef

DescribeOperatingSystemsResponseTypeDef#

# DescribeOperatingSystemsResponseTypeDef definition

class DescribeOperatingSystemsResponseTypeDef(TypedDict):
    OperatingSystems: List[OperatingSystemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See OperatingSystemTypeDef
  2. See ResponseMetadataTypeDef

DescribeTimeBasedAutoScalingResultTypeDef#

# DescribeTimeBasedAutoScalingResultTypeDef definition

class DescribeTimeBasedAutoScalingResultTypeDef(TypedDict):
    TimeBasedAutoScalingConfigurations: List[TimeBasedAutoScalingConfigurationTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TimeBasedAutoScalingConfigurationTypeDef
  2. See ResponseMetadataTypeDef

DescribeInstancesResultTypeDef#

# DescribeInstancesResultTypeDef definition

class DescribeInstancesResultTypeDef(TypedDict):
    Instances: List[InstanceTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InstanceTypeDef
  2. See ResponseMetadataTypeDef

DescribeLayersResultTypeDef#

# DescribeLayersResultTypeDef definition

class DescribeLayersResultTypeDef(TypedDict):
    Layers: List[LayerTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LayerTypeDef
  2. See ResponseMetadataTypeDef