MQClient

Index > MQ > MQClient

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

MQClient

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

MQClient usage example

from aiobotocore.session import get_session
from types_aiobotocore_mq.client import MQClient

session = get_session()
async with session.create_client("mq") as client:
    client: MQClient

Exceptions

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

MQClient.exceptions usage example

async with session.create_client("mq") as client:
    try:
        do_something(client)
    except (
            client.BadRequestException,
        client.ClientError,
        client.ConflictException,
        client.ForbiddenException,
        client.InternalServerErrorException,
        client.NotFoundException,
        client.UnauthorizedException,
    ) as e:
        print(e)

MQClient usage type checking example

from types_aiobotocore_mq.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

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

# can_paginate method definition

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

close

Closes underlying endpoint connections.

Type annotations and code completion for session.create_client("mq").close method. boto3 documentation

# close method definition

await def close(
    self,
) -> None:
    ...

create_broker

Creates a broker.

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

# create_broker method definition

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

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
12. See CreateBrokerResponseTypeDef

# create_broker method usage example with argument unpacking

kwargs: CreateBrokerRequestRequestTypeDef = {  # (1)
    "AutoMinorVersionUpgrade": ...,
    "BrokerName": ...,
    "DeploymentMode": ...,
    "EngineType": ...,
    "EngineVersion": ...,
    "HostInstanceType": ...,
    "PubliclyAccessible": ...,
    "Users": ...,
}

parent.create_broker(**kwargs)

1. See CreateBrokerRequestRequestTypeDef

create_configuration

Creates a new configuration for the specified configuration name.

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

# create_configuration method definition

