From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

JROBINSON / Paws-0.46 / lib / Paws / AmplifyBackend / GetBackendAPI.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
—
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

              
package Paws::AmplifyBackend::GetBackendAPI;
  use Moose;
  has AppId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'appId', required => 1);
  has BackendEnvironmentName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'backendEnvironmentName', required => 1);
  has ResourceConfig => (is => 'ro', isa => 'Paws::AmplifyBackend::BackendAPIResourceConfig', traits => ['NameInRequest'], request_name => 'resourceConfig');
  has ResourceName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'resourceName', required => 1);
  use MooseX::ClassAttribute;
  class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetBackendAPI');
  class_has _api_uri  => (isa => 'Str', is => 'ro', default => '/backend/{appId}/api/{backendEnvironmentName}/details');
  class_has _api_method  => (isa => 'Str', is => 'ro', default => 'POST');
  class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AmplifyBackend::GetBackendAPIResponse');
1;
### main pod documentation begin ###
=head1 NAME
Paws::AmplifyBackend::GetBackendAPI - Arguments for method GetBackendAPI on L<Paws::AmplifyBackend>
=head1 DESCRIPTION
This class represents the parameters used for calling the method GetBackendAPI on the
L<AmplifyBackend|Paws::AmplifyBackend> service. Use the attributes of this class
as arguments to method GetBackendAPI.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetBackendAPI.
=head1 SYNOPSIS
    my $amplifybackend = Paws->service('AmplifyBackend');
    my $GetBackendAPIResponse = $amplifybackend->GetBackendAPI(
      AppId                  => 'My__string',
      BackendEnvironmentName => 'My__string',
      ResourceName           => 'My__string',
      ResourceConfig         => {
        AdditionalAuthTypes => [
          {
            Mode => 'API_KEY'
            , # values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT; OPTIONAL
            Settings => {
              CognitoUserPoolId  => 'My__string',
              Description        => 'My__string',
              ExpirationTime     => 1,              # OPTIONAL
              OpenIDAuthTTL      => 'My__string',
              OpenIDClientId     => 'My__string',
              OpenIDIatTTL       => 'My__string',
              OpenIDIssueURL     => 'My__string',
              OpenIDProviderName => 'My__string',
            },    # OPTIONAL
          },
          ...
        ],    # OPTIONAL
        ApiName            => 'My__string',
        ConflictResolution => {
          ResolutionStrategy => 'OPTIMISTIC_CONCURRENCY'
          ,  # values: OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE; OPTIONAL
        },    # OPTIONAL
        DefaultAuthType => {
          Mode => 'API_KEY'
          , # values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT; OPTIONAL
          Settings => {
            CognitoUserPoolId  => 'My__string',
            Description        => 'My__string',
            ExpirationTime     => 1,              # OPTIONAL
            OpenIDAuthTTL      => 'My__string',
            OpenIDClientId     => 'My__string',
            OpenIDIatTTL       => 'My__string',
            OpenIDIssueURL     => 'My__string',
            OpenIDProviderName => 'My__string',
          },    # OPTIONAL
        },
        Service         => 'My__string',
        TransformSchema => 'My__string',
      },    # OPTIONAL
    );
    # Results:
    my $AppId                  = $GetBackendAPIResponse->AppId;
    my $BackendEnvironmentName = $GetBackendAPIResponse->BackendEnvironmentName;
    my $Error                  = $GetBackendAPIResponse->Error;
    my $ResourceConfig         = $GetBackendAPIResponse->ResourceConfig;
    my $ResourceName           = $GetBackendAPIResponse->ResourceName;
    # Returns a L<Paws::AmplifyBackend::GetBackendAPIResponse> object.
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.
For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/amplifybackend/GetBackendAPI>
=head1 ATTRIBUTES
=head2 B<REQUIRED> AppId => Str
The app ID.
=head2 B<REQUIRED> BackendEnvironmentName => Str
The name of the backend environment.
=head2 ResourceConfig => L<Paws::AmplifyBackend::BackendAPIResourceConfig>
Defines the resource configuration for the data model in your Amplify
project.
=head2 B<REQUIRED> ResourceName => Str
The name of this resource.
=head1 SEE ALSO
This class forms part of L<Paws>, documenting arguments for method GetBackendAPI in L<Paws::AmplifyBackend>
=head1 BUGS and CONTRIBUTIONS
The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
=cut