« blib/lib/Paws/AmplifyBackend/DeleteBackend.pm
↑ Summary
blib/lib/Paws/AmplifyBackend/DeleteBackendAPIResponse.pm »
| 1 | |||
| 2 | package Paws::AmplifyBackend::DeleteBackendAPI; | ||
| 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 ResourceConfig => (is => 'ro', isa => 'Paws::AmplifyBackend::BackendAPIResourceConfig', traits => ['NameInRequest'], request_name => 'resourceConfig'); | ||
| 7 | has ResourceName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'resourceName', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteBackendAPI'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/backend/{appId}/api/{backendEnvironmentName}/remove'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::AmplifyBackend::DeleteBackendAPIResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::AmplifyBackend::DeleteBackendAPI - Arguments for method DeleteBackendAPI on L<Paws::AmplifyBackend> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DeleteBackendAPI on the | ||
| 26 | L<AmplifyBackend|Paws::AmplifyBackend> service. Use the attributes of this class | ||
| 27 | as arguments to method DeleteBackendAPI. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteBackendAPI. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $amplifybackend = Paws->service('AmplifyBackend'); | ||
| 34 | my $DeleteBackendAPIResponse = $amplifybackend->DeleteBackendAPI( | ||
| 35 | AppId => 'My__string', | ||
| 36 | BackendEnvironmentName => 'My__string', | ||
| 37 | ResourceName => 'My__string', | ||
| 38 | ResourceConfig => { | ||
| 39 | AdditionalAuthTypes => [ | ||
| 40 | { | ||
| 41 | Mode => 'API_KEY' | ||
| 42 | , # values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT; OPTIONAL | ||
| 43 | Settings => { | ||
| 44 | CognitoUserPoolId => 'My__string', | ||
| 45 | Description => 'My__string', | ||
| 46 | ExpirationTime => 1, # OPTIONAL | ||
| 47 | OpenIDAuthTTL => 'My__string', | ||
| 48 | OpenIDClientId => 'My__string', | ||
| 49 | OpenIDIatTTL => 'My__string', | ||
| 50 | OpenIDIssueURL => 'My__string', | ||
| 51 | OpenIDProviderName => 'My__string', | ||
| 52 | }, # OPTIONAL | ||
| 53 | }, | ||
| 54 | ... | ||
| 55 | ], # OPTIONAL | ||
| 56 | ApiName => 'My__string', | ||
| 57 | ConflictResolution => { | ||
| 58 | ResolutionStrategy => 'OPTIMISTIC_CONCURRENCY' | ||
| 59 | , # values: OPTIMISTIC_CONCURRENCY, LAMBDA, AUTOMERGE, NONE; OPTIONAL | ||
| 60 | }, # OPTIONAL | ||
| 61 | DefaultAuthType => { | ||
| 62 | Mode => 'API_KEY' | ||
| 63 | , # values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT; OPTIONAL | ||
| 64 | Settings => { | ||
| 65 | CognitoUserPoolId => 'My__string', | ||
| 66 | Description => 'My__string', | ||
| 67 | ExpirationTime => 1, # OPTIONAL | ||
| 68 | OpenIDAuthTTL => 'My__string', | ||
| 69 | OpenIDClientId => 'My__string', | ||
| 70 | OpenIDIatTTL => 'My__string', | ||
| 71 | OpenIDIssueURL => 'My__string', | ||
| 72 | OpenIDProviderName => 'My__string', | ||
| 73 | }, # OPTIONAL | ||
| 74 | }, | ||
| 75 | Service => 'My__string', | ||
| 76 | TransformSchema => 'My__string', | ||
| 77 | }, # OPTIONAL | ||
| 78 | ); | ||
| 79 | |||
| 80 | # Results: | ||
| 81 | my $AppId = $DeleteBackendAPIResponse->AppId; | ||
| 82 | my $BackendEnvironmentName = | ||
| 83 | $DeleteBackendAPIResponse->BackendEnvironmentName; | ||
| 84 | my $Error = $DeleteBackendAPIResponse->Error; | ||
| 85 | my $JobId = $DeleteBackendAPIResponse->JobId; | ||
| 86 | my $Operation = $DeleteBackendAPIResponse->Operation; | ||
| 87 | my $Status = $DeleteBackendAPIResponse->Status; | ||
| 88 | |||
| 89 | # Returns a L<Paws::AmplifyBackend::DeleteBackendAPIResponse> object. | ||
| 90 | |||
| 91 | 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. | ||
| 92 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/amplifybackend/DeleteBackendAPI> | ||
| 93 | |||
| 94 | =head1 ATTRIBUTES | ||
| 95 | |||
| 96 | |||
| 97 | =head2 B<REQUIRED> AppId => Str | ||
| 98 | |||
| 99 | The app ID. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 B<REQUIRED> BackendEnvironmentName => Str | ||
| 104 | |||
| 105 | The name of the backend environment. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 ResourceConfig => L<Paws::AmplifyBackend::BackendAPIResourceConfig> | ||
| 110 | |||
| 111 | Defines the resource configuration for the data model in your Amplify | ||
| 112 | project. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> ResourceName => Str | ||
| 117 | |||
| 118 | The name of this resource. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head1 SEE ALSO | ||
| 124 | |||
| 125 | This class forms part of L<Paws>, documenting arguments for method DeleteBackendAPI in L<Paws::AmplifyBackend> | ||
| 126 | |||
| 127 | =head1 BUGS and CONTRIBUTIONS | ||
| 128 | |||
| 129 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 130 | |||
| 131 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 132 | |||
| 133 | =cut | ||
| 134 |