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
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.
client = boto3.client("mq")
try:
do_something(client)
except (
client.BadRequestException,
client.ClientError,
client.ConflictException,
client.ForbiddenException,
client.InternalServerErrorException,
client.NotFoundException,
client.UnauthorizedException,
) as e:
print(e)
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("mq").close
method.
boto3 documentation
create_broker
Creates a broker.
Type annotations and code completion for boto3.client("mq").create_broker
method.
boto3 documentation
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] = ...,
) -> CreateBrokerResponseTypeDef: # (11)
...
- See DeploymentModeType
- See EngineTypeType
- See UserTypeDef
- See AuthenticationStrategyType
- See ConfigurationIdTypeDef
- See EncryptionOptionsTypeDef
- See LdapServerMetadataInputTypeDef
- See LogsTypeDef
- See WeeklyStartTimeTypeDef
- See BrokerStorageTypeType
- See CreateBrokerResponseTypeDef
kwargs: CreateBrokerRequestRequestTypeDef = { # (1)
"AutoMinorVersionUpgrade": ...,
"BrokerName": ...,
"DeploymentMode": ...,
"EngineType": ...,
"EngineVersion": ...,
"HostInstanceType": ...,
"PubliclyAccessible": ...,
"Users": ...,
}
parent.create_broker(**kwargs)
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
def create_configuration(
self,
*,
EngineType: EngineTypeType, # (1)
EngineVersion: str,
Name: str,
AuthenticationStrategy: AuthenticationStrategyType = ..., # (2)
Tags: Mapping[str, str] = ...,
) -> CreateConfigurationResponseTypeDef: # (3)
...
kwargs: CreateConfigurationRequestRequestTypeDef = { # (1)
"EngineType": ...,
"EngineVersion": ...,
"Name": ...,
}
parent.create_configuration(**kwargs)
create_tags
Add a tag to a resource.
Type annotations and code completion for boto3.client("mq").create_tags
method.
boto3 documentation
def create_tags(
self,
*,
ResourceArn: str,
Tags: Mapping[str, str] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: CreateTagsRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.create_tags(**kwargs)
create_user
Creates an ActiveMQ user.
Type annotations and code completion for boto3.client("mq").create_user
method.
boto3 documentation
def create_user(
self,
*,
BrokerId: str,
Password: str,
Username: str,
ConsoleAccess: bool = ...,
Groups: Sequence[str] = ...,
) -> Dict[str, Any]:
...
kwargs: CreateUserRequestRequestTypeDef = { # (1)
"BrokerId": ...,
"Password": ...,
"Username": ...,
}
parent.create_user(**kwargs)
delete_broker
Deletes a broker.
Type annotations and code completion for boto3.client("mq").delete_broker
method.
boto3 documentation
def delete_broker(
self,
*,
BrokerId: str,
) -> DeleteBrokerResponseTypeDef: # (1)
...
kwargs: DeleteBrokerRequestRequestTypeDef = { # (1)
"BrokerId": ...,
}
parent.delete_broker(**kwargs)
delete_tags
Removes a tag from a resource.
Type annotations and code completion for boto3.client("mq").delete_tags
method.
boto3 documentation
def delete_tags(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteTagsRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.delete_tags(**kwargs)
delete_user
Deletes an ActiveMQ user.
Type annotations and code completion for boto3.client("mq").delete_user
method.
boto3 documentation
kwargs: DeleteUserRequestRequestTypeDef = { # (1)
"BrokerId": ...,
"Username": ...,
}
parent.delete_user(**kwargs)
describe_broker
Returns information about the specified broker.
Type annotations and code completion for boto3.client("mq").describe_broker
method.
boto3 documentation
def describe_broker(
self,
*,
BrokerId: str,
) -> DescribeBrokerResponseTypeDef: # (1)
...
kwargs: DescribeBrokerRequestRequestTypeDef = { # (1)
"BrokerId": ...,
}
parent.describe_broker(**kwargs)
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
def describe_broker_engine_types(
self,
*,
EngineType: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeBrokerEngineTypesResponseTypeDef: # (1)
...
kwargs: DescribeBrokerEngineTypesRequestRequestTypeDef = { # (1)
"EngineType": ...,
}
parent.describe_broker_engine_types(**kwargs)
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
def describe_broker_instance_options(
self,
*,
EngineType: str = ...,
HostInstanceType: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
StorageType: str = ...,
) -> DescribeBrokerInstanceOptionsResponseTypeDef: # (1)
...
kwargs: DescribeBrokerInstanceOptionsRequestRequestTypeDef = { # (1)
"EngineType": ...,
}
parent.describe_broker_instance_options(**kwargs)
describe_configuration
Returns information about the specified configuration.
Type annotations and code completion for boto3.client("mq").describe_configuration
method.
boto3 documentation
def describe_configuration(
self,
*,
ConfigurationId: str,
) -> DescribeConfigurationResponseTypeDef: # (1)
...
kwargs: DescribeConfigurationRequestRequestTypeDef = { # (1)
"ConfigurationId": ...,
}
parent.describe_configuration(**kwargs)
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
def describe_configuration_revision(
self,
*,
ConfigurationId: str,
ConfigurationRevision: str,
) -> DescribeConfigurationRevisionResponseTypeDef: # (1)
...
kwargs: DescribeConfigurationRevisionRequestRequestTypeDef = { # (1)
"ConfigurationId": ...,
"ConfigurationRevision": ...,
}
parent.describe_configuration_revision(**kwargs)
describe_user
Returns information about an ActiveMQ user.
Type annotations and code completion for boto3.client("mq").describe_user
method.
boto3 documentation
def describe_user(
self,
*,
BrokerId: str,
Username: str,
) -> DescribeUserResponseTypeDef: # (1)
...
kwargs: DescribeUserRequestRequestTypeDef = { # (1)
"BrokerId": ...,
"Username": ...,
}
parent.describe_user(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("mq").generate_presigned_url
method.
boto3 documentation
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 boto3.client("mq").list_brokers
method.
boto3 documentation
def list_brokers(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListBrokersResponseTypeDef: # (1)
...
kwargs: ListBrokersRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_brokers(**kwargs)
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
def list_configuration_revisions(
self,
*,
ConfigurationId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListConfigurationRevisionsResponseTypeDef: # (1)
...
kwargs: ListConfigurationRevisionsRequestRequestTypeDef = { # (1)
"ConfigurationId": ...,
}
parent.list_configuration_revisions(**kwargs)
list_configurations
Returns a list of all configurations.
Type annotations and code completion for boto3.client("mq").list_configurations
method.
boto3 documentation
def list_configurations(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListConfigurationsResponseTypeDef: # (1)
...
kwargs: ListConfigurationsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_configurations(**kwargs)
list_tags
Lists tags for a resource.
Type annotations and code completion for boto3.client("mq").list_tags
method.
boto3 documentation
kwargs: ListTagsRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags(**kwargs)
list_users
Returns a list of all ActiveMQ users.
Type annotations and code completion for boto3.client("mq").list_users
method.
boto3 documentation
def list_users(
self,
*,
BrokerId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListUsersResponseTypeDef: # (1)
...
kwargs: ListUsersRequestRequestTypeDef = { # (1)
"BrokerId": ...,
}
parent.list_users(**kwargs)
reboot_broker
Reboots a broker.
Type annotations and code completion for boto3.client("mq").reboot_broker
method.
boto3 documentation
kwargs: RebootBrokerRequestRequestTypeDef = { # (1)
"BrokerId": ...,
}
parent.reboot_broker(**kwargs)
update_broker
Adds a pending configuration change to a broker.
Type annotations and code completion for boto3.client("mq").update_broker
method.
boto3 documentation
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] = ...,
) -> UpdateBrokerResponseTypeDef: # (6)
...
- See AuthenticationStrategyType
- See ConfigurationIdTypeDef
- See LdapServerMetadataInputTypeDef
- See LogsTypeDef
- See WeeklyStartTimeTypeDef
- See UpdateBrokerResponseTypeDef
kwargs: UpdateBrokerRequestRequestTypeDef = { # (1)
"BrokerId": ...,
}
parent.update_broker(**kwargs)
update_configuration
Updates the specified configuration.
Type annotations and code completion for boto3.client("mq").update_configuration
method.
boto3 documentation
def update_configuration(
self,
*,
ConfigurationId: str,
Data: str,
Description: str = ...,
) -> UpdateConfigurationResponseTypeDef: # (1)
...
kwargs: UpdateConfigurationRequestRequestTypeDef = { # (1)
"ConfigurationId": ...,
"Data": ...,
}
parent.update_configuration(**kwargs)
update_user
Updates the information for an ActiveMQ user.
Type annotations and code completion for boto3.client("mq").update_user
method.
boto3 documentation
def update_user(
self,
*,
BrokerId: str,
Username: str,
ConsoleAccess: bool = ...,
Groups: Sequence[str] = ...,
Password: str = ...,
) -> Dict[str, Any]:
...
kwargs: UpdateUserRequestRequestTypeDef = { # (1)
"BrokerId": ...,
"Username": ...,
}
parent.update_user(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("mq").get_paginator
method with overloads.
client.get_paginator("list_brokers")
-> ListBrokersPaginator