Skip to content

Type definitions#

Index > MQ > Type definitions

Auto-generated documentation for MQ type annotations stubs module mypy-boto3-mq.

ActionRequiredTypeDef#

# ActionRequiredTypeDef definition

class ActionRequiredTypeDef(TypedDict):
    ActionRequiredCode: NotRequired[str],
    ActionRequiredInfo: NotRequired[str],

AvailabilityZoneTypeDef#

# AvailabilityZoneTypeDef definition

class AvailabilityZoneTypeDef(TypedDict):
    Name: NotRequired[str],

EngineVersionTypeDef#

# EngineVersionTypeDef definition

class EngineVersionTypeDef(TypedDict):
    Name: NotRequired[str],

BrokerInstanceTypeDef#

# BrokerInstanceTypeDef definition

class BrokerInstanceTypeDef(TypedDict):
    ConsoleURL: NotRequired[str],
    Endpoints: NotRequired[List[str]],
    IpAddress: NotRequired[str],

BrokerSummaryTypeDef#

# BrokerSummaryTypeDef definition

class BrokerSummaryTypeDef(TypedDict):
    DeploymentMode: DeploymentModeType,  # (2)
    EngineType: EngineTypeType,  # (3)
    BrokerArn: NotRequired[str],
    BrokerId: NotRequired[str],
    BrokerName: NotRequired[str],
    BrokerState: NotRequired[BrokerStateType],  # (1)
    Created: NotRequired[datetime],
    HostInstanceType: NotRequired[str],
  1. See BrokerStateType
  2. See DeploymentModeType
  3. See EngineTypeType

ConfigurationIdTypeDef#

# ConfigurationIdTypeDef definition

class ConfigurationIdTypeDef(TypedDict):
    Id: str,
    Revision: NotRequired[int],

ConfigurationRevisionTypeDef#

# ConfigurationRevisionTypeDef definition

class ConfigurationRevisionTypeDef(TypedDict):
    Created: datetime,
    Revision: int,
    Description: NotRequired[str],

EncryptionOptionsTypeDef#

# EncryptionOptionsTypeDef definition

class EncryptionOptionsTypeDef(TypedDict):
    UseAwsOwnedKey: bool,
    KmsKeyId: NotRequired[str],

LdapServerMetadataInputTypeDef#

# LdapServerMetadataInputTypeDef definition

class LdapServerMetadataInputTypeDef(TypedDict):
    Hosts: Sequence[str],
    RoleBase: str,
    RoleSearchMatching: str,
    ServiceAccountPassword: str,
    ServiceAccountUsername: str,
    UserBase: str,
    UserSearchMatching: str,
    RoleName: NotRequired[str],
    RoleSearchSubtree: NotRequired[bool],
    UserRoleName: NotRequired[str],
    UserSearchSubtree: NotRequired[bool],

LogsTypeDef#

# LogsTypeDef definition

class LogsTypeDef(TypedDict):
    Audit: NotRequired[bool],
    General: NotRequired[bool],

UserTypeDef#

# UserTypeDef definition

class UserTypeDef(TypedDict):
    Password: str,
    Username: str,
    ConsoleAccess: NotRequired[bool],
    Groups: NotRequired[Sequence[str]],
    ReplicationUser: NotRequired[bool],

WeeklyStartTimeTypeDef#

# WeeklyStartTimeTypeDef definition

class WeeklyStartTimeTypeDef(TypedDict):
    DayOfWeek: DayOfWeekType,  # (1)
    TimeOfDay: str,
    TimeZone: NotRequired[str],
  1. See DayOfWeekType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CreateConfigurationRequestRequestTypeDef#

# CreateConfigurationRequestRequestTypeDef definition

class CreateConfigurationRequestRequestTypeDef(TypedDict):
    EngineType: EngineTypeType,  # (1)
    EngineVersion: str,
    Name: str,
    AuthenticationStrategy: NotRequired[AuthenticationStrategyType],  # (2)
    Tags: NotRequired[Mapping[str, str]],
  1. See EngineTypeType
  2. See AuthenticationStrategyType

CreateTagsRequestRequestTypeDef#

# CreateTagsRequestRequestTypeDef definition

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

CreateUserRequestRequestTypeDef#

# CreateUserRequestRequestTypeDef definition

class CreateUserRequestRequestTypeDef(TypedDict):
    BrokerId: str,
    Password: str,
    Username: str,
    ConsoleAccess: NotRequired[bool],
    Groups: NotRequired[Sequence[str]],
    ReplicationUser: NotRequired[bool],

