Struct aws_sdk_mq::Client
source · [−]pub struct Client { /* private fields */ }
Expand description
Client for AmazonMQ
Client for invoking operations on AmazonMQ. Each operation on AmazonMQ is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_mq::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */
Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_mq::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_mq::Client::from_conf(config);
Implementations
sourceimpl Client
impl Client
sourcepub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self
Creates a client with the given service configuration.
sourceimpl Client
impl Client
sourcepub fn create_broker(&self) -> CreateBroker
pub fn create_broker(&self) -> CreateBroker
Constructs a fluent builder for the CreateBroker
operation.
- The fluent builder is configurable:
authentication_strategy(AuthenticationStrategy)
/set_authentication_strategy(Option<AuthenticationStrategy>)
:Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
auto_minor_version_upgrade(bool)
/set_auto_minor_version_upgrade(bool)
:Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot. Set to true by default, if no value is specified.
broker_name(impl Into<String>)
/set_broker_name(Option<String>)
:Required. The broker’s name. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
configuration(ConfigurationId)
/set_configuration(Option<ConfigurationId>)
:A list of information about the configuration.
creator_request_id(impl Into<String>)
/set_creator_request_id(Option<String>)
:The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn’t require idempotency.
deployment_mode(DeploymentMode)
/set_deployment_mode(Option<DeploymentMode>)
:Required. The broker’s deployment mode.
encryption_options(EncryptionOptions)
/set_encryption_options(Option<EncryptionOptions>)
:Encryption options for the broker. Does not apply to RabbitMQ brokers.
engine_type(EngineType)
/set_engine_type(Option<EngineType>)
:Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:Required. The broker engine’s version. For a list of supported engine versions, see Supported engines.
host_instance_type(impl Into<String>)
/set_host_instance_type(Option<String>)
:Required. The broker’s instance type.
ldap_server_metadata(LdapServerMetadataInput)
/set_ldap_server_metadata(Option<LdapServerMetadataInput>)
:Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
logs(Logs)
/set_logs(Option<Logs>)
:Enables Amazon CloudWatch logging for brokers.
maintenance_window_start_time(WeeklyStartTime)
/set_maintenance_window_start_time(Option<WeeklyStartTime>)
:The parameters that determine the WeeklyStartTime.
publicly_accessible(bool)
/set_publicly_accessible(bool)
:Enables connections from applications outside of the VPC that hosts the broker’s subnets. Set to false by default, if no value is provided.
security_groups(Vec<String>)
/set_security_groups(Option<Vec<String>>)
:The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
storage_type(BrokerStorageType)
/set_storage_type(Option<BrokerStorageType>)
:The broker’s storage type.
subnet_ids(Vec<String>)
/set_subnet_ids(Option<Vec<String>>)
:The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones. If you specify more than one subnet, the subnets must be in different Availability Zones. Amazon MQ will not be able to create VPC endpoints for your broker with multiple subnets in the same Availability Zone. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ Amazon MQ for ActiveMQ deployment requires two subnets. A CLUSTER_MULTI_AZ Amazon MQ for RabbitMQ deployment has no subnet requirements when deployed with public accessibility. Deployment without public accessibility requires at least one subnet.
If you specify subnets in a shared VPC for a RabbitMQ broker, the associated VPC to which the specified subnets belong must be owned by your AWS account. Amazon MQ will not be able to create VPC endpoints in VPCs that are not owned by your AWS account.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:Create tags when creating the broker.
users(Vec<User>)
/set_users(Option<Vec<User>>)
:Required. The list of broker users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
Amazon MQ for RabbitMQ When you create an Amazon MQ for RabbitMQ broker, one and only one administrative user is accepted and created when a broker is first provisioned. All subsequent broker users are created by making RabbitMQ API calls directly to brokers or via the RabbitMQ web console.
- On success, responds with
CreateBrokerOutput
with field(s):broker_arn(Option<String>)
:The broker’s Amazon Resource Name (ARN).
broker_id(Option<String>)
:The unique ID that Amazon MQ generates for the broker.
- On failure, responds with
SdkError<CreateBrokerError>
sourcepub fn create_configuration(&self) -> CreateConfiguration
pub fn create_configuration(&self) -> CreateConfiguration
Constructs a fluent builder for the CreateConfiguration
operation.
- The fluent builder is configurable:
authentication_strategy(AuthenticationStrategy)
/set_authentication_strategy(Option<AuthenticationStrategy>)
:Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
engine_type(EngineType)
/set_engine_type(Option<EngineType>)
:Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:Required. The broker engine’s version. For a list of supported engine versions, see Supported engines.
name(impl Into<String>)
/set_name(Option<String>)
:Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:Create tags when creating the configuration.
- On success, responds with
CreateConfigurationOutput
with field(s):arn(Option<String>)
:Required. The Amazon Resource Name (ARN) of the configuration.
authentication_strategy(Option<AuthenticationStrategy>)
:Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
created(Option<DateTime>)
:Required. The date and time of the configuration.
id(Option<String>)
:Required. The unique ID that Amazon MQ generates for the configuration.
latest_revision(Option<ConfigurationRevision>)
:The latest revision of the configuration.
name(Option<String>)
:Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
- On failure, responds with
SdkError<CreateConfigurationError>
Constructs a fluent builder for the CreateTags
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource tag.
tags(HashMap<String, String>)
/set_tags(Option<HashMap<String, String>>)
:The key-value pair for the resource tag.
- On success, responds with
CreateTagsOutput
- On failure, responds with
SdkError<CreateTagsError>
sourcepub fn create_user(&self) -> CreateUser
pub fn create_user(&self) -> CreateUser
Constructs a fluent builder for the CreateUser
operation.
- The fluent builder is configurable:
broker_id(impl Into<String>)
/set_broker_id(Option<String>)
:The unique ID that Amazon MQ generates for the broker.
console_access(bool)
/set_console_access(bool)
:Enables access to the ActiveMQ Web Console for the ActiveMQ user.
groups(Vec<String>)
/set_groups(Option<Vec<String>>)
:The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
password(impl Into<String>)
/set_password(Option<String>)
:Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).
username(impl Into<String>)
/set_username(Option<String>)
:The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
- On success, responds with
CreateUserOutput
- On failure, responds with
SdkError<CreateUserError>
sourcepub fn delete_broker(&self) -> DeleteBroker
pub fn delete_broker(&self) -> DeleteBroker
Constructs a fluent builder for the DeleteBroker
operation.
- The fluent builder is configurable:
broker_id(impl Into<String>)
/set_broker_id(Option<String>)
:The unique ID that Amazon MQ generates for the broker.
- On success, responds with
DeleteBrokerOutput
with field(s):broker_id(Option<String>)
:The unique ID that Amazon MQ generates for the broker.
- On failure, responds with
SdkError<DeleteBrokerError>
Constructs a fluent builder for the DeleteTags
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource tag.
tag_keys(Vec<String>)
/set_tag_keys(Option<Vec<String>>)
:An array of tag keys to delete
- On success, responds with
DeleteTagsOutput
- On failure, responds with
SdkError<DeleteTagsError>
sourcepub fn delete_user(&self) -> DeleteUser
pub fn delete_user(&self) -> DeleteUser
Constructs a fluent builder for the DeleteUser
operation.
- The fluent builder is configurable:
broker_id(impl Into<String>)
/set_broker_id(Option<String>)
:The unique ID that Amazon MQ generates for the broker.
username(impl Into<String>)
/set_username(Option<String>)
:The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
- On success, responds with
DeleteUserOutput
- On failure, responds with
SdkError<DeleteUserError>
sourcepub fn describe_broker(&self) -> DescribeBroker
pub fn describe_broker(&self) -> DescribeBroker
Constructs a fluent builder for the DescribeBroker
operation.
- The fluent builder is configurable:
broker_id(impl Into<String>)
/set_broker_id(Option<String>)
:The unique ID that Amazon MQ generates for the broker.
- On success, responds with
DescribeBrokerOutput
with field(s):authentication_strategy(Option<AuthenticationStrategy>)
:The authentication strategy used to secure the broker. The default is SIMPLE.
auto_minor_version_upgrade(bool)
:Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
broker_arn(Option<String>)
:The broker’s Amazon Resource Name (ARN).
broker_id(Option<String>)
:The unique ID that Amazon MQ generates for the broker.
broker_instances(Option<Vec<BrokerInstance>>)
:A list of information about allocated brokers.
broker_name(Option<String>)
:The broker’s name. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain white spaces, brackets, wildcard characters, or special characters.
broker_state(Option<BrokerState>)
:The broker’s status.
configurations(Option<Configurations>)
:The list of all revisions for the specified configuration.
created(Option<DateTime>)
:The time when the broker was created.
deployment_mode(Option<DeploymentMode>)
:The broker’s deployment mode.
encryption_options(Option<EncryptionOptions>)
:Encryption options for the broker. Does not apply to RabbitMQ brokers.
engine_type(Option<EngineType>)
:The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
engine_version(Option<String>)
:The broker engine’s version. For a list of supported engine versions, see Supported engines.
host_instance_type(Option<String>)
:The broker’s instance type.
ldap_server_metadata(Option<LdapServerMetadataOutput>)
:The metadata of the LDAP server used to authenticate and authorize connections to the broker.
logs(Option<LogsSummary>)
:The list of information about logs currently enabled and pending to be deployed for the specified broker.
maintenance_window_start_time(Option<WeeklyStartTime>)
:The parameters that determine the WeeklyStartTime.
pending_authentication_strategy(Option<AuthenticationStrategy>)
:The authentication strategy that will be applied when the broker is rebooted. The default is SIMPLE.
pending_engine_version(Option<String>)
:The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.
pending_host_instance_type(Option<String>)
:The broker’s host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
pending_ldap_server_metadata(Option<LdapServerMetadataOutput>)
:The metadata of the LDAP server that will be used to authenticate and authorize connections to the broker after it is rebooted.
pending_security_groups(Option<Vec<String>>)
:The list of pending security groups to authorize connections to brokers.
publicly_accessible(bool)
:Enables connections from applications outside of the VPC that hosts the broker’s subnets.
security_groups(Option<Vec<String>>)
:The list of rules (1 minimum, 125 maximum) that authorize connections to brokers.
storage_type(Option<BrokerStorageType>)
:The broker’s storage type.
subnet_ids(Option<Vec<String>>)
:The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
tags(Option<HashMap<String, String>>)
:The list of all tags associated with this broker.
users(Option<Vec<UserSummary>>)
:The list of all broker usernames for the specified broker.
- On failure, responds with
SdkError<DescribeBrokerError>
sourcepub fn describe_broker_engine_types(&self) -> DescribeBrokerEngineTypes
pub fn describe_broker_engine_types(&self) -> DescribeBrokerEngineTypes
Constructs a fluent builder for the DescribeBrokerEngineTypes
operation.
- The fluent builder is configurable:
engine_type(impl Into<String>)
/set_engine_type(Option<String>)
:Filter response by engine type.
max_results(i32)
/set_max_results(i32)
:The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
- On success, responds with
DescribeBrokerEngineTypesOutput
with field(s):broker_engine_types(Option<Vec<BrokerEngineType>>)
:List of available engine types and versions.
max_results(i32)
:Required. The maximum number of engine types that can be returned per page (20 by default). This value must be an integer from 5 to 100.
next_token(Option<String>)
:The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
- On failure, responds with
SdkError<DescribeBrokerEngineTypesError>
sourcepub fn describe_broker_instance_options(&self) -> DescribeBrokerInstanceOptions
pub fn describe_broker_instance_options(&self) -> DescribeBrokerInstanceOptions
Constructs a fluent builder for the DescribeBrokerInstanceOptions
operation.
- The fluent builder is configurable:
engine_type(impl Into<String>)
/set_engine_type(Option<String>)
:Filter response by engine type.
host_instance_type(impl Into<String>)
/set_host_instance_type(Option<String>)
:Filter response by host instance type.
max_results(i32)
/set_max_results(i32)
:The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
storage_type(impl Into<String>)
/set_storage_type(Option<String>)
:Filter response by storage type.
- On success, responds with
DescribeBrokerInstanceOptionsOutput
with field(s):broker_instance_options(Option<Vec<BrokerInstanceOption>>)
:List of available broker instance options.
max_results(i32)
:Required. The maximum number of instance options that can be returned per page (20 by default). This value must be an integer from 5 to 100.
next_token(Option<String>)
:The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
- On failure, responds with
SdkError<DescribeBrokerInstanceOptionsError>
sourcepub fn describe_configuration(&self) -> DescribeConfiguration
pub fn describe_configuration(&self) -> DescribeConfiguration
Constructs a fluent builder for the DescribeConfiguration
operation.
- The fluent builder is configurable:
configuration_id(impl Into<String>)
/set_configuration_id(Option<String>)
:The unique ID that Amazon MQ generates for the configuration.
- On success, responds with
DescribeConfigurationOutput
with field(s):arn(Option<String>)
:Required. The ARN of the configuration.
authentication_strategy(Option<AuthenticationStrategy>)
:Optional. The authentication strategy associated with the configuration. The default is SIMPLE.
created(Option<DateTime>)
:Required. The date and time of the configuration revision.
description(Option<String>)
:Required. The description of the configuration.
engine_type(Option<EngineType>)
:Required. The type of broker engine. Currently, Amazon MQ supports ACTIVEMQ and RABBITMQ.
engine_version(Option<String>)
:Required. The broker engine’s version. For a list of supported engine versions, see, Supported engines.
id(Option<String>)
:Required. The unique ID that Amazon MQ generates for the configuration.
latest_revision(Option<ConfigurationRevision>)
:Required. The latest revision of the configuration.
name(Option<String>)
:Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
tags(Option<HashMap<String, String>>)
:The list of all tags associated with this configuration.
- On failure, responds with
SdkError<DescribeConfigurationError>
sourcepub fn describe_configuration_revision(&self) -> DescribeConfigurationRevision
pub fn describe_configuration_revision(&self) -> DescribeConfigurationRevision
Constructs a fluent builder for the DescribeConfigurationRevision
operation.
- The fluent builder is configurable:
configuration_id(impl Into<String>)
/set_configuration_id(Option<String>)
:The unique ID that Amazon MQ generates for the configuration.
configuration_revision(impl Into<String>)
/set_configuration_revision(Option<String>)
:The revision of the configuration.
- On success, responds with
DescribeConfigurationRevisionOutput
with field(s):configuration_id(Option<String>)
:Required. The unique ID that Amazon MQ generates for the configuration.
created(Option<DateTime>)
:Required. The date and time of the configuration.
data(Option<String>)
:Required. The base64-encoded XML configuration.
description(Option<String>)
:The description of the configuration.
- On failure, responds with
SdkError<DescribeConfigurationRevisionError>
sourcepub fn describe_user(&self) -> DescribeUser
pub fn describe_user(&self) -> DescribeUser
Constructs a fluent builder for the DescribeUser
operation.
- The fluent builder is configurable:
broker_id(impl Into<String>)
/set_broker_id(Option<String>)
:The unique ID that Amazon MQ generates for the broker.
username(impl Into<String>)
/set_username(Option<String>)
:The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
- On success, responds with
DescribeUserOutput
with field(s):broker_id(Option<String>)
:Required. The unique ID that Amazon MQ generates for the broker.
console_access(bool)
:Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
groups(Option<Vec<String>>)
:The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
pending(Option<UserPendingChanges>)
:The status of the changes pending for the ActiveMQ user.
username(Option<String>)
:Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
- On failure, responds with
SdkError<DescribeUserError>
sourcepub fn list_brokers(&self) -> ListBrokers
pub fn list_brokers(&self) -> ListBrokers
Constructs a fluent builder for the ListBrokers
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(i32)
:The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
- On success, responds with
ListBrokersOutput
with field(s):broker_summaries(Option<Vec<BrokerSummary>>)
:A list of information about all brokers.
next_token(Option<String>)
:The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
- On failure, responds with
SdkError<ListBrokersError>
sourcepub fn list_configuration_revisions(&self) -> ListConfigurationRevisions
pub fn list_configuration_revisions(&self) -> ListConfigurationRevisions
Constructs a fluent builder for the ListConfigurationRevisions
operation.
- The fluent builder is configurable:
configuration_id(impl Into<String>)
/set_configuration_id(Option<String>)
:The unique ID that Amazon MQ generates for the configuration.
max_results(i32)
/set_max_results(i32)
:The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
- On success, responds with
ListConfigurationRevisionsOutput
with field(s):configuration_id(Option<String>)
:The unique ID that Amazon MQ generates for the configuration.
max_results(i32)
:The maximum number of configuration revisions that can be returned per page (20 by default). This value must be an integer from 5 to 100.
next_token(Option<String>)
:The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
revisions(Option<Vec<ConfigurationRevision>>)
:The list of all revisions for the specified configuration.
- On failure, responds with
SdkError<ListConfigurationRevisionsError>
sourcepub fn list_configurations(&self) -> ListConfigurations
pub fn list_configurations(&self) -> ListConfigurations
Constructs a fluent builder for the ListConfigurations
operation.
- The fluent builder is configurable:
max_results(i32)
/set_max_results(i32)
:The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
- On success, responds with
ListConfigurationsOutput
with field(s):configurations(Option<Vec<Configuration>>)
:The list of all revisions for the specified configuration.
max_results(i32)
:The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
next_token(Option<String>)
:The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
- On failure, responds with
SdkError<ListConfigurationsError>
Constructs a fluent builder for the ListTags
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:The Amazon Resource Name (ARN) of the resource tag.
- On success, responds with
ListTagsOutput
with field(s):tags(Option<HashMap<String, String>>)
:The key-value pair for the resource tag.
- On failure, responds with
SdkError<ListTagsError>
sourcepub fn list_users(&self) -> ListUsers
pub fn list_users(&self) -> ListUsers
Constructs a fluent builder for the ListUsers
operation.
- The fluent builder is configurable:
broker_id(impl Into<String>)
/set_broker_id(Option<String>)
:The unique ID that Amazon MQ generates for the broker.
max_results(i32)
/set_max_results(i32)
:The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
- On success, responds with
ListUsersOutput
with field(s):broker_id(Option<String>)
:Required. The unique ID that Amazon MQ generates for the broker.
max_results(i32)
:Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100.
next_token(Option<String>)
:The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty.
users(Option<Vec<UserSummary>>)
:Required. The list of all ActiveMQ usernames for the specified broker. Does not apply to RabbitMQ brokers.
- On failure, responds with
SdkError<ListUsersError>
sourcepub fn reboot_broker(&self) -> RebootBroker
pub fn reboot_broker(&self) -> RebootBroker
Constructs a fluent builder for the RebootBroker
operation.
- The fluent builder is configurable:
broker_id(impl Into<String>)
/set_broker_id(Option<String>)
:The unique ID that Amazon MQ generates for the broker.
- On success, responds with
RebootBrokerOutput
- On failure, responds with
SdkError<RebootBrokerError>
sourcepub fn update_broker(&self) -> UpdateBroker
pub fn update_broker(&self) -> UpdateBroker
Constructs a fluent builder for the UpdateBroker
operation.
- The fluent builder is configurable:
authentication_strategy(AuthenticationStrategy)
/set_authentication_strategy(Option<AuthenticationStrategy>)
:Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
auto_minor_version_upgrade(bool)
/set_auto_minor_version_upgrade(bool)
:Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
broker_id(impl Into<String>)
/set_broker_id(Option<String>)
:The unique ID that Amazon MQ generates for the broker.
configuration(ConfigurationId)
/set_configuration(Option<ConfigurationId>)
:A list of information about the configuration.
engine_version(impl Into<String>)
/set_engine_version(Option<String>)
:The broker engine version. For a list of supported engine versions, see Supported engines.
host_instance_type(impl Into<String>)
/set_host_instance_type(Option<String>)
:The broker’s host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
ldap_server_metadata(LdapServerMetadataInput)
/set_ldap_server_metadata(Option<LdapServerMetadataInput>)
:Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
logs(Logs)
/set_logs(Option<Logs>)
:Enables Amazon CloudWatch logging for brokers.
maintenance_window_start_time(WeeklyStartTime)
/set_maintenance_window_start_time(Option<WeeklyStartTime>)
:The parameters that determine the WeeklyStartTime.
security_groups(Vec<String>)
/set_security_groups(Option<Vec<String>>)
:The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
- On success, responds with
UpdateBrokerOutput
with field(s):authentication_strategy(Option<AuthenticationStrategy>)
:Optional. The authentication strategy used to secure the broker. The default is SIMPLE.
auto_minor_version_upgrade(bool)
:The new boolean value that specifies whether broker engines automatically upgrade to new minor versions as new versions are released and supported by Amazon MQ.
broker_id(Option<String>)
:Required. The unique ID that Amazon MQ generates for the broker.
configuration(Option<ConfigurationId>)
:The ID of the updated configuration.
engine_version(Option<String>)
:The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.
host_instance_type(Option<String>)
:The broker’s host instance type to upgrade to. For a list of supported instance types, see Broker instance types.
ldap_server_metadata(Option<LdapServerMetadataOutput>)
:Optional. The metadata of the LDAP server used to authenticate and authorize connections to the broker. Does not apply to RabbitMQ brokers.
logs(Option<Logs>)
:The list of information about logs to be enabled for the specified broker.
maintenance_window_start_time(Option<WeeklyStartTime>)
:The parameters that determine the WeeklyStartTime.
security_groups(Option<Vec<String>>)
:The list of security groups (1 minimum, 5 maximum) that authorizes connections to brokers.
- On failure, responds with
SdkError<UpdateBrokerError>
sourcepub fn update_configuration(&self) -> UpdateConfiguration
pub fn update_configuration(&self) -> UpdateConfiguration
Constructs a fluent builder for the UpdateConfiguration
operation.
- The fluent builder is configurable:
configuration_id(impl Into<String>)
/set_configuration_id(Option<String>)
:The unique ID that Amazon MQ generates for the configuration.
data(impl Into<String>)
/set_data(Option<String>)
:Required. The base64-encoded XML configuration.
description(impl Into<String>)
/set_description(Option<String>)
:The description of the configuration.
- On success, responds with
UpdateConfigurationOutput
with field(s):arn(Option<String>)
:Required. The Amazon Resource Name (ARN) of the configuration.
created(Option<DateTime>)
:Required. The date and time of the configuration.
id(Option<String>)
:Required. The unique ID that Amazon MQ generates for the configuration.
latest_revision(Option<ConfigurationRevision>)
:The latest revision of the configuration.
name(Option<String>)
:Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long.
warnings(Option<Vec<SanitizationWarning>>)
:The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized.
- On failure, responds with
SdkError<UpdateConfigurationError>
sourcepub fn update_user(&self) -> UpdateUser
pub fn update_user(&self) -> UpdateUser
Constructs a fluent builder for the UpdateUser
operation.
- The fluent builder is configurable:
broker_id(impl Into<String>)
/set_broker_id(Option<String>)
:The unique ID that Amazon MQ generates for the broker.
console_access(bool)
/set_console_access(bool)
:Enables access to the the ActiveMQ Web Console for the ActiveMQ user.
groups(Vec<String>)
/set_groups(Option<Vec<String>>)
:The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
password(impl Into<String>)
/set_password(Option<String>)
:The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas, colons, or equal signs (,:=).
username(impl Into<String>)
/set_username(Option<String>)
:The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long.
- On success, responds with
UpdateUserOutput
- On failure, responds with
SdkError<UpdateUserError>
sourceimpl Client
impl Client
sourcepub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
pub fn from_conf_conn<C, E>(conf: Config, conn: C) -> Self where
C: SmithyConnector<Error = E> + Send + 'static,
E: Into<ConnectorError>,
Creates a client with the given service config and connector override.
Trait Implementations
sourceimpl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
impl From<Client<DynConnector, DynMiddleware<DynConnector>, Standard>> for Client
sourcefn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
fn from(client: Client<DynConnector, DynMiddleware<DynConnector>>) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more