« blib/lib/Paws/LexModels/SlotTypeRegexConfiguration.pm
↑ Summary
blib/lib/Paws/LexModels/StartImportResponse.pm »
| 1 | |||
| 2 | package Paws::LexModels::StartImport; | ||
| 3 | use Moose; | ||
| 4 | has MergeStrategy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'mergeStrategy', required => 1); | ||
| 5 | has Payload => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'payload', required => 1); | ||
| 6 | has ResourceType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'resourceType', required => 1); | ||
| 7 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::LexModels::Tag]', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartImport'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/imports/'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::LexModels::StartImportResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::LexModels::StartImport - Arguments for method StartImport on L<Paws::LexModels> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method StartImport on the | ||
| 26 | L<Amazon Lex Model Building Service|Paws::LexModels> service. Use the attributes of this class | ||
| 27 | as arguments to method StartImport. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartImport. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $models.lex = Paws->service('LexModels'); | ||
| 34 | my $StartImportResponse = $models . lex->StartImport( | ||
| 35 | MergeStrategy => 'OVERWRITE_LATEST', | ||
| 36 | Payload => 'BlobBlob', | ||
| 37 | ResourceType => 'BOT', | ||
| 38 | Tags => [ | ||
| 39 | { | ||
| 40 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 41 | Value => 'MyTagValue', # max: 256 | ||
| 42 | |||
| 43 | }, | ||
| 44 | ... | ||
| 45 | ], # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $CreatedDate = $StartImportResponse->CreatedDate; | ||
| 50 | my $ImportId = $StartImportResponse->ImportId; | ||
| 51 | my $ImportStatus = $StartImportResponse->ImportStatus; | ||
| 52 | my $MergeStrategy = $StartImportResponse->MergeStrategy; | ||
| 53 | my $Name = $StartImportResponse->Name; | ||
| 54 | my $ResourceType = $StartImportResponse->ResourceType; | ||
| 55 | my $Tags = $StartImportResponse->Tags; | ||
| 56 | |||
| 57 | # Returns a L<Paws::LexModels::StartImportResponse> object. | ||
| 58 | |||
| 59 | 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. | ||
| 60 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/models.lex/StartImport> | ||
| 61 | |||
| 62 | =head1 ATTRIBUTES | ||
| 63 | |||
| 64 | |||
| 65 | =head2 B<REQUIRED> MergeStrategy => Str | ||
| 66 | |||
| 67 | Specifies the action that the C<StartImport> operation should take when | ||
| 68 | there is an existing resource with the same name. | ||
| 69 | |||
| 70 | =over | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | FAIL_ON_CONFLICT - The import operation is stopped on the first | ||
| 75 | conflict between a resource in the import file and an existing | ||
| 76 | resource. The name of the resource causing the conflict is in the | ||
| 77 | C<failureReason> field of the response to the C<GetImport> operation. | ||
| 78 | |||
| 79 | OVERWRITE_LATEST - The import operation proceeds even if there is a | ||
| 80 | conflict with an existing resource. The $LASTEST version of the | ||
| 81 | existing resource is overwritten with the data from the import file. | ||
| 82 | |||
| 83 | =back | ||
| 84 | |||
| 85 | |||
| 86 | Valid values are: C<"OVERWRITE_LATEST">, C<"FAIL_ON_CONFLICT"> | ||
| 87 | |||
| 88 | =head2 B<REQUIRED> Payload => Str | ||
| 89 | |||
| 90 | A zip archive in binary format. The archive should contain one file, a | ||
| 91 | JSON file containing the resource to import. The resource should match | ||
| 92 | the type specified in the C<resourceType> field. | ||
| 93 | |||
| 94 | |||
| 95 | |||
| 96 | =head2 B<REQUIRED> ResourceType => Str | ||
| 97 | |||
| 98 | Specifies the type of resource to export. Each resource also exports | ||
| 99 | any resources that it depends on. | ||
| 100 | |||
| 101 | =over | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | A bot exports dependent intents. | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | An intent exports dependent slot types. | ||
| 110 | |||
| 111 | =back | ||
| 112 | |||
| 113 | |||
| 114 | Valid values are: C<"BOT">, C<"INTENT">, C<"SLOT_TYPE"> | ||
| 115 | |||
| 116 | =head2 Tags => ArrayRef[L<Paws::LexModels::Tag>] | ||
| 117 | |||
| 118 | A list of tags to add to the imported bot. You can only add tags when | ||
| 119 | you import a bot, you can't add tags to an intent or slot type. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head1 SEE ALSO | ||
| 125 | |||
| 126 | This class forms part of L<Paws>, documenting arguments for method StartImport in L<Paws::LexModels> | ||
| 127 | |||
| 128 | =head1 BUGS and CONTRIBUTIONS | ||
| 129 | |||
| 130 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 131 | |||
| 132 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 133 | |||
| 134 | =cut | ||
| 135 |