DataReplicationCounterpartTypeDef#

# DataReplicationCounterpartTypeDef definition

class DataReplicationCounterpartTypeDef(TypedDict):
    BrokerId: str,
    Region: str,

DeleteBrokerRequestRequestTypeDef#

# DeleteBrokerRequestRequestTypeDef definition

class DeleteBrokerRequestRequestTypeDef(TypedDict):
    BrokerId: str,

DeleteTagsRequestRequestTypeDef#

# DeleteTagsRequestRequestTypeDef definition

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

DeleteUserRequestRequestTypeDef#

# DeleteUserRequestRequestTypeDef definition

class DeleteUserRequestRequestTypeDef(TypedDict):
    BrokerId: str,
    Username: str,

DescribeBrokerEngineTypesRequestRequestTypeDef#

# DescribeBrokerEngineTypesRequestRequestTypeDef definition

class DescribeBrokerEngineTypesRequestRequestTypeDef(TypedDict):
    EngineType: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeBrokerInstanceOptionsRequestRequestTypeDef#

# DescribeBrokerInstanceOptionsRequestRequestTypeDef definition

class DescribeBrokerInstanceOptionsRequestRequestTypeDef(TypedDict):
    EngineType: NotRequired[str],
    HostInstanceType: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    StorageType: NotRequired[str],

DescribeBrokerRequestRequestTypeDef#

# DescribeBrokerRequestRequestTypeDef definition

class DescribeBrokerRequestRequestTypeDef(TypedDict):
    BrokerId: str,

LdapServerMetadataOutputTypeDef#

# LdapServerMetadataOutputTypeDef definition

class LdapServerMetadataOutputTypeDef(TypedDict):
    Hosts: List[str],
    RoleBase: str,
    RoleSearchMatching: str,
    ServiceAccountUsername: str,
    UserBase: str,
    UserSearchMatching: str,
    RoleName: NotRequired[str],
    RoleSearchSubtree: NotRequired[bool],
    UserRoleName: NotRequired[str],
    UserSearchSubtree: NotRequired[bool],

UserSummaryTypeDef#

# UserSummaryTypeDef definition

class UserSummaryTypeDef(TypedDict):
    Username: str,
    PendingChange: NotRequired[ChangeTypeType],  # (1)
  1. See ChangeTypeType

DescribeConfigurationRequestRequestTypeDef#

# DescribeConfigurationRequestRequestTypeDef definition

class DescribeConfigurationRequestRequestTypeDef(TypedDict):
    ConfigurationId: str,

DescribeConfigurationRevisionRequestRequestTypeDef#

# DescribeConfigurationRevisionRequestRequestTypeDef definition

class DescribeConfigurationRevisionRequestRequestTypeDef(TypedDict):
    ConfigurationId: str,
    ConfigurationRevision: str,

DescribeUserRequestRequestTypeDef#

# DescribeUserRequestRequestTypeDef definition

class DescribeUserRequestRequestTypeDef(TypedDict):
    BrokerId: str,
    Username: str,

UserPendingChangesTypeDef#

# UserPendingChangesTypeDef definition

class UserPendingChangesTypeDef(TypedDict):
    PendingChange: ChangeTypeType,  # (1)
    ConsoleAccess: NotRequired[bool],
    Groups: NotRequired[List[str]],
  1. See ChangeTypeType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListBrokersRequestRequestTypeDef#

# ListBrokersRequestRequestTypeDef definition

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

ListConfigurationRevisionsRequestRequestTypeDef#

# ListConfigurationRevisionsRequestRequestTypeDef definition

class ListConfigurationRevisionsRequestRequestTypeDef(TypedDict):
    ConfigurationId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListConfigurationsRequestRequestTypeDef#

# ListConfigurationsRequestRequestTypeDef definition

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

ListTagsRequestRequestTypeDef#

# ListTagsRequestRequestTypeDef definition

class ListTagsRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ListUsersRequestRequestTypeDef#

# ListUsersRequestRequestTypeDef definition

class ListUsersRequestRequestTypeDef(TypedDict):
    BrokerId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

PendingLogsTypeDef#

# PendingLogsTypeDef definition

class PendingLogsTypeDef(TypedDict):
    Audit: NotRequired[bool],
    General: NotRequired[bool],

PromoteRequestRequestTypeDef#

# PromoteRequestRequestTypeDef definition

class PromoteRequestRequestTypeDef(TypedDict):
    BrokerId: str,
    Mode: PromoteModeType,  # (1)
  1. See PromoteModeType

RebootBrokerRequestRequestTypeDef#

