« blib/lib/Paws/AmplifyBackend/GetTokenResponse.pm
↑ Summary
blib/lib/Paws/AmplifyBackend/ImportBackendAuthReqObj.pm »
| 1 | |||
| 2 | package Paws::AmplifyBackend::ImportBackendAuth; | ||
| 3 | use Moose; | ||
| 4 | has AppId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'appId', required => 1); | ||
| 5 | has BackendEnvironmentName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'backendEnvironmentName', required => 1); | ||
| 6 | has IdentityPoolId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'identityPoolId'); | ||
| 7 | has NativeClientId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nativeClientId', required => 1); | ||
| 8 | has UserPoolId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'userPoolId', required => 1); | ||
| 9 | has WebClientId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'webClientId', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ImportBackendAuth'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/backend/{appId}/auth/{backendEnvironmentName}/import'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AmplifyBackend::ImportBackendAuthResponse'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::AmplifyBackend::ImportBackendAuth - Arguments for method ImportBackendAuth on L<Paws::AmplifyBackend> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ImportBackendAuth on the | ||
| 28 | L<AmplifyBackend|Paws::AmplifyBackend> service. Use the attributes of this class | ||
| 29 | as arguments to method ImportBackendAuth. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ImportBackendAuth. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $amplifybackend = Paws->service('AmplifyBackend'); | ||
| 36 | my $ImportBackendAuthResponse = $amplifybackend->ImportBackendAuth( | ||
| 37 | AppId => 'My__string', | ||
| 38 | BackendEnvironmentName => 'My__string', | ||
| 39 | NativeClientId => 'My__string', | ||
| 40 | UserPoolId => 'My__string', | ||
| 41 | WebClientId => 'My__string', | ||
| 42 | IdentityPoolId => 'My__string', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $AppId = $ImportBackendAuthResponse->AppId; | ||
| 47 | my $BackendEnvironmentName = | ||
| 48 | $ImportBackendAuthResponse->BackendEnvironmentName; | ||
| 49 | my $Error = $ImportBackendAuthResponse->Error; | ||
| 50 | my $JobId = $ImportBackendAuthResponse->JobId; | ||
| 51 | my $Operation = $ImportBackendAuthResponse->Operation; | ||
| 52 | my $Status = $ImportBackendAuthResponse->Status; | ||
| 53 | |||
| 54 | # Returns a L<Paws::AmplifyBackend::ImportBackendAuthResponse> object. | ||
| 55 | |||
| 56 | 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. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/amplifybackend/ImportBackendAuth> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> AppId => Str | ||
| 63 | |||
| 64 | The app ID. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> BackendEnvironmentName => Str | ||
| 69 | |||
| 70 | The name of the backend environment. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 IdentityPoolId => Str | ||
| 75 | |||
| 76 | The ID of the Amazon Cognito identity pool. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> NativeClientId => Str | ||
| 81 | |||
| 82 | The ID of the Amazon Cognito native client. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 B<REQUIRED> UserPoolId => Str | ||
| 87 | |||
| 88 | The ID of the Amazon Cognito user pool. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> WebClientId => Str | ||
| 93 | |||
| 94 | The ID of the Amazon Cognito web client. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, documenting arguments for method ImportBackendAuth in L<Paws::AmplifyBackend> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 |