/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::AmplifyBackend

NAME

Paws::AmplifyBackend - Perl Interface to AWS AmplifyBackend

SYNOPSIS

use Paws;

my $obj = Paws->service('AmplifyBackend');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

AWS Amplify Admin API

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/amplifybackend-2020-08-11

METHODS

CloneBackend

AppId => Str
BackendEnvironmentName => Str
TargetEnvironmentName => Str

Each argument is described in detail in: Paws::AmplifyBackend::CloneBackend

Returns: a Paws::AmplifyBackend::CloneBackendResponse instance

This operation clones an existing backend.

CreateBackend

AppId => Str
AppName => Str
BackendEnvironmentName => Str
[ResourceConfig => Paws::AmplifyBackend::ResourceConfig]
[ResourceName => Str]

Each argument is described in detail in: Paws::AmplifyBackend::CreateBackend

Returns: a Paws::AmplifyBackend::CreateBackendResponse instance

This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

CreateBackendAPI

AppId => Str
BackendEnvironmentName => Str
ResourceConfig => Paws::AmplifyBackend::BackendAPIResourceConfig
ResourceName => Str

Each argument is described in detail in: Paws::AmplifyBackend::CreateBackendAPI

Returns: a Paws::AmplifyBackend::CreateBackendAPIResponse instance

Creates a new backend API resource.

CreateBackendAuth

AppId => Str
BackendEnvironmentName => Str
ResourceConfig => Paws::AmplifyBackend::CreateBackendAuthResourceConfig
ResourceName => Str

Each argument is described in detail in: Paws::AmplifyBackend::CreateBackendAuth

Returns: a Paws::AmplifyBackend::CreateBackendAuthResponse instance

Creates a new backend authentication resource.

CreateBackendConfig

AppId => Str
[BackendManagerAppId => Str]

Each argument is described in detail in: Paws::AmplifyBackend::CreateBackendConfig

Returns: a Paws::AmplifyBackend::CreateBackendConfigResponse instance

Creates a config object for a backend.

CreateToken

AppId => Str

Each argument is described in detail in: Paws::AmplifyBackend::CreateToken

Returns: a Paws::AmplifyBackend::CreateTokenResponse instance

Generates a one-time challenge code to authenticate a user into your Amplify Admin UI.

DeleteBackend

AppId => Str
BackendEnvironmentName => Str

Each argument is described in detail in: Paws::AmplifyBackend::DeleteBackend

Returns: a Paws::AmplifyBackend::DeleteBackendResponse instance

Removes an existing environment from your Amplify project.

DeleteBackendAPI

AppId => Str
BackendEnvironmentName => Str
ResourceName => Str
[ResourceConfig => Paws::AmplifyBackend::BackendAPIResourceConfig]

Each argument is described in detail in: Paws::AmplifyBackend::DeleteBackendAPI

Returns: a Paws::AmplifyBackend::DeleteBackendAPIResponse instance

Deletes an existing backend API resource.

DeleteBackendAuth

AppId => Str
BackendEnvironmentName => Str
ResourceName => Str

Each argument is described in detail in: Paws::AmplifyBackend::DeleteBackendAuth

Returns: a Paws::AmplifyBackend::DeleteBackendAuthResponse instance

Deletes an existing backend authentication resource.

DeleteToken

AppId => Str
SessionId => Str

Each argument is described in detail in: Paws::AmplifyBackend::DeleteToken

Returns: a Paws::AmplifyBackend::DeleteTokenResponse instance

Deletes the challenge token based on the given appId and sessionId.

GenerateBackendAPIModels

AppId => Str
BackendEnvironmentName => Str
ResourceName => Str

Each argument is described in detail in: Paws::AmplifyBackend::GenerateBackendAPIModels

Returns: a Paws::AmplifyBackend::GenerateBackendAPIModelsResponse instance

Generates a model schema for an existing backend API resource.

GetBackend

AppId => Str
[BackendEnvironmentName => Str]

Each argument is described in detail in: Paws::AmplifyBackend::GetBackend

Returns: a Paws::AmplifyBackend::GetBackendResponse instance

Provides project-level details for your Amplify UI project.

GetBackendAPI

AppId => Str
BackendEnvironmentName => Str
ResourceName => Str
[ResourceConfig => Paws::AmplifyBackend::BackendAPIResourceConfig]

Each argument is described in detail in: Paws::AmplifyBackend::GetBackendAPI

Returns: a Paws::AmplifyBackend::GetBackendAPIResponse instance

Gets the details for a backend API.

GetBackendAPIModels

