« blib/lib/Paws/ApiGateway/UpdateAuthorizer.pm
↑ Summary
blib/lib/Paws/ApiGateway/UpdateClientCertificate.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::UpdateBasePathMapping; | ||
| 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 | has PatchOperations => (is => 'ro', isa => 'ArrayRef[Paws::ApiGateway::PatchOperation]', traits => ['NameInRequest'], request_name => 'patchOperations'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateBasePathMapping'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/domainnames/{domain_name}/basepathmappings/{base_path}'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::BasePathMapping'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::ApiGateway::UpdateBasePathMapping - Arguments for method UpdateBasePathMapping on L<Paws::ApiGateway> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method UpdateBasePathMapping on the | ||
| 25 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 26 | as arguments to method UpdateBasePathMapping. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateBasePathMapping. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $apigateway = Paws->service('ApiGateway'); | ||
| 33 | my $BasePathMapping = $apigateway->UpdateBasePathMapping( | ||
| 34 | BasePath => 'MyString', | ||
| 35 | DomainName => 'MyString', | ||
| 36 | PatchOperations => [ | ||
| 37 | { | ||
| 38 | From => 'MyString', | ||
| 39 | Op => | ||
| 40 | 'add', # values: add, remove, replace, move, copy, test; OPTIONAL | ||
| 41 | Path => 'MyString', | ||
| 42 | Value => 'MyString', | ||
| 43 | }, | ||
| 44 | ... | ||
| 45 | ], # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $BasePath = $BasePathMapping->BasePath; | ||
| 50 | my $RestApiId = $BasePathMapping->RestApiId; | ||
| 51 | my $Stage = $BasePathMapping->Stage; | ||
| 52 | |||
| 53 | # Returns a L<Paws::ApiGateway::BasePathMapping> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/UpdateBasePathMapping> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> BasePath => Str | ||
| 62 | |||
| 63 | [Required] The base path of the BasePathMapping resource to change. | ||
| 64 | |||
| 65 | To specify an empty base path, set this parameter to C<'(none)'>. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> DomainName => Str | ||
| 70 | |||
| 71 | [Required] The domain name of the BasePathMapping resource to change. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 PatchOperations => ArrayRef[L<Paws::ApiGateway::PatchOperation>] | ||
| 76 | |||
| 77 | A list of update operations to be applied to the specified resource and | ||
| 78 | in the order specified in this list. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head1 SEE ALSO | ||
| 84 | |||
| 85 | This class forms part of L<Paws>, documenting arguments for method UpdateBasePathMapping in L<Paws::ApiGateway> | ||
| 86 | |||
| 87 | =head1 BUGS and CONTRIBUTIONS | ||
| 88 | |||
| 89 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 90 | |||
| 91 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 92 | |||
| 93 | =cut | ||
| 94 |