The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Paws-0.39
River stage two • 9 direct dependents • 11 total dependents
57 ++
/ Paws::MQ

NAME

Paws::MQ - Perl Interface to AWS AmazonMQ

SYNOPSIS

  use Paws;

  my $obj = Paws->service('MQ');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

Amazon MQ is a managed message broker service for Apache ActiveMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.

For the AWS API documentation, see https://docs.aws.amazon.com/amazon-mq/

METHODS

CreateBroker

[AutoMinorVersionUpgrade => Bool]
[BrokerName => Str]
[Configuration => Paws::MQ::ConfigurationId]
[CreatorRequestId => Str]
[DeploymentMode => Str]
[EngineType => Str]
[EngineVersion => Str]
[HostInstanceType => Str]
[Logs => Paws::MQ::Logs]
[MaintenanceWindowStartTime => Paws::MQ::WeeklyStartTime]
[PubliclyAccessible => Bool]
[SecurityGroups => ArrayRef[Str|Undef]]
[SubnetIds => ArrayRef[Str|Undef]]
[Tags => Paws::MQ::__mapOf__string]
[Users => ArrayRef[Paws::MQ::User]]

Each argument is described in detail in: Paws::MQ::CreateBroker

Returns: a Paws::MQ::CreateBrokerResponse instance

Creates a broker. Note: This API is asynchronous.

CreateConfiguration

[EngineType => Str]
[EngineVersion => Str]
[Name => Str]
[Tags => Paws::MQ::__mapOf__string]

Each argument is described in detail in: Paws::MQ::CreateConfiguration

Returns: a Paws::MQ::CreateConfigurationResponse instance

Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version).

CreateTags

ResourceArn => Str
[Tags => Paws::MQ::__mapOf__string]

Each argument is described in detail in: Paws::MQ::CreateTags

Returns: nothing

Add a tag to a resource.

CreateUser

BrokerId => Str
Username => Str
[ConsoleAccess => Bool]
[Groups => ArrayRef[Str|Undef]]
[Password => Str]

Each argument is described in detail in: Paws::MQ::CreateUser

Returns: a Paws::MQ::CreateUserResponse instance

Creates an ActiveMQ user.

DeleteBroker

BrokerId => Str

Each argument is described in detail in: Paws::MQ::DeleteBroker

Returns: a Paws::MQ::DeleteBrokerResponse instance

Deletes a broker. Note: This API is asynchronous.

DeleteTags

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::MQ::DeleteTags

Returns: nothing

Remove a tag from a resource.

DeleteUser

BrokerId => Str
Username => Str

Each argument is described in detail in: Paws::MQ::DeleteUser

Returns: a Paws::MQ::DeleteUserResponse instance

Deletes an ActiveMQ user.

DescribeBroker

BrokerId => Str

Each argument is described in detail in: Paws::MQ::DescribeBroker

Returns: a Paws::MQ::DescribeBrokerResponse instance

Returns information about the specified broker.

DescribeConfiguration

ConfigurationId => Str

Each argument is described in detail in: Paws::MQ::DescribeConfiguration

Returns: a Paws::MQ::DescribeConfigurationResponse instance

Returns information about the specified configuration.

DescribeConfigurationRevision

ConfigurationId => Str
ConfigurationRevision => Str

Each argument is described in detail in: Paws::MQ::DescribeConfigurationRevision

Returns: a Paws::MQ::DescribeConfigurationRevisionResponse instance

Returns the specified configuration revision for the specified configuration.

DescribeUser

BrokerId => Str
Username => Str

Each argument is described in detail in: Paws::MQ::DescribeUser

Returns: a Paws::MQ::DescribeUserResponse instance

Returns information about an ActiveMQ user.

ListBrokers

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::MQ::ListBrokers

Returns: a Paws::MQ::ListBrokersResponse instance

Returns a list of all brokers.

ListConfigurationRevisions

ConfigurationId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::MQ::ListConfigurationRevisions

Returns: a Paws::MQ::ListConfigurationRevisionsResponse instance

Returns a list of all revisions for the specified configuration.

ListConfigurations

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::MQ::ListConfigurations

Returns: a Paws::MQ::ListConfigurationsResponse instance

Returns a list of all configurations.

ListTags

ResourceArn => Str

Each argument is described in detail in: Paws::MQ::ListTags

Returns: a Paws::MQ::ListTagsResponse instance

Lists tags for a resource.

ListUsers

BrokerId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::MQ::ListUsers

Returns: a Paws::MQ::ListUsersResponse instance

Returns a list of all ActiveMQ users.

RebootBroker

BrokerId => Str

Each argument is described in detail in: Paws::MQ::RebootBroker

Returns: a Paws::MQ::RebootBrokerResponse instance

Reboots a broker. Note: This API is asynchronous.

UpdateBroker

BrokerId => Str
[AutoMinorVersionUpgrade => Bool]
[Configuration => Paws::MQ::ConfigurationId]
[EngineVersion => Str]
[Logs => Paws::MQ::Logs]

Each argument is described in detail in: Paws::MQ::UpdateBroker

Returns: a Paws::MQ::UpdateBrokerResponse instance

Adds a pending configuration change to a broker.

UpdateConfiguration

ConfigurationId => Str
[Data => Str]
[Description => Str]

Each argument is described in detail in: Paws::MQ::UpdateConfiguration

Returns: a Paws::MQ::UpdateConfigurationResponse instance

Updates the specified configuration.

UpdateUser

BrokerId => Str
Username => Str
[ConsoleAccess => Bool]
[Groups => ArrayRef[Str|Undef]]
[Password => Str]

Each argument is described in detail in: Paws::MQ::UpdateUser

Returns: a Paws::MQ::UpdateUserResponse instance

Updates the information for an ActiveMQ user.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllBrokers(sub { },[MaxResults => Int, NextToken => Str])

ListAllBrokers([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - BrokerSummaries, passing the object as the first parameter, and the string 'BrokerSummaries' as the second parameter

If not, it will return a a Paws::MQ::ListBrokersResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues