MQClient

Index > MQ > MQClient

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

MQClient

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

# MQClient usage example

from boto3.session import Session
from mypy_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 mypy_boto3_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 boto3.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 boto3.client("mq").close method. boto3 documentation

# close method definition

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

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,
    Users: Sequence[UserTypeDef],  # (3)
    AuthenticationStrategy: AuthenticationStrategyType = ...,  # (4)
    AutoMinorVersionUpgrade: bool = ...,
    Configuration: ConfigurationIdTypeDef = ...,  # (5)
    CreatorRequestId: str = ...,
    EncryptionOptions: EncryptionOptionsTypeDef = ...,  # (6)
    EngineVersion: str = ...,
    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)
    "BrokerName": ...,
    "DeploymentMode": ...,
    "EngineType": ...,
    "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 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: CreateConfigurationRequestRequestTypeDef = {  # (1)
    "EngineType": ...,
    "Name": ...,
}

parent.create_configuration(**kwargs)

1. See CreateConfigurationRequestRequestTypeDef

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: CreateTagsRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.create_tags(**kwargs)

1. See CreateTagsRequestRequestTypeDef

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

parent.create_user(**kwargs)

1. See CreateUserRequestRequestTypeDef

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

parent.delete_broker(**kwargs)

1. See DeleteBrokerRequestRequestTypeDef

delete_tags

Removes a tag from a resource.

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