# RebootBrokerRequestRequestTypeDef definition

class RebootBrokerRequestRequestTypeDef(TypedDict):
    BrokerId: str,

SanitizationWarningTypeDef#

# SanitizationWarningTypeDef definition

class SanitizationWarningTypeDef(TypedDict):
    Reason: SanitizationWarningReasonType,  # (1)
    AttributeName: NotRequired[str],
    ElementName: NotRequired[str],
  1. See SanitizationWarningReasonType

UpdateConfigurationRequestRequestTypeDef#

# UpdateConfigurationRequestRequestTypeDef definition

class UpdateConfigurationRequestRequestTypeDef(TypedDict):
    ConfigurationId: str,
    Data: str,
    Description: NotRequired[str],

UpdateUserRequestRequestTypeDef#

# UpdateUserRequestRequestTypeDef definition

class UpdateUserRequestRequestTypeDef(TypedDict):
    BrokerId: str,
    Username: str,
    ConsoleAccess: NotRequired[bool],
    Groups: NotRequired[Sequence[str]],
    Password: NotRequired[str],
    ReplicationUser: NotRequired[bool],

BrokerInstanceOptionTypeDef#

# BrokerInstanceOptionTypeDef definition

class BrokerInstanceOptionTypeDef(TypedDict):
    AvailabilityZones: NotRequired[List[AvailabilityZoneTypeDef]],  # (1)
    EngineType: NotRequired[EngineTypeType],  # (2)
    HostInstanceType: NotRequired[str],
    StorageType: NotRequired[BrokerStorageTypeType],  # (3)
    SupportedDeploymentModes: NotRequired[List[DeploymentModeType]],  # (4)
    SupportedEngineVersions: NotRequired[List[str]],
  1. See AvailabilityZoneTypeDef
  2. See EngineTypeType
  3. See BrokerStorageTypeType
  4. See DeploymentModeType

BrokerEngineTypeTypeDef#

# BrokerEngineTypeTypeDef definition

class BrokerEngineTypeTypeDef(TypedDict):
    EngineType: NotRequired[EngineTypeType],  # (1)
    EngineVersions: NotRequired[List[EngineVersionTypeDef]],  # (2)
  1. See EngineTypeType
  2. See EngineVersionTypeDef

ConfigurationsTypeDef#

# ConfigurationsTypeDef definition

class ConfigurationsTypeDef(TypedDict):
    Current: NotRequired[ConfigurationIdTypeDef],  # (1)
    History: NotRequired[List[ConfigurationIdTypeDef]],  # (2)
    Pending: NotRequired[ConfigurationIdTypeDef],  # (1)
  1. See ConfigurationIdTypeDef
  2. See ConfigurationIdTypeDef
  3. See ConfigurationIdTypeDef

ConfigurationTypeDef#

# ConfigurationTypeDef definition

class ConfigurationTypeDef(TypedDict):
    Arn: str,
    AuthenticationStrategy: AuthenticationStrategyType,  # (1)
    Created: datetime,
    Description: str,
    EngineType: EngineTypeType,  # (2)
    EngineVersion: str,
    Id: str,
    LatestRevision: ConfigurationRevisionTypeDef,  # (3)
    Name: str,
    Tags: NotRequired[Dict[str, str]],
  1. See AuthenticationStrategyType
  2. See EngineTypeType
  3. See ConfigurationRevisionTypeDef

CreateBrokerRequestRequestTypeDef#

# CreateBrokerRequestRequestTypeDef definition

class CreateBrokerRequestRequestTypeDef(TypedDict):
    AutoMinorVersionUpgrade: bool,
    BrokerName: str,
    DeploymentMode: DeploymentModeType,  # (1)
    EngineType: EngineTypeType,  # (2)
    EngineVersion: str,
    HostInstanceType: str,
    PubliclyAccessible: bool,
    Users: Sequence[UserTypeDef],  # (3)
    AuthenticationStrategy: NotRequired[AuthenticationStrategyType],  # (4)
    Configuration: NotRequired[ConfigurationIdTypeDef],  # (5)
    CreatorRequestId: NotRequired[str],
    EncryptionOptions: NotRequired[EncryptionOptionsTypeDef],  # (6)
    LdapServerMetadata: NotRequired[LdapServerMetadataInputTypeDef],  # (7)
    Logs: NotRequired[LogsTypeDef],  # (8)
    MaintenanceWindowStartTime: NotRequired[WeeklyStartTimeTypeDef],  # (9)
    SecurityGroups: NotRequired[Sequence[str]],
    StorageType: NotRequired[BrokerStorageTypeType],  # (10)
    SubnetIds: NotRequired[Sequence[str]],
    Tags: NotRequired[Mapping[str, str]],
    DataReplicationMode: NotRequired[DataReplicationModeType],  # (11)
    DataReplicationPrimaryBrokerArn: NotRequired[str],
  1. See DeploymentModeType
  2. See EngineTypeType
  3. See UserTypeDef
  4. See AuthenticationStrategyType
  5. See ConfigurationIdTypeDef
  6. See EncryptionOptionsTypeDef
  7. See LdapServerMetadataInputTypeDef
  8. See LogsTypeDef
  9. See WeeklyStartTimeTypeDef
  10. See BrokerStorageTypeType
  11. See DataReplicationModeType