AppId => Str
BackendEnvironmentName => Str
ResourceName => Str

Each argument is described in detail in: Paws::AmplifyBackend::GetBackendAPIModels

Returns: a Paws::AmplifyBackend::GetBackendAPIModelsResponse instance

Generates a model schema for existing backend API resource.

GetBackendAuth

AppId => Str
BackendEnvironmentName => Str
ResourceName => Str

Each argument is described in detail in: Paws::AmplifyBackend::GetBackendAuth

Returns: a Paws::AmplifyBackend::GetBackendAuthResponse instance

Gets a backend auth details.

GetBackendJob

AppId => Str
BackendEnvironmentName => Str
JobId => Str

Each argument is described in detail in: Paws::AmplifyBackend::GetBackendJob

Returns: a Paws::AmplifyBackend::GetBackendJobResponse instance

Returns information about a specific job.

GetToken

AppId => Str
SessionId => Str

Each argument is described in detail in: Paws::AmplifyBackend::GetToken

Returns: a Paws::AmplifyBackend::GetTokenResponse instance

Gets the challenge token based on the given appId and sessionId.

ImportBackendAuth

AppId => Str
BackendEnvironmentName => Str
NativeClientId => Str
UserPoolId => Str
WebClientId => Str
[IdentityPoolId => Str]

Each argument is described in detail in: Paws::AmplifyBackend::ImportBackendAuth

Returns: a Paws::AmplifyBackend::ImportBackendAuthResponse instance

Imports an existing backend authentication resource.

ListBackendJobs

AppId => Str
BackendEnvironmentName => Str
[JobId => Str]
[MaxResults => Int]
[NextToken => Str]
[Operation => Str]
[Status => Str]

Each argument is described in detail in: Paws::AmplifyBackend::ListBackendJobs

Returns: a Paws::AmplifyBackend::ListBackendJobsResponse instance

Lists the jobs for the backend of an Amplify app.

RemoveAllBackends

AppId => Str
[CleanAmplifyApp => Bool]

Each argument is described in detail in: Paws::AmplifyBackend::RemoveAllBackends

Returns: a Paws::AmplifyBackend::RemoveAllBackendsResponse instance

Removes all backend environments from your Amplify project.

RemoveBackendConfig

AppId => Str

Each argument is described in detail in: Paws::AmplifyBackend::RemoveBackendConfig

Returns: a Paws::AmplifyBackend::RemoveBackendConfigResponse instance

Removes the AWS resources required to access the Amplify Admin UI.

UpdateBackendAPI

AppId => Str
BackendEnvironmentName => Str
ResourceName => Str
[ResourceConfig => Paws::AmplifyBackend::BackendAPIResourceConfig]

Each argument is described in detail in: Paws::AmplifyBackend::UpdateBackendAPI

Returns: a Paws::AmplifyBackend::UpdateBackendAPIResponse instance

Updates an existing backend API resource.

UpdateBackendAuth

AppId => Str
BackendEnvironmentName => Str
ResourceConfig => Paws::AmplifyBackend::UpdateBackendAuthResourceConfig
ResourceName => Str

Each argument is described in detail in: Paws::AmplifyBackend::UpdateBackendAuth

Returns: a Paws::AmplifyBackend::UpdateBackendAuthResponse instance

Updates an existing backend authentication resource.

UpdateBackendConfig

AppId => Str
[LoginAuthConfig => Paws::AmplifyBackend::LoginAuthConfigReqObj]

Each argument is described in detail in: Paws::AmplifyBackend::UpdateBackendConfig

Returns: a Paws::AmplifyBackend::UpdateBackendConfigResponse instance

Updates the AWS resources required to access the Amplify Admin UI.

UpdateBackendJob

AppId => Str
BackendEnvironmentName => Str
JobId => Str
[Operation => Str]
[Status => Str]

Each argument is described in detail in: Paws::AmplifyBackend::UpdateBackendJob

Returns: a Paws::AmplifyBackend::UpdateBackendJobResponse instance

Updates a specific job.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllBackendJobs(sub { },AppId => Str, BackendEnvironmentName => Str, [JobId => Str, MaxResults => Int, NextToken => Str, Operation => Str, Status => Str])

ListAllBackendJobs(AppId => Str, BackendEnvironmentName => Str, [JobId => Str, MaxResults => Int, NextToken => Str, Operation => Str, Status => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- Jobs, passing the object as the first parameter, and the string 'Jobs' as the second parameter

If not, it will return a a Paws::AmplifyBackend::ListBackendJobsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues