The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
57 ++
/ Paws::Amplify

NAME

Paws::Amplify - Perl Interface to AWS AWS Amplify

SYNOPSIS

  use Paws;

  my $obj = Paws->service('Amplify');
  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

Amplify enables developers to develop and deploy cloud-powered mobile and web apps. The Amplify Console provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Console User Guide (https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html). The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework. (https://docs.amplify.aws/)

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25

METHODS

CreateApp

Name => Str
[AccessToken => Str]
[AutoBranchCreationConfig => Paws::Amplify::AutoBranchCreationConfig]
[AutoBranchCreationPatterns => ArrayRef[Str|Undef]]
[BasicAuthCredentials => Str]
[BuildSpec => Str]
[CustomHeaders => Str]
[CustomRules => ArrayRef[Paws::Amplify::CustomRule]]
[Description => Str]
[EnableAutoBranchCreation => Bool]
[EnableBasicAuth => Bool]
[EnableBranchAutoBuild => Bool]
[EnableBranchAutoDeletion => Bool]
[EnvironmentVariables => Paws::Amplify::EnvironmentVariables]
[IamServiceRoleArn => Str]
[OauthToken => Str]
[Platform => Str]
[Repository => Str]
[Tags => Paws::Amplify::TagMap]

Each argument is described in detail in: Paws::Amplify::CreateApp

Returns: a Paws::Amplify::CreateAppResult instance

Creates a new Amplify app.

CreateBackendEnvironment

AppId => Str
EnvironmentName => Str
[DeploymentArtifacts => Str]
[StackName => Str]

Each argument is described in detail in: Paws::Amplify::CreateBackendEnvironment

Returns: a Paws::Amplify::CreateBackendEnvironmentResult instance

Creates a new backend environment for an Amplify app.

CreateBranch

AppId => Str
BranchName => Str
[BackendEnvironmentArn => Str]
[BasicAuthCredentials => Str]
[BuildSpec => Str]
[Description => Str]
[DisplayName => Str]
[EnableAutoBuild => Bool]
[EnableBasicAuth => Bool]
[EnableNotification => Bool]
[EnablePerformanceMode => Bool]
[EnablePullRequestPreview => Bool]
[EnvironmentVariables => Paws::Amplify::EnvironmentVariables]
[Framework => Str]
[PullRequestEnvironmentName => Str]
[Stage => Str]
[Tags => Paws::Amplify::TagMap]
[Ttl => Str]

Each argument is described in detail in: Paws::Amplify::CreateBranch

Returns: a Paws::Amplify::CreateBranchResult instance

Creates a new branch for an Amplify app.

CreateDeployment

AppId => Str
BranchName => Str
[FileMap => Paws::Amplify::FileMap]

Each argument is described in detail in: Paws::Amplify::CreateDeployment

Returns: a Paws::Amplify::CreateDeploymentResult instance

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository.

CreateDomainAssociation

AppId => Str
DomainName => Str
SubDomainSettings => ArrayRef[Paws::Amplify::SubDomainSetting]
[AutoSubDomainCreationPatterns => ArrayRef[Str|Undef]]
[AutoSubDomainIAMRole => Str]
[EnableAutoSubDomain => Bool]

Each argument is described in detail in: Paws::Amplify::CreateDomainAssociation

Returns: a Paws::Amplify::CreateDomainAssociationResult instance

Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app

CreateWebhook

AppId => Str
BranchName => Str
[Description => Str]

Each argument is described in detail in: Paws::Amplify::CreateWebhook

Returns: a Paws::Amplify::CreateWebhookResult instance

Creates a new webhook on an Amplify app.

DeleteApp

AppId => Str

Each argument is described in detail in: Paws::Amplify::DeleteApp

Returns: a Paws::Amplify::DeleteAppResult instance

Deletes an existing Amplify app specified by an app ID.

DeleteBackendEnvironment

AppId => Str
EnvironmentName => Str

Each argument is described in detail in: Paws::Amplify::DeleteBackendEnvironment

Returns: a Paws::Amplify::DeleteBackendEnvironmentResult instance

Deletes a backend environment for an Amplify app.

DeleteBranch

AppId => Str
BranchName => Str

Each argument is described in detail in: Paws::Amplify::DeleteBranch

Returns: a Paws::Amplify::DeleteBranchResult instance

Deletes a branch for an Amplify app.

DeleteDomainAssociation

AppId => Str
DomainName => Str

Each argument is described in detail in: Paws::Amplify::DeleteDomainAssociation

Returns: a Paws::Amplify::DeleteDomainAssociationResult instance

Deletes a domain association for an Amplify app.

DeleteJob

AppId => Str
BranchName => Str
JobId => Str

Each argument is described in detail in: Paws::Amplify::DeleteJob

Returns: a Paws::Amplify::DeleteJobResult instance

Deletes a job for a branch of an Amplify app.

DeleteWebhook

WebhookId => Str

Each argument is described in detail in: Paws::Amplify::DeleteWebhook

Returns: a Paws::Amplify::DeleteWebhookResult instance

Deletes a webhook.

GenerateAccessLogs

AppId => Str
DomainName => Str
[EndTime => Str]
[StartTime => Str]

Each argument is described in detail in: Paws::Amplify::GenerateAccessLogs

Returns: a Paws::Amplify::GenerateAccessLogsResult instance

Returns the website access logs for a specific time range using a presigned URL.

GetApp

AppId => Str

Each argument is described in detail in: Paws::Amplify::GetApp

Returns: a Paws::Amplify::GetAppResult instance

Returns an existing Amplify app by appID.

GetArtifactUrl

ArtifactId => Str

Each argument is described in detail in: Paws::Amplify::GetArtifactUrl

Returns: a Paws::Amplify::GetArtifactUrlResult instance

Returns the artifact info that corresponds to an artifact id.

GetBackendEnvironment

AppId => Str
EnvironmentName => Str

Each argument is described in detail in: Paws::Amplify::GetBackendEnvironment

Returns: a Paws::Amplify::GetBackendEnvironmentResult instance

Returns a backend environment for an Amplify app.

GetBranch

AppId => Str
BranchName => Str

Each argument is described in detail in: Paws::Amplify::GetBranch

Returns: a Paws::Amplify::GetBranchResult instance

Returns a branch for an Amplify app.

GetDomainAssociation

AppId => Str
DomainName => Str

Each argument is described in detail in: Paws::Amplify::GetDomainAssociation

Returns: a Paws::Amplify::GetDomainAssociationResult instance

Returns the domain information for an Amplify app.

GetJob

AppId => Str
BranchName => Str
JobId => Str

Each argument is described in detail in: Paws::Amplify::GetJob

Returns: a Paws::Amplify::GetJobResult instance

Returns a job for a branch of an Amplify app.

GetWebhook

WebhookId => Str

Each argument is described in detail in: Paws::Amplify::GetWebhook

Returns: a Paws::Amplify::GetWebhookResult instance

Returns the webhook information that corresponds to a specified webhook ID.

ListApps

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Amplify::ListApps

Returns: a Paws::Amplify::ListAppsResult instance

Returns a list of the existing Amplify apps.

ListArtifacts

AppId => Str
BranchName => Str
JobId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Amplify::ListArtifacts

Returns: a Paws::Amplify::ListArtifactsResult instance

Returns a list of artifacts for a specified app, branch, and job.

ListBackendEnvironments

AppId => Str
[EnvironmentName => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Amplify::ListBackendEnvironments

Returns: a Paws::Amplify::ListBackendEnvironmentsResult instance

Lists the backend environments for an Amplify app.

ListBranches

AppId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Amplify::ListBranches

Returns: a Paws::Amplify::ListBranchesResult instance

Lists the branches of an Amplify app.

ListDomainAssociations

AppId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Amplify::ListDomainAssociations

Returns: a Paws::Amplify::ListDomainAssociationsResult instance

Returns the domain associations for an Amplify app.

ListJobs

AppId => Str
BranchName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Amplify::ListJobs

Returns: a Paws::Amplify::ListJobsResult instance

Lists the jobs for a branch of an Amplify app.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::Amplify::ListTagsForResource

Returns: a Paws::Amplify::ListTagsForResourceResponse instance

Returns a list of tags for a specified Amazon Resource Name (ARN).

ListWebhooks

AppId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Amplify::ListWebhooks

Returns: a Paws::Amplify::ListWebhooksResult instance

Returns a list of webhooks for an Amplify app.

StartDeployment

AppId => Str
BranchName => Str
[JobId => Str]
[SourceUrl => Str]

Each argument is described in detail in: Paws::Amplify::StartDeployment

Returns: a Paws::Amplify::StartDeploymentResult instance

Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository.

StartJob

AppId => Str
BranchName => Str
JobType => Str
[CommitId => Str]
[CommitMessage => Str]
[CommitTime => Str]
[JobId => Str]
[JobReason => Str]

Each argument is described in detail in: Paws::Amplify::StartJob

Returns: a Paws::Amplify::StartJobResult instance

Starts a new job for a branch of an Amplify app.

StopJob

AppId => Str
BranchName => Str
JobId => Str

Each argument is described in detail in: Paws::Amplify::StopJob

Returns: a Paws::Amplify::StopJobResult instance

Stops a job that is in progress for a branch of an Amplify app.

TagResource

ResourceArn => Str
Tags => Paws::Amplify::TagMap

Each argument is described in detail in: Paws::Amplify::TagResource

Returns: a Paws::Amplify::TagResourceResponse instance

Tags the resource with a tag key and value.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Amplify::UntagResource

Returns: a Paws::Amplify::UntagResourceResponse instance

Untags a resource with a specified Amazon Resource Name (ARN).

UpdateApp

AppId => Str
[AccessToken => Str]
[AutoBranchCreationConfig => Paws::Amplify::AutoBranchCreationConfig]
[AutoBranchCreationPatterns => ArrayRef[Str|Undef]]
[BasicAuthCredentials => Str]
[BuildSpec => Str]
[CustomHeaders => Str]
[CustomRules => ArrayRef[Paws::Amplify::CustomRule]]
[Description => Str]
[EnableAutoBranchCreation => Bool]
[EnableBasicAuth => Bool]
[EnableBranchAutoBuild => Bool]
[EnableBranchAutoDeletion => Bool]
[EnvironmentVariables => Paws::Amplify::EnvironmentVariables]
[IamServiceRoleArn => Str]
[Name => Str]
[OauthToken => Str]
[Platform => Str]
[Repository => Str]

Each argument is described in detail in: Paws::Amplify::UpdateApp

Returns: a Paws::Amplify::UpdateAppResult instance

Updates an existing Amplify app.

UpdateBranch

AppId => Str
BranchName => Str
[BackendEnvironmentArn => Str]
[BasicAuthCredentials => Str]
[BuildSpec => Str]
[Description => Str]
[DisplayName => Str]
[EnableAutoBuild => Bool]
[EnableBasicAuth => Bool]
[EnableNotification => Bool]
[EnablePerformanceMode => Bool]
[EnablePullRequestPreview => Bool]
[EnvironmentVariables => Paws::Amplify::EnvironmentVariables]
[Framework => Str]
[PullRequestEnvironmentName => Str]
[Stage => Str]
[Ttl => Str]

Each argument is described in detail in: Paws::Amplify::UpdateBranch

Returns: a Paws::Amplify::UpdateBranchResult instance

Updates a branch for an Amplify app.

UpdateDomainAssociation

AppId => Str
DomainName => Str
SubDomainSettings => ArrayRef[Paws::Amplify::SubDomainSetting]
[AutoSubDomainCreationPatterns => ArrayRef[Str|Undef]]
[AutoSubDomainIAMRole => Str]
[EnableAutoSubDomain => Bool]

Each argument is described in detail in: Paws::Amplify::UpdateDomainAssociation

Returns: a Paws::Amplify::UpdateDomainAssociationResult instance

Creates a new domain association for an Amplify app.

UpdateWebhook

WebhookId => Str
[BranchName => Str]
[Description => Str]

Each argument is described in detail in: Paws::Amplify::UpdateWebhook

Returns: a Paws::Amplify::UpdateWebhookResult instance

Updates a webhook.

PAGINATORS

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

ListAllApps(sub { },[MaxResults => Int, NextToken => Str])

ListAllApps([MaxResults => Int, NextToken => Str])

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

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

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

ListAllBranches(sub { },AppId => Str, [MaxResults => Int, NextToken => Str])

ListAllBranches(AppId => Str, [MaxResults => Int, NextToken => Str])

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

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

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

ListAllDomainAssociations(sub { },AppId => Str, [MaxResults => Int, NextToken => Str])

ListAllDomainAssociations(AppId => Str, [MaxResults => Int, NextToken => Str])

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

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

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

ListAllJobs(sub { },AppId => Str, BranchName => Str, [MaxResults => Int, NextToken => Str])

ListAllJobs(AppId => Str, BranchName => Str, [MaxResults => Int, NextToken => Str])

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

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

If not, it will return a a Paws::Amplify::ListJobsResult 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