UpdateBrokerRequestRequestTypeDef#

# UpdateBrokerRequestRequestTypeDef definition

class UpdateBrokerRequestRequestTypeDef(TypedDict):
    BrokerId: str,
    AuthenticationStrategy: NotRequired[AuthenticationStrategyType],  # (1)
    AutoMinorVersionUpgrade: NotRequired[bool],
    Configuration: NotRequired[ConfigurationIdTypeDef],  # (2)
    EngineVersion: NotRequired[str],
    HostInstanceType: NotRequired[str],
    LdapServerMetadata: NotRequired[LdapServerMetadataInputTypeDef],  # (3)
    Logs: NotRequired[LogsTypeDef],  # (4)
    MaintenanceWindowStartTime: NotRequired[WeeklyStartTimeTypeDef],  # (5)
    SecurityGroups: NotRequired[Sequence[str]],
    DataReplicationMode: NotRequired[DataReplicationModeType],  # (6)
  1. See AuthenticationStrategyType
  2. See ConfigurationIdTypeDef
  3. See LdapServerMetadataInputTypeDef
  4. See LogsTypeDef
  5. See WeeklyStartTimeTypeDef
  6. See DataReplicationModeType

CreateBrokerResponseTypeDef#

# CreateBrokerResponseTypeDef definition

class CreateBrokerResponseTypeDef(TypedDict):
    BrokerArn: str,
    BrokerId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateConfigurationResponseTypeDef#

# CreateConfigurationResponseTypeDef definition

class CreateConfigurationResponseTypeDef(TypedDict):
    Arn: str,
    AuthenticationStrategy: AuthenticationStrategyType,  # (1)
    Created: datetime,
    Id: str,
    LatestRevision: ConfigurationRevisionTypeDef,  # (2)
    Name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AuthenticationStrategyType
  2. See ConfigurationRevisionTypeDef
  3. See ResponseMetadataTypeDef

DeleteBrokerResponseTypeDef#

# DeleteBrokerResponseTypeDef definition

class DeleteBrokerResponseTypeDef(TypedDict):
    BrokerId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeConfigurationResponseTypeDef#

# DescribeConfigurationResponseTypeDef definition

class DescribeConfigurationResponseTypeDef(TypedDict):
    Arn: str,
    AuthenticationStrategy: AuthenticationStrategyType,  # (1)
    Created: datetime,
    Description: str,
    EngineType: EngineTypeType,  # (2)
    EngineVersion: str,
    Id: str,
    LatestRevision: ConfigurationRevisionTypeDef,  # (3)
    Name: str,
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See AuthenticationStrategyType
  2. See EngineTypeType
  3. See ConfigurationRevisionTypeDef
  4. See ResponseMetadataTypeDef

DescribeConfigurationRevisionResponseTypeDef#

# DescribeConfigurationRevisionResponseTypeDef definition

class DescribeConfigurationRevisionResponseTypeDef(TypedDict):
    ConfigurationId: str,
    Created: datetime,
    Data: str,
    Description: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

ListBrokersResponseTypeDef#

# ListBrokersResponseTypeDef definition

class ListBrokersResponseTypeDef(TypedDict):
    BrokerSummaries: List[BrokerSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See BrokerSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListConfigurationRevisionsResponseTypeDef#

# ListConfigurationRevisionsResponseTypeDef definition

class ListConfigurationRevisionsResponseTypeDef(TypedDict):
    ConfigurationId: str,
    MaxResults: int,
    Revisions: List[ConfigurationRevisionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ConfigurationRevisionTypeDef
  2. See ResponseMetadataTypeDef

ListTagsResponseTypeDef#

# ListTagsResponseTypeDef definition

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

PromoteResponseTypeDef#

# PromoteResponseTypeDef definition

class PromoteResponseTypeDef(TypedDict):
    BrokerId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See