await def create_configuration(
    self,
    *,
    EngineType: EngineTypeType,  # (1)
    EngineVersion: str,
    Name: str,
    AuthenticationStrategy: AuthenticationStrategyType = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> CreateConfigurationResponseTypeDef:  # (3)
    ...

1. See EngineTypeType
2. See AuthenticationStrategyType
3. See CreateConfigurationResponseTypeDef

# create_configuration method usage example with argument unpacking

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

parent.create_configuration(**kwargs)

1. See CreateConfigurationRequestRequestTypeDef

create_tags

Add a tag to a resource.

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

# create_tags method definition

await def create_tags(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str] = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# create_tags method usage example with argument unpacking

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

parent.create_tags(**kwargs)

1. See CreateTagsRequestRequestTypeDef

create_user

Creates an ActiveMQ user.

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

# create_user method definition

await 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: CreateUserRequestRequestTypeDef = {  # (1)
    "BrokerId": ...,
    "Password": ...,
    "Username": ...,
}

parent.create_user(**kwargs)

1. See CreateUserRequestRequestTypeDef

delete_broker

Deletes a broker.

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

# delete_broker method definition

await def delete_broker(
    self,
    *,
    BrokerId: str,
) -> DeleteBrokerResponseTypeDef:  # (1)
    ...

1. See DeleteBrokerResponseTypeDef

# delete_broker method usage example with argument unpacking

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

parent.delete_broker(**kwargs)

1. See DeleteBrokerRequestRequestTypeDef

delete_tags

Removes a tag from a resource.

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

# delete_tags method definition

await def delete_tags(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_tags method usage example with argument unpacking

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

parent.delete_tags(**kwargs)

1. See DeleteTagsRequestRequestTypeDef

delete_user

Deletes an ActiveMQ user.

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

# delete_user method definition

await def delete_user(
    self,
    *,
    BrokerId: str,
    Username: str,
) -> Dict[str, Any]:
    ...

# delete_user method usage example with argument unpacking

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

parent.delete_user(**kwargs)

1. See DeleteUserRequestRequestTypeDef

describe_broker

Returns information about the specified broker.

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

# describe_broker method definition

await def describe_broker(
    self,
    *,
    BrokerId: str,
) -> DescribeBrokerResponseTypeDef:  # (1)
    ...

1. See DescribeBrokerResponseTypeDef

# describe_broker method usage example with argument unpacking

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

parent.describe_broker(**kwargs)

1. See DescribeBrokerRequestRequestTypeDef

describe_broker_engine_types

Describe available engine types and versions.

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

# describe_broker_engine_types method definition

await 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: DescribeBrokerEngineTypesRequestRequestTypeDef = {  # (1)
    "EngineType": ...,
}

parent.describe_broker_engine_types(**kwargs)

1. See DescribeBrokerEngineTypesRequestRequestTypeDef

describe_broker_instance_options

Describe available broker instance options.

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

# describe_broker_instance_options method definition

await 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: DescribeBrokerInstanceOptionsRequestRequestTypeDef = {  # (1)
    "EngineType": ...,
}

parent.describe_broker_instance_options(**kwargs)

1. See DescribeBrokerInstanceOptionsRequestRequestTypeDef

describe_configuration

Returns information about the specified configuration.

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

# describe_configuration method definition

await def describe_configuration(
    self,
    *,
    ConfigurationId: str,
) -> DescribeConfigurationResponseTypeDef:  # (1)
    ...

1. See DescribeConfigurationResponseTypeDef

# describe_configuration method usage example with argument unpacking

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

parent.describe_configuration(**kwargs)

1. See DescribeConfigurationRequestRequestTypeDef

describe_configuration_revision

Returns the specified configuration revision for the specified configuration.

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

# describe_configuration_revision method definition

await def describe_configuration_revision(
    self,
    *,
    ConfigurationId: str,
    ConfigurationRevision: str,
) -> DescribeConfigurationRevisionResponseTypeDef:  # (1)
    ...

1. See DescribeConfigurationRevisionResponseTypeDef

# describe_configuration_revision method usage example with argument unpacking

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

parent.describe_configuration_revision(**kwargs)

1. See DescribeConfigurationRevisionRequestRequestTypeDef

describe_user

Returns information about an ActiveMQ user.

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

# describe_user method definition

await def describe_user(
    self,
    *,
    BrokerId: str,
    Username: str,
) -> DescribeUserResponseTypeDef:  # (1)
    ...

1. See DescribeUserResponseTypeDef

# describe_user method usage example with argument unpacking

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

parent.describe_user(**kwargs)

1. See DescribeUserRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

# generate_presigned_url method definition

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

list_brokers

Returns a list of all brokers.

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

# list_brokers method definition

await def list_brokers(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListBrokersResponseTypeDef:  # (1)
    ...

1. See ListBrokersResponseTypeDef

# list_brokers method usage example with argument unpacking

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

parent.list_brokers(**kwargs)

1. See ListBrokersRequestRequestTypeDef

list_configuration_revisions

Returns a list of all revisions for the specified configuration.

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

# list_configuration_revisions method definition

await 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: ListConfigurationRevisionsRequestRequestTypeDef = {  # (1)
    "ConfigurationId": ...,
}

parent.list_configuration_revisions(**kwargs)

1. See ListConfigurationRevisionsRequestRequestTypeDef

list_configurations

Returns a list of all configurations.

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

# list_configurations method definition

await def list_configurations(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListConfigurationsResponseTypeDef:  # (1)
    ...

1. See ListConfigurationsResponseTypeDef

# list_configurations method usage example with argument unpacking

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

parent.list_configurations(**kwargs)

1. See ListConfigurationsRequestRequestTypeDef

list_tags

Lists tags for a resource.

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

# list_tags method definition

await def list_tags(
    self,
    *,
    ResourceArn: str,
) -> ListTagsResponseTypeDef:  # (1)
    ...

1. See ListTagsResponseTypeDef

# list_tags method usage example with argument unpacking

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

parent.list_tags(**kwargs)

1. See ListTagsRequestRequestTypeDef

list_users

Returns a list of all ActiveMQ users.

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

# list_users method definition

await def list_users(
    self,
    *,
    BrokerId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListUsersResponseTypeDef:  # (1)
    ...

1. See ListUsersResponseTypeDef

# list_users method usage example with argument unpacking

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

parent.list_users(**kwargs)

1. See ListUsersRequestRequestTypeDef

promote

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

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

# promote method definition

await def promote(
    self,
    *,
    BrokerId: str,
    Mode: PromoteModeType,  # (1)
) -> PromoteResponseTypeDef:  # (2)
    ...

1. See PromoteModeType
2. See PromoteResponseTypeDef

# promote method usage example with argument unpacking

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

parent.promote(**kwargs)

1. See PromoteRequestRequestTypeDef

reboot_broker

Reboots a broker.

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

# reboot_broker method definition

await def reboot_broker(
    self,
    *,
    BrokerId: str,
) -> Dict[str, Any]:
    ...

# reboot_broker method usage example with argument unpacking

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

parent.reboot_broker(**kwargs)

1. See RebootBrokerRequestRequestTypeDef

update_broker

Adds a pending configuration change to a broker.

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

# update_broker method definition

await 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: UpdateBrokerRequestRequestTypeDef = {  # (1)
    "BrokerId": ...,
}

parent.update_broker(**kwargs)

1. See UpdateBrokerRequestRequestTypeDef

update_configuration

Updates the specified configuration.

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

# update_configuration method definition

await def update_configuration(
    self,
    *,
    ConfigurationId: str,
    Data: str,
    Description: str = ...,
) -> UpdateConfigurationResponseTypeDef:  # (1)
    ...

1. See UpdateConfigurationResponseTypeDef

# update_configuration method usage example with argument unpacking

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

parent.update_configuration(**kwargs)

1. See UpdateConfigurationRequestRequestTypeDef

update_user

Updates the information for an ActiveMQ user.

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

# update_user method definition

await 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: UpdateUserRequestRequestTypeDef = {  # (1)
    "BrokerId": ...,
    "Username": ...,
}

parent.update_user(**kwargs)

1. See UpdateUserRequestRequestTypeDef

__aenter__

Type annotations and code completion for session.create_client("mq").__aenter__ method. boto3 documentation

# __aenter__ method definition

await def __aenter__(
    self,
) -> MQClient:
    ...

__aexit__

Type annotations and code completion for session.create_client("mq").__aexit__ method. boto3 documentation

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

Type annotations and code completion for session.create_client("mq").get_paginator method with overloads.

• client.get_paginator("list_brokers") -> ListBrokersPaginator