« blib/lib/Paws/MigrationHubConfig/CreateHomeRegionControlResult.pm
↑ Summary
blib/lib/Paws/MigrationHubConfig/DescribeHomeRegionControlsResult.pm »
| 1 | |||
| 2 | package Paws::MigrationHubConfig::DescribeHomeRegionControls; | ||
| 3 | use Moose; | ||
| 4 | has ControlId => (is => 'ro', isa => 'Str'); | ||
| 5 | has HomeRegion => (is => 'ro', isa => 'Str'); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 8 | has Target => (is => 'ro', isa => 'Paws::MigrationHubConfig::Target'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeHomeRegionControls'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MigrationHubConfig::DescribeHomeRegionControlsResult'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::MigrationHubConfig::DescribeHomeRegionControls - Arguments for method DescribeHomeRegionControls on L<Paws::MigrationHubConfig> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeHomeRegionControls on the | ||
| 26 | L<AWS Migration Hub Config|Paws::MigrationHubConfig> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeHomeRegionControls. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeHomeRegionControls. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $migrationhub-config = Paws->service('MigrationHubConfig'); | ||
| 34 | my $DescribeHomeRegionControlsResult = | ||
| 35 | $migrationhub -config->DescribeHomeRegionControls( | ||
| 36 | ControlId => 'MyControlId', # OPTIONAL | ||
| 37 | HomeRegion => 'MyHomeRegion', # OPTIONAL | ||
| 38 | MaxResults => 1, # OPTIONAL | ||
| 39 | NextToken => 'MyToken', # OPTIONAL | ||
| 40 | Target => { | ||
| 41 | Type => 'ACCOUNT', # values: ACCOUNT | ||
| 42 | Id => 'MyTargetId', # min: 12, max: 12; OPTIONAL | ||
| 43 | }, # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $HomeRegionControls = | ||
| 48 | $DescribeHomeRegionControlsResult->HomeRegionControls; | ||
| 49 | my $NextToken = $DescribeHomeRegionControlsResult->NextToken; | ||
| 50 | |||
| 51 | # Returns a L<Paws::MigrationHubConfig::DescribeHomeRegionControlsResult> object. | ||
| 52 | |||
| 53 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/migrationhub-config/DescribeHomeRegionControls> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 ControlId => Str | ||
| 60 | |||
| 61 | The C<ControlID> is a unique identifier string of your | ||
| 62 | C<HomeRegionControl> object. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 HomeRegion => Str | ||
| 67 | |||
| 68 | The name of the home region you'd like to view. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 MaxResults => Int | ||
| 73 | |||
| 74 | The maximum number of filtering results to display per page. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 NextToken => Str | ||
| 79 | |||
| 80 | If a C<NextToken> was returned by a previous call, more results are | ||
| 81 | available. To retrieve the next page of results, make the call again | ||
| 82 | using the returned token in C<NextToken>. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 Target => L<Paws::MigrationHubConfig::Target> | ||
| 87 | |||
| 88 | The target parameter specifies the identifier to which the home region | ||
| 89 | is applied, which is always of type C<ACCOUNT>. It applies the home | ||
| 90 | region to the current C<ACCOUNT>. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head1 SEE ALSO | ||
| 96 | |||
| 97 | This class forms part of L<Paws>, documenting arguments for method DescribeHomeRegionControls in L<Paws::MigrationHubConfig> | ||
| 98 | |||
| 99 | =head1 BUGS and CONTRIBUTIONS | ||
| 100 | |||
| 101 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 102 | |||
| 103 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 104 | |||
| 105 | =cut | ||
| 106 |