« blib/lib/Paws/ApiGateway/GetAuthorizers.pm
↑ Summary
blib/lib/Paws/ApiGateway/GetBasePathMappings.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::GetBasePathMapping; | ||
| 3 | use Moose; | ||
| 4 | has BasePath => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'base_path', required => 1); | ||
| 5 | has DomainName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'domain_name', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetBasePathMapping'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/domainnames/{domain_name}/basepathmappings/{base_path}'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::BasePathMapping'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::ApiGateway::GetBasePathMapping - Arguments for method GetBasePathMapping on L<Paws::ApiGateway> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method GetBasePathMapping on the | ||
| 24 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 25 | as arguments to method GetBasePathMapping. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetBasePathMapping. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $apigateway = Paws->service('ApiGateway'); | ||
| 32 | my $BasePathMapping = $apigateway->GetBasePathMapping( | ||
| 33 | BasePath => 'MyString', | ||
| 34 | DomainName => 'MyString', | ||
| 35 | |||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $BasePath = $BasePathMapping->BasePath; | ||
| 40 | my $RestApiId = $BasePathMapping->RestApiId; | ||
| 41 | my $Stage = $BasePathMapping->Stage; | ||
| 42 | |||
| 43 | # Returns a L<Paws::ApiGateway::BasePathMapping> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/GetBasePathMapping> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> BasePath => Str | ||
| 52 | |||
| 53 | [Required] The base path name that callers of the API must provide as | ||
| 54 | part of the URL after the domain name. This value must be unique for | ||
| 55 | all of the mappings across a single API. Specify '(none)' if you do not | ||
| 56 | want callers to specify any base path name after the domain name. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> DomainName => Str | ||
| 61 | |||
| 62 | [Required] The domain name of the BasePathMapping resource to be | ||
| 63 | described. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head1 SEE ALSO | ||
| 69 | |||
| 70 | This class forms part of L<Paws>, documenting arguments for method GetBasePathMapping in L<Paws::ApiGateway> | ||
| 71 | |||
| 72 | =head1 BUGS and CONTRIBUTIONS | ||
| 73 | |||
| 74 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 75 | |||
| 76 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 77 | |||
| 78 | =cut | ||
| 79 |