Skip to content

MQClient#

Index > MQ > MQClient

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

MQClient#

Type annotations and code completion for boto3.client("mq"). boto3 documentation

# MQClient usage example

from boto3.session import Session
from types_boto3_mq.client import MQClient

def get_mq_client() -> MQClient:
    return Session().client("mq")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("mq").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("mq")

try:
    do_something(client)
except (
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.ForbiddenException,
    client.exceptions.InternalServerErrorException,
    client.exceptions.NotFoundException,
    client.exceptions.UnauthorizedException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_mq.client import Exceptions

def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("mq").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("mq").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

create_broker#

Creates a broker.

Type annotations and code completion for boto3.client("mq").create_broker method. boto3 documentation

# create_broker method definition

def create_broker(
    self,
    *,
    BrokerName: str,
    DeploymentMode: DeploymentModeType,  # (1)
    EngineType: EngineTypeType,  # (2)
    HostInstanceType: str,
    PubliclyAccessible: bool,
    AuthenticationStrategy: AuthenticationStrategyType = ...,  # (3)
    AutoMinorVersionUpgrade: bool = ...,
    Configuration: ConfigurationIdTypeDef = ...,  # (4)
    CreatorRequestId: str = ...,
    EncryptionOptions: EncryptionOptionsTypeDef = ...,  # (5)
    EngineVersion: str = ...,
    LdapServerMetadata: LdapServerMetadataInputTypeDef = ...,  # (6)
    Logs: LogsTypeDef = ...,  # (7)
    MaintenanceWindowStartTime: WeeklyStartTimeTypeDef = ...,  # (8)
    SecurityGroups: Sequence[str] = ...,
    StorageType: BrokerStorageTypeType = ...,  # (9)
    SubnetIds: Sequence[str] = ...,
    Tags: Mapping[str, str] = ...,
    Users: Sequence[UserTypeDef] = ...,  # (10)
    DataReplicationMode: DataReplicationModeType = ...,  # (11)
    DataReplicationPrimaryBrokerArn: str = ...,
) -> CreateBrokerResponseTypeDef:  # (12)
    ...
  1. See DeploymentModeType
  2. See EngineTypeType
  3. See AuthenticationStrategyType
  4. See ConfigurationIdTypeDef
  5. See EncryptionOptionsTypeDef
  6. See LdapServerMetadataInputTypeDef
  7. See LogsTypeDef
  8. See WeeklyStartTimeTypeDef
  9. See BrokerStorageTypeType
  10. See Sequence[UserTypeDef]
  11. See DataReplicationModeType
  12. See CreateBrokerResponseTypeDef
# create_broker method usage example with argument unpacking

kwargs: CreateBrokerRequestTypeDef = {  # (1)
    "BrokerName": ...,
    "DeploymentMode": ...,
    "EngineType": ...,
    "HostInstanceType": ...,
    "PubliclyAccessible": ...,
}

parent.create_broker(**kwargs)
  1. See CreateBrokerRequestTypeDef

create_configuration#

Creates a new configuration for the specified configuration name.

Type annotations and code completion for boto3.client("mq").create_configuration method. boto3 documentation

# create_configuration method definition

def create_configuration(
    self,
    *,
    EngineType: EngineTypeType,  # (1)
    Name: str,
    AuthenticationStrategy: AuthenticationStrategyType = ...,  # (2)
    EngineVersion: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateConfigurationResponseTypeDef:  # (3)
    ...
  1. See EngineTypeType
  2. See AuthenticationStrategyType
  3. See CreateConfigurationResponseTypeDef
# create_configuration method usage example with argument unpacking

kwargs: CreateConfigurationRequestTypeDef = {  # (1)
    "EngineType": ...,
    "Name": ...,
}

parent.create_configuration(**kwargs)
  1. See CreateConfigurationRequestTypeDef

create_tags#

Add a tag to a resource.

Type annotations and code completion for boto3.client("mq").create_tags method. boto3 documentation

# create_tags method definition

def create_tags(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str] = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# create_tags method usage example with argument unpacking

kwargs: CreateTagsRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.create_tags(**kwargs)
  1. See CreateTagsRequestTypeDef

create_user#

Creates an ActiveMQ user.

Type annotations and code completion for boto3.client("mq").create_user method. boto3 documentation

# create_user method definition

def create_user(
    self,
    *,
    BrokerId: str,
    Password: str,
    Username: str,
    ConsoleAccess: bool = ...,
    Groups: Sequence[str] = ...,
    ReplicationUser: bool = ...,
) -> Dict[str, Any]:
    ...
# create_user method usage example with argument unpacking

kwargs: CreateUserRequestTypeDef = {  # (1)
    "BrokerId": ...,
    "Password": ...,
    "Username": ...,
}

parent.create_user(**kwargs)
  1. See CreateUserRequestTypeDef

delete_broker#

Deletes a broker.

Type annotations and code completion for boto3.client("mq").delete_broker method. boto3 documentation

# delete_broker method definition

def delete_broker(
    self,
    *,
    BrokerId: str,
) -> DeleteBrokerResponseTypeDef:  # (1)
    ...
  1. See DeleteBrokerResponseTypeDef
# delete_broker method usage example with argument unpacking

kwargs: DeleteBrokerRequestTypeDef = {  # (1)
    "BrokerId": ...,
}

parent.delete_broker(**kwargs)
  1. See DeleteBrokerRequestTypeDef

delete_configuration#

Deletes the specified configuration.

Type annotations and code completion for boto3.client("mq").delete_configuration method. boto3 documentation

# delete_configuration method definition

def delete_configuration(
    self,
    *,
    ConfigurationId: str,
) -> DeleteConfigurationResponseTypeDef:  # (1)
    ...
  1. See DeleteConfigurationResponseTypeDef
# delete_configuration method usage example with argument unpacking

kwargs: DeleteConfigurationRequestTypeDef = {  # (1)
    "ConfigurationId": ...,
}

parent.delete_configuration(**kwargs)
  1. See DeleteConfigurationRequestTypeDef

delete_tags#

Removes a tag from a resource.

Type annotations and code completion for boto3.client("mq").delete_tags method. boto3 documentation

# delete_tags method definition

def delete_tags(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_tags method usage example with argument unpacking

kwargs: DeleteTagsRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.delete_tags(**kwargs)
  1. See DeleteTagsRequestTypeDef

delete_user#

Deletes an ActiveMQ user.

Type annotations and code completion for boto3.client("mq").delete_user method. boto3 documentation

# delete_user method definition

def delete_user(
    self,
    *,
    BrokerId: str,
    Username: str,
) -> Dict[str, Any]:
    ...
# delete_user method usage example with argument unpacking

kwargs: DeleteUserRequestTypeDef = {  # (1)
    "BrokerId": ...,
    "Username": ...,
}

parent.delete_user(**kwargs)
  1. See DeleteUserRequestTypeDef

describe_broker#

Returns information about the specified broker.

Type annotations and code completion for boto3.client("mq").describe_broker method. boto3 documentation

# describe_broker method definition

def describe_broker(
    self,
    *,
    BrokerId: str,
) -> DescribeBrokerResponseTypeDef:  # (1)
    ...
  1. See DescribeBrokerResponseTypeDef
# describe_broker method usage example with argument unpacking

kwargs: DescribeBrokerRequestTypeDef = {  # (1)
    "BrokerId": ...,
}

parent.describe_broker(**kwargs)
  1. See DescribeBrokerRequestTypeDef

describe_broker_engine_types#

Describe available engine types and versions.

Type annotations and code completion for boto3.client("mq").describe_broker_engine_types method. boto3 documentation

# describe_broker_engine_types method definition

def describe_broker_engine_types(
    self,
    *,
    EngineType: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeBrokerEngineTypesResponseTypeDef:  # (1)
    ...
  1. See DescribeBrokerEngineTypesResponseTypeDef
# describe_broker_engine_types method usage example with argument unpacking

kwargs: DescribeBrokerEngineTypesRequestTypeDef = {  # (1)
    "EngineType": ...,
}

parent.describe_broker_engine_types(**kwargs)
  1. See DescribeBrokerEngineTypesRequestTypeDef

describe_broker_instance_options#

Describe available broker instance options.

Type annotations and code completion for boto3.client("mq").describe_broker_instance_options method. boto3 documentation

# describe_broker_instance_options method definition

def describe_broker_instance_options(
    self,
    *,
    EngineType: str = ...,
    HostInstanceType: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    StorageType: str = ...,
) -> DescribeBrokerInstanceOptionsResponseTypeDef:  # (1)
    ...
  1. See DescribeBrokerInstanceOptionsResponseTypeDef
# describe_broker_instance_options method usage example with argument unpacking

kwargs: DescribeBrokerInstanceOptionsRequestTypeDef = {  # (1)
    "EngineType": ...,
}

parent.describe_broker_instance_options(**kwargs)
  1. See DescribeBrokerInstanceOptionsRequestTypeDef

describe_configuration#

Returns information about the specified configuration.

Type annotations and code completion for boto3.client("mq").describe_configuration method. boto3 documentation

# describe_configuration method definition

def describe_configuration(
    self,
    *,
    ConfigurationId: str,
) -> DescribeConfigurationResponseTypeDef:  # (1)
    ...
  1. See DescribeConfigurationResponseTypeDef
# describe_configuration method usage example with argument unpacking

kwargs: DescribeConfigurationRequestTypeDef = {  # (1)
    "ConfigurationId": ...,
}

parent.describe_configuration(**kwargs)
  1. See DescribeConfigurationRequestTypeDef

describe_configuration_revision#

Returns the specified configuration revision for the specified configuration.

Type annotations and code completion for boto3.client("mq").describe_configuration_revision method. boto3 documentation

# describe_configuration_revision method definition

def describe_configuration_revision(
    self,
    *,
    ConfigurationId: str,
    ConfigurationRevision: str,
) -> DescribeConfigurationRevisionResponseTypeDef:  # (1)
    ...
  1. See DescribeConfigurationRevisionResponseTypeDef
# describe_configuration_revision method usage example with argument unpacking

kwargs: DescribeConfigurationRevisionRequestTypeDef = {  # (1)
    "ConfigurationId": ...,
    "ConfigurationRevision": ...,
}

parent.describe_configuration_revision(**kwargs)
  1. See DescribeConfigurationRevisionRequestTypeDef

describe_user#

Returns information about an ActiveMQ user.

Type annotations and code completion for boto3.client("mq").describe_user method. boto3 documentation

# describe_user method definition

def describe_user(
    self,
    *,
    BrokerId: str,
    Username: str,
) -> DescribeUserResponseTypeDef:  # (1)
    ...
  1. See DescribeUserResponseTypeDef
# describe_user method usage example with argument unpacking

kwargs: DescribeUserRequestTypeDef = {  # (1)
    "BrokerId": ...,
    "Username": ...,
}

parent.describe_user(**kwargs)
  1. See DescribeUserRequestTypeDef

list_brokers#

Returns a list of all brokers.

Type annotations and code completion for boto3.client("mq").list_brokers method. boto3 documentation

# list_brokers method definition

def list_brokers(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListBrokersResponseTypeDef:  # (1)
    ...
  1. See ListBrokersResponseTypeDef
# list_brokers method usage example with argument unpacking

kwargs: ListBrokersRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_brokers(**kwargs)
  1. See ListBrokersRequestTypeDef

list_configuration_revisions#

Returns a list of all revisions for the specified configuration.

Type annotations and code completion for boto3.client("mq").list_configuration_revisions method. boto3 documentation

# list_configuration_revisions method definition

def list_configuration_revisions(
    self,
    *,
    ConfigurationId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListConfigurationRevisionsResponseTypeDef:  # (1)
    ...
  1. See ListConfigurationRevisionsResponseTypeDef
# list_configuration_revisions method usage example with argument unpacking

kwargs: ListConfigurationRevisionsRequestTypeDef = {  # (1)
    "ConfigurationId": ...,
}

parent.list_configuration_revisions(**kwargs)
  1. See ListConfigurationRevisionsRequestTypeDef

list_configurations#

Returns a list of all configurations.

Type annotations and code completion for boto3.client("mq").list_configurations method. boto3 documentation

# list_configurations method definition

def list_configurations(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListConfigurationsResponseTypeDef:  # (1)
    ...
  1. See ListConfigurationsResponseTypeDef
# list_configurations method usage example with argument unpacking

kwargs: ListConfigurationsRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_configurations(**kwargs)
  1. See ListConfigurationsRequestTypeDef

list_tags#

Lists tags for a resource.

Type annotations and code completion for boto3.client("mq").list_tags method. boto3 documentation

# list_tags method definition

def list_tags(
    self,
    *,
    ResourceArn: str,
) -> ListTagsResponseTypeDef:  # (1)
    ...
  1. See ListTagsResponseTypeDef
# list_tags method usage example with argument unpacking

kwargs: ListTagsRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags(**kwargs)
  1. See ListTagsRequestTypeDef

list_users#

Returns a list of all ActiveMQ users.

Type annotations and code completion for boto3.client("mq").list_users method. boto3 documentation

# list_users method definition

def list_users(
    self,
    *,
    BrokerId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListUsersResponseTypeDef:  # (1)
    ...
  1. See ListUsersResponseTypeDef
# list_users method usage example with argument unpacking

kwargs: ListUsersRequestTypeDef = {  # (1)
    "BrokerId": ...,
}

parent.list_users(**kwargs)
  1. See ListUsersRequestTypeDef

promote#

Promotes a data replication replica broker to the primary broker role.

Type annotations and code completion for boto3.client("mq").promote method. boto3 documentation

# promote method definition

def promote(
    self,
    *,
    BrokerId: str,
    Mode: PromoteModeType,  # (1)
) -> PromoteResponseTypeDef:  # (2)
    ...
  1. See PromoteModeType
  2. See PromoteResponseTypeDef
# promote method usage example with argument unpacking

kwargs: PromoteRequestTypeDef = {  # (1)
    "BrokerId": ...,
    "Mode": ...,
}

parent.promote(**kwargs)
  1. See PromoteRequestTypeDef

reboot_broker#

Reboots a broker.

Type annotations and code completion for boto3.client("mq").reboot_broker method. boto3 documentation

# reboot_broker method definition

def reboot_broker(
    self,
    *,
    BrokerId: str,
) -> Dict[str, Any]:
    ...
# reboot_broker method usage example with argument unpacking

kwargs: RebootBrokerRequestTypeDef = {  # (1)
    "BrokerId": ...,
}

parent.reboot_broker(**kwargs)
  1. See RebootBrokerRequestTypeDef

update_broker#

Adds a pending configuration change to a broker.

Type annotations and code completion for boto3.client("mq").update_broker method. boto3 documentation

# update_broker method definition

def update_broker(
    self,
    *,
    BrokerId: str,
    AuthenticationStrategy: AuthenticationStrategyType = ...,  # (1)
    AutoMinorVersionUpgrade: bool = ...,
    Configuration: ConfigurationIdTypeDef = ...,  # (2)
    EngineVersion: str = ...,
    HostInstanceType: str = ...,
    LdapServerMetadata: LdapServerMetadataInputTypeDef = ...,  # (3)
    Logs: LogsTypeDef = ...,  # (4)
    MaintenanceWindowStartTime: WeeklyStartTimeTypeDef = ...,  # (5)
    SecurityGroups: Sequence[str] = ...,
    DataReplicationMode: DataReplicationModeType = ...,  # (6)
) -> UpdateBrokerResponseTypeDef:  # (7)
    ...
  1. See AuthenticationStrategyType
  2. See ConfigurationIdTypeDef
  3. See LdapServerMetadataInputTypeDef
  4. See LogsTypeDef
  5. See WeeklyStartTimeTypeDef
  6. See DataReplicationModeType
  7. See UpdateBrokerResponseTypeDef
# update_broker method usage example with argument unpacking

kwargs: UpdateBrokerRequestTypeDef = {  # (1)
    "BrokerId": ...,
}

parent.update_broker(**kwargs)
  1. See UpdateBrokerRequestTypeDef

update_configuration#

Updates the specified configuration.

Type annotations and code completion for boto3.client("mq").update_configuration method. boto3 documentation

# update_configuration method definition

def update_configuration(
    self,
    *,
    ConfigurationId: str,
    Data: str,
    Description: str = ...,
) -> UpdateConfigurationResponseTypeDef:  # (1)
    ...
  1. See UpdateConfigurationResponseTypeDef
# update_configuration method usage example with argument unpacking

kwargs: UpdateConfigurationRequestTypeDef = {  # (1)
    "ConfigurationId": ...,
    "Data": ...,
}

parent.update_configuration(**kwargs)
  1. See UpdateConfigurationRequestTypeDef

update_user#

Updates the information for an ActiveMQ user.

Type annotations and code completion for boto3.client("mq").update_user method. boto3 documentation

# update_user method definition

def update_user(
    self,
    *,
    BrokerId: str,
    Username: str,
    ConsoleAccess: bool = ...,
    Groups: Sequence[str] = ...,
    Password: str = ...,
    ReplicationUser: bool = ...,
) -> Dict[str, Any]:
    ...
# update_user method usage example with argument unpacking

kwargs: UpdateUserRequestTypeDef = {  # (1)
    "BrokerId": ...,
    "Username": ...,
}

parent.update_user(**kwargs)
  1. See UpdateUserRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("mq").get_paginator method with overloads.