« blib/lib/Paws/Amplify/StartDeploymentResult.pm
↑ Summary
blib/lib/Paws/Amplify/StartJobResult.pm »
| 1 | |||
| 2 | package Paws::Amplify::StartJob; | ||
| 3 | use Moose; | ||
| 4 | has AppId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'appId', required => 1); | ||
| 5 | has BranchName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'branchName', required => 1); | ||
| 6 | has CommitId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'commitId'); | ||
| 7 | has CommitMessage => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'commitMessage'); | ||
| 8 | has CommitTime => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'commitTime'); | ||
| 9 | has JobId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'jobId'); | ||
| 10 | has JobReason => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'jobReason'); | ||
| 11 | has JobType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'jobType', required => 1); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartJob'); | ||
| 16 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/apps/{appId}/branches/{branchName}/jobs'); | ||
| 17 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Amplify::StartJobResult'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::Amplify::StartJob - Arguments for method StartJob on L<Paws::Amplify> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method StartJob on the | ||
| 30 | L<AWS Amplify|Paws::Amplify> service. Use the attributes of this class | ||
| 31 | as arguments to method StartJob. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartJob. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $amplify = Paws->service('Amplify'); | ||
| 38 | my $StartJobResult = $amplify->StartJob( | ||
| 39 | AppId => 'MyAppId', | ||
| 40 | BranchName => 'MyBranchName', | ||
| 41 | JobType => 'RELEASE', | ||
| 42 | CommitId => 'MyCommitId', # OPTIONAL | ||
| 43 | CommitMessage => 'MyCommitMessage', # OPTIONAL | ||
| 44 | CommitTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 45 | JobId => 'MyJobId', # OPTIONAL | ||
| 46 | JobReason => 'MyJobReason', # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $JobSummary = $StartJobResult->JobSummary; | ||
| 51 | |||
| 52 | # Returns a L<Paws::Amplify::StartJobResult> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/amplify/StartJob> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> AppId => Str | ||
| 61 | |||
| 62 | The unique ID for an Amplify app. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> BranchName => Str | ||
| 67 | |||
| 68 | The branch name for the job. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 CommitId => Str | ||
| 73 | |||
| 74 | The commit ID from a third-party repository provider for the job. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 CommitMessage => Str | ||
| 79 | |||
| 80 | The commit message from a third-party repository provider for the job. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 CommitTime => Str | ||
| 85 | |||
| 86 | The commit date and time for the job. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 JobId => Str | ||
| 91 | |||
| 92 | The unique ID for an existing job. This is required if the value of | ||
| 93 | C<jobType> is C<RETRY>. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 JobReason => Str | ||
| 98 | |||
| 99 | A descriptive reason for starting this job. | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head2 B<REQUIRED> JobType => Str | ||
| 104 | |||
| 105 | Describes the type for the job. The job type C<RELEASE> starts a new | ||
| 106 | job with the latest change from the specified branch. This value is | ||
| 107 | available only for apps that are connected to a repository. The job | ||
| 108 | type C<RETRY> retries an existing job. If the job type value is | ||
| 109 | C<RETRY>, the C<jobId> is also required. | ||
| 110 | |||
| 111 | Valid values are: C<"RELEASE">, C<"RETRY">, C<"MANUAL">, C<"WEB_HOOK"> | ||
| 112 | |||
| 113 | |||
| 114 | =head1 SEE ALSO | ||
| 115 | |||
| 116 | This class forms part of L<Paws>, documenting arguments for method StartJob in L<Paws::Amplify> | ||
| 117 | |||
| 118 | =head1 BUGS and CONTRIBUTIONS | ||
| 119 | |||
| 120 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 121 | |||
| 122 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 123 | |||
| 124 | =cut | ||
| 125 |