| 1 | package Paws::Transfer; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'transfer' } | ||
| 4 | sub signing_name { 'transfer' } | ||
| 5 | sub version { '2018-11-05' } | ||
| 6 | sub target_prefix { 'TransferService' } | ||
| 7 | sub json_version { "1.1" } | ||
| 8 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | ||
| 9 | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||
| 10 | { base => 'rand', type => 'exponential', growth_factor => 2 } | ||
| 11 | }); | ||
| 12 | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||
| 13 | ] }); | ||
| 14 | |||
| 15 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller'; | ||
| 16 | |||
| 17 | |||
| 18 | sub CreateAccess { | ||
| 19 | my $self = shift; | ||
| 20 | my $call_object = $self->new_with_coercions('Paws::Transfer::CreateAccess', @_); | ||
| 21 | return $self->caller->do_call($self, $call_object); | ||
| 22 | } | ||
| 23 | sub CreateServer { | ||
| 24 | my $self = shift; | ||
| 25 | my $call_object = $self->new_with_coercions('Paws::Transfer::CreateServer', @_); | ||
| 26 | return $self->caller->do_call($self, $call_object); | ||
| 27 | } | ||
| 28 | sub CreateUser { | ||
| 29 | my $self = shift; | ||
| 30 | my $call_object = $self->new_with_coercions('Paws::Transfer::CreateUser', @_); | ||
| 31 | return $self->caller->do_call($self, $call_object); | ||
| 32 | } | ||
| 33 | sub DeleteAccess { | ||
| 34 | my $self = shift; | ||
| 35 | my $call_object = $self->new_with_coercions('Paws::Transfer::DeleteAccess', @_); | ||
| 36 | return $self->caller->do_call($self, $call_object); | ||
| 37 | } | ||
| 38 | sub DeleteServer { | ||
| 39 | my $self = shift; | ||
| 40 | my $call_object = $self->new_with_coercions('Paws::Transfer::DeleteServer', @_); | ||
| 41 | return $self->caller->do_call($self, $call_object); | ||
| 42 | } | ||
| 43 | sub DeleteSshPublicKey { | ||
| 44 | my $self = shift; | ||
| 45 | my $call_object = $self->new_with_coercions('Paws::Transfer::DeleteSshPublicKey', @_); | ||
| 46 | return $self->caller->do_call($self, $call_object); | ||
| 47 | } | ||
| 48 | sub DeleteUser { | ||
| 49 | my $self = shift; | ||
| 50 | my $call_object = $self->new_with_coercions('Paws::Transfer::DeleteUser', @_); | ||
| 51 | return $self->caller->do_call($self, $call_object); | ||
| 52 | } | ||
| 53 | sub DescribeAccess { | ||
| 54 | my $self = shift; | ||
| 55 | my $call_object = $self->new_with_coercions('Paws::Transfer::DescribeAccess', @_); | ||
| 56 | return $self->caller->do_call($self, $call_object); | ||
| 57 | } | ||
| 58 | sub DescribeSecurityPolicy { | ||
| 59 | my $self = shift; | ||
| 60 | my $call_object = $self->new_with_coercions('Paws::Transfer::DescribeSecurityPolicy', @_); | ||
| 61 | return $self->caller->do_call($self, $call_object); | ||
| 62 | } | ||
| 63 | sub DescribeServer { | ||
| 64 | my $self = shift; | ||
| 65 | my $call_object = $self->new_with_coercions('Paws::Transfer::DescribeServer', @_); | ||
| 66 | return $self->caller->do_call($self, $call_object); | ||
| 67 | } | ||
| 68 | sub DescribeUser { | ||
| 69 | my $self = shift; | ||
| 70 | my $call_object = $self->new_with_coercions('Paws::Transfer::DescribeUser', @_); | ||
| 71 | return $self->caller->do_call($self, $call_object); | ||
| 72 | } | ||
| 73 | sub ImportSshPublicKey { | ||
| 74 | my $self = shift; | ||
| 75 | my $call_object = $self->new_with_coercions('Paws::Transfer::ImportSshPublicKey', @_); | ||
| 76 | return $self->caller->do_call($self, $call_object); | ||
| 77 | } | ||
| 78 | sub ListAccesses { | ||
| 79 | my $self = shift; | ||
| 80 | my $call_object = $self->new_with_coercions('Paws::Transfer::ListAccesses', @_); | ||
| 81 | return $self->caller->do_call($self, $call_object); | ||
| 82 | } | ||
| 83 | sub ListSecurityPolicies { | ||
| 84 | my $self = shift; | ||
| 85 | my $call_object = $self->new_with_coercions('Paws::Transfer::ListSecurityPolicies', @_); | ||
| 86 | return $self->caller->do_call($self, $call_object); | ||
| 87 | } | ||
| 88 | sub ListServers { | ||
| 89 | my $self = shift; | ||
| 90 | my $call_object = $self->new_with_coercions('Paws::Transfer::ListServers', @_); | ||
| 91 | return $self->caller->do_call($self, $call_object); | ||
| 92 | } | ||
| 93 | sub ListTagsForResource { | ||
| 94 | my $self = shift; | ||
| 95 | my $call_object = $self->new_with_coercions('Paws::Transfer::ListTagsForResource', @_); | ||
| 96 | return $self->caller->do_call($self, $call_object); | ||
| 97 | } | ||
| 98 | sub ListUsers { | ||
| 99 | my $self = shift; | ||
| 100 | my $call_object = $self->new_with_coercions('Paws::Transfer::ListUsers', @_); | ||
| 101 | return $self->caller->do_call($self, $call_object); | ||
| 102 | } | ||
| 103 | sub StartServer { | ||
| 104 | my $self = shift; | ||
| 105 | my $call_object = $self->new_with_coercions('Paws::Transfer::StartServer', @_); | ||
| 106 | return $self->caller->do_call($self, $call_object); | ||
| 107 | } | ||
| 108 | sub StopServer { | ||
| 109 | my $self = shift; | ||
| 110 | my $call_object = $self->new_with_coercions('Paws::Transfer::StopServer', @_); | ||
| 111 | return $self->caller->do_call($self, $call_object); | ||
| 112 | } | ||
| 113 | sub TagResource { | ||
| 114 | my $self = shift; | ||
| 115 | my $call_object = $self->new_with_coercions('Paws::Transfer::TagResource', @_); | ||
| 116 | return $self->caller->do_call($self, $call_object); | ||
| 117 | } | ||
| 118 | sub TestIdentityProvider { | ||
| 119 | my $self = shift; | ||
| 120 | my $call_object = $self->new_with_coercions('Paws::Transfer::TestIdentityProvider', @_); | ||
| 121 | return $self->caller->do_call($self, $call_object); | ||
| 122 | } | ||
| 123 | sub UntagResource { | ||
| 124 | my $self = shift; | ||
| 125 | my $call_object = $self->new_with_coercions('Paws::Transfer::UntagResource', @_); | ||
| 126 | return $self->caller->do_call($self, $call_object); | ||
| 127 | } | ||
| 128 | sub UpdateAccess { | ||
| 129 | my $self = shift; | ||
| 130 | my $call_object = $self->new_with_coercions('Paws::Transfer::UpdateAccess', @_); | ||
| 131 | return $self->caller->do_call($self, $call_object); | ||
| 132 | } | ||
| 133 | sub UpdateServer { | ||
| 134 | my $self = shift; | ||
| 135 | my $call_object = $self->new_with_coercions('Paws::Transfer::UpdateServer', @_); | ||
| 136 | return $self->caller->do_call($self, $call_object); | ||
| 137 | } | ||
| 138 | sub UpdateUser { | ||
| 139 | my $self = shift; | ||
| 140 | my $call_object = $self->new_with_coercions('Paws::Transfer::UpdateUser', @_); | ||
| 141 | return $self->caller->do_call($self, $call_object); | ||
| 142 | } | ||
| 143 | |||
| 144 | sub ListAllServers { | ||
| 145 | my $self = shift; | ||
| 146 | |||
| 147 | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||
| 148 | my $result = $self->ListServers(@_); | ||
| 149 | my $next_result = $result; | ||
| 150 | |||
| 151 | if (not defined $callback) { | ||
| 152 | while ($next_result->NextToken) { | ||
| 153 | $next_result = $self->ListServers(@_, NextToken => $next_result->NextToken); | ||
| 154 | push @{ $result->Servers }, @{ $next_result->Servers }; | ||
| 155 | } | ||
| 156 | return $result; | ||
| 157 | } else { | ||
| 158 | while ($result->NextToken) { | ||
| 159 | $callback->($_ => 'Servers') foreach (@{ $result->Servers }); | ||
| 160 | $result = $self->ListServers(@_, NextToken => $result->NextToken); | ||
| 161 | } | ||
| 162 | $callback->($_ => 'Servers') foreach (@{ $result->Servers }); | ||
| 163 | } | ||
| 164 | |||
| 165 | return undef | ||
| 166 | } | ||
| 167 | |||
| 168 | |||
| 169 | sub operations { qw/CreateAccess CreateServer CreateUser DeleteAccess DeleteServer DeleteSshPublicKey DeleteUser DescribeAccess DescribeSecurityPolicy DescribeServer DescribeUser ImportSshPublicKey ListAccesses ListSecurityPolicies ListServers ListTagsForResource ListUsers StartServer StopServer TagResource TestIdentityProvider UntagResource UpdateAccess UpdateServer UpdateUser / } | ||
| 170 | |||
| 171 | 1; | ||
| 172 | |||
| 173 | ### main pod documentation begin ### | ||
| 174 | |||
| 175 | =head1 NAME | ||
| 176 | |||
| 177 | Paws::Transfer - Perl Interface to AWS AWS Transfer Family | ||
| 178 | |||
| 179 | =head1 SYNOPSIS | ||
| 180 | |||
| 181 | use Paws; | ||
| 182 | |||
| 183 | my $obj = Paws->service('Transfer'); | ||
| 184 | my $res = $obj->Method( | ||
| 185 | Arg1 => $val1, | ||
| 186 | Arg2 => [ 'V1', 'V2' ], | ||
| 187 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 188 | # of the arguments type | ||
| 189 | Arg3 => { Att1 => 'Val1' }, | ||
| 190 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 191 | # the constructor of the arguments type | ||
| 192 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 193 | ); | ||
| 194 | |||
| 195 | =head1 DESCRIPTION | ||
| 196 | |||
| 197 | Amazon Web Services Transfer Family is a fully managed service that | ||
| 198 | enables the transfer of files over the File Transfer Protocol (FTP), | ||
| 199 | File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File | ||
| 200 | Transfer Protocol (SFTP) directly into and out of Amazon Simple Storage | ||
| 201 | Service (Amazon S3). Amazon Web Services helps you seamlessly migrate | ||
| 202 | your file transfer workflows to Amazon Web Services Transfer Family by | ||
| 203 | integrating with existing authentication systems, and providing DNS | ||
| 204 | routing with Amazon Route 53 so nothing changes for your customers and | ||
| 205 | partners, or their applications. With your data in Amazon S3, you can | ||
| 206 | use it with Amazon Web Services services for processing, analytics, | ||
| 207 | machine learning, and archiving. Getting started with Amazon Web | ||
| 208 | Services Transfer Family is easy since there is no infrastructure to | ||
| 209 | buy and set up. | ||
| 210 | |||
| 211 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05> | ||
| 212 | |||
| 213 | |||
| 214 | =head1 METHODS | ||
| 215 | |||
| 216 | =head2 CreateAccess | ||
| 217 | |||
| 218 | =over | ||
| 219 | |||
| 220 | =item ExternalId => Str | ||
| 221 | |||
| 222 | =item Role => Str | ||
| 223 | |||
| 224 | =item ServerId => Str | ||
| 225 | |||
| 226 | =item [HomeDirectory => Str] | ||
| 227 | |||
| 228 | =item [HomeDirectoryMappings => ArrayRef[L<Paws::Transfer::HomeDirectoryMapEntry>]] | ||
| 229 | |||
| 230 | =item [HomeDirectoryType => Str] | ||
| 231 | |||
| 232 | =item [Policy => Str] | ||
| 233 | |||
| 234 | =item [PosixProfile => L<Paws::Transfer::PosixProfile>] | ||
| 235 | |||
| 236 | |||
| 237 | =back | ||
| 238 | |||
| 239 | Each argument is described in detail in: L<Paws::Transfer::CreateAccess> | ||
| 240 | |||
| 241 | Returns: a L<Paws::Transfer::CreateAccessResponse> instance | ||
| 242 | |||
| 243 | Used by administrators to choose which groups in the directory should | ||
| 244 | have access to upload and download files over the enabled protocols | ||
| 245 | using Amazon Web Services Transfer Family. For example, a Microsoft | ||
| 246 | Active Directory might contain 50,000 users, but only a small fraction | ||
| 247 | might need the ability to transfer files to the server. An | ||
| 248 | administrator can use C<CreateAccess> to limit the access to the | ||
| 249 | correct set of users who need this ability. | ||
| 250 | |||
| 251 | |||
| 252 | =head2 CreateServer | ||
| 253 | |||
| 254 | =over | ||
| 255 | |||
| 256 | =item [Certificate => Str] | ||
| 257 | |||
| 258 | =item [Domain => Str] | ||
| 259 | |||
| 260 | =item [EndpointDetails => L<Paws::Transfer::EndpointDetails>] | ||
| 261 | |||
| 262 | =item [EndpointType => Str] | ||
| 263 | |||
| 264 | =item [HostKey => Str] | ||
| 265 | |||
| 266 | =item [IdentityProviderDetails => L<Paws::Transfer::IdentityProviderDetails>] | ||
| 267 | |||
| 268 | =item [IdentityProviderType => Str] | ||
| 269 | |||
| 270 | =item [LoggingRole => Str] | ||
| 271 | |||
| 272 | =item [Protocols => ArrayRef[Str|Undef]] | ||
| 273 | |||
| 274 | =item [SecurityPolicyName => Str] | ||
| 275 | |||
| 276 | =item [Tags => ArrayRef[L<Paws::Transfer::Tag>]] | ||
| 277 | |||
| 278 | |||
| 279 | =back | ||
| 280 | |||
| 281 | Each argument is described in detail in: L<Paws::Transfer::CreateServer> | ||
| 282 | |||
| 283 | Returns: a L<Paws::Transfer::CreateServerResponse> instance | ||
| 284 | |||
| 285 | Instantiates an auto-scaling virtual server based on the selected file | ||
| 286 | transfer protocol in Amazon Web Services. When you make updates to your | ||
| 287 | file transfer protocol-enabled server or when you work with users, use | ||
| 288 | the service-generated C<ServerId> property that is assigned to the | ||
| 289 | newly created server. | ||
| 290 | |||
| 291 | |||
| 292 | =head2 CreateUser | ||
| 293 | |||
| 294 | =over | ||
| 295 | |||
| 296 | =item Role => Str | ||
| 297 | |||
| 298 | =item ServerId => Str | ||
| 299 | |||
| 300 | =item UserName => Str | ||
| 301 | |||
| 302 | =item [HomeDirectory => Str] | ||
| 303 | |||
| 304 | =item [HomeDirectoryMappings => ArrayRef[L<Paws::Transfer::HomeDirectoryMapEntry>]] | ||
| 305 | |||
| 306 | =item [HomeDirectoryType => Str] | ||
| 307 | |||
| 308 | =item [Policy => Str] | ||
| 309 | |||
| 310 | =item [PosixProfile => L<Paws::Transfer::PosixProfile>] | ||
| 311 | |||
| 312 | =item [SshPublicKeyBody => Str] | ||
| 313 | |||
| 314 | =item [Tags => ArrayRef[L<Paws::Transfer::Tag>]] | ||
| 315 | |||
| 316 | |||
| 317 | =back | ||
| 318 | |||
| 319 | Each argument is described in detail in: L<Paws::Transfer::CreateUser> | ||
| 320 | |||
| 321 | Returns: a L<Paws::Transfer::CreateUserResponse> instance | ||
| 322 | |||
| 323 | Creates a user and associates them with an existing file transfer | ||
| 324 | protocol-enabled server. You can only create and associate users with | ||
| 325 | servers that have the C<IdentityProviderType> set to | ||
| 326 | C<SERVICE_MANAGED>. Using parameters for C<CreateUser>, you can specify | ||
| 327 | the user name, set the home directory, store the user's public key, and | ||
| 328 | assign the user's Amazon Web Services Identity and Access Management | ||
| 329 | (IAM) role. You can also optionally add a scope-down policy, and assign | ||
| 330 | metadata with tags that can be used to group and search for users. | ||
| 331 | |||
| 332 | |||
| 333 | =head2 DeleteAccess | ||
| 334 | |||
| 335 | =over | ||
| 336 | |||
| 337 | =item ExternalId => Str | ||
| 338 | |||
| 339 | =item ServerId => Str | ||
| 340 | |||
| 341 | |||
| 342 | =back | ||
| 343 | |||
| 344 | Each argument is described in detail in: L<Paws::Transfer::DeleteAccess> | ||
| 345 | |||
| 346 | Returns: nothing | ||
| 347 | |||
| 348 | Allows you to delete the access specified in the C<ServerID> and | ||
| 349 | C<ExternalID> parameters. | ||
| 350 | |||
| 351 | |||
| 352 | =head2 DeleteServer | ||
| 353 | |||
| 354 | =over | ||
| 355 | |||
| 356 | =item ServerId => Str | ||
| 357 | |||
| 358 | |||
| 359 | =back | ||
| 360 | |||
| 361 | Each argument is described in detail in: L<Paws::Transfer::DeleteServer> | ||
| 362 | |||
| 363 | Returns: nothing | ||
| 364 | |||
| 365 | Deletes the file transfer protocol-enabled server that you specify. | ||
| 366 | |||
| 367 | No response returns from this operation. | ||
| 368 | |||
| 369 | |||
| 370 | =head2 DeleteSshPublicKey | ||
| 371 | |||
| 372 | =over | ||
| 373 | |||
| 374 | =item ServerId => Str | ||
| 375 | |||
| 376 | =item SshPublicKeyId => Str | ||
| 377 | |||
| 378 | =item UserName => Str | ||
| 379 | |||
| 380 | |||
| 381 | =back | ||
| 382 | |||
| 383 | Each argument is described in detail in: L<Paws::Transfer::DeleteSshPublicKey> | ||
| 384 | |||
| 385 | Returns: nothing | ||
| 386 | |||
| 387 | Deletes a user's Secure Shell (SSH) public key. | ||
| 388 | |||
| 389 | No response is returned from this operation. | ||
| 390 | |||
| 391 | |||
| 392 | =head2 DeleteUser | ||
| 393 | |||
| 394 | =over | ||
| 395 | |||
| 396 | =item ServerId => Str | ||
| 397 | |||
| 398 | =item UserName => Str | ||
| 399 | |||
| 400 | |||
| 401 | =back | ||
| 402 | |||
| 403 | Each argument is described in detail in: L<Paws::Transfer::DeleteUser> | ||
| 404 | |||
| 405 | Returns: nothing | ||
| 406 | |||
| 407 | Deletes the user belonging to a file transfer protocol-enabled server | ||
| 408 | you specify. | ||
| 409 | |||
| 410 | No response returns from this operation. | ||
| 411 | |||
| 412 | When you delete a user from a server, the user's information is lost. | ||
| 413 | |||
| 414 | |||
| 415 | =head2 DescribeAccess | ||
| 416 | |||
| 417 | =over | ||
| 418 | |||
| 419 | =item ExternalId => Str | ||
| 420 | |||
| 421 | =item ServerId => Str | ||
| 422 | |||
| 423 | |||
| 424 | =back | ||
| 425 | |||
| 426 | Each argument is described in detail in: L<Paws::Transfer::DescribeAccess> | ||
| 427 | |||
| 428 | Returns: a L<Paws::Transfer::DescribeAccessResponse> instance | ||
| 429 | |||
| 430 | Describes the access that is assigned to the specific file transfer | ||
| 431 | protocol-enabled server, as identified by its C<ServerId> property and | ||
| 432 | its C<ExternalID>. | ||
| 433 | |||
| 434 | The response from this call returns the properties of the access that | ||
| 435 | is associated with the C<ServerId> value that was specified. | ||
| 436 | |||
| 437 | |||
| 438 | =head2 DescribeSecurityPolicy | ||
| 439 | |||
| 440 | =over | ||
| 441 | |||
| 442 | =item SecurityPolicyName => Str | ||
| 443 | |||
| 444 | |||
| 445 | =back | ||
| 446 | |||
| 447 | Each argument is described in detail in: L<Paws::Transfer::DescribeSecurityPolicy> | ||
| 448 | |||
| 449 | Returns: a L<Paws::Transfer::DescribeSecurityPolicyResponse> instance | ||
| 450 | |||
| 451 | Describes the security policy that is attached to your file transfer | ||
| 452 | protocol-enabled server. The response contains a description of the | ||
| 453 | security policy's properties. For more information about security | ||
| 454 | policies, see Working with security policies | ||
| 455 | (https://docs.aws.amazon.com/transfer/latest/userguide/security-policies.html). | ||
| 456 | |||
| 457 | |||
| 458 | =head2 DescribeServer | ||
| 459 | |||
| 460 | =over | ||
| 461 | |||
| 462 | =item ServerId => Str | ||
| 463 | |||
| 464 | |||
| 465 | =back | ||
| 466 | |||
| 467 | Each argument is described in detail in: L<Paws::Transfer::DescribeServer> | ||
| 468 | |||
| 469 | Returns: a L<Paws::Transfer::DescribeServerResponse> instance | ||
| 470 | |||
| 471 | Describes a file transfer protocol-enabled server that you specify by | ||
| 472 | passing the C<ServerId> parameter. | ||
| 473 | |||
| 474 | The response contains a description of a server's properties. When you | ||
| 475 | set C<EndpointType> to VPC, the response will contain the | ||
| 476 | C<EndpointDetails>. | ||
| 477 | |||
| 478 | |||
| 479 | =head2 DescribeUser | ||
| 480 | |||
| 481 | =over | ||
| 482 | |||
| 483 | =item ServerId => Str | ||
| 484 | |||
| 485 | =item UserName => Str | ||
| 486 | |||
| 487 | |||
| 488 | =back | ||
| 489 | |||
| 490 | Each argument is described in detail in: L<Paws::Transfer::DescribeUser> | ||
| 491 | |||
| 492 | Returns: a L<Paws::Transfer::DescribeUserResponse> instance | ||
| 493 | |||
| 494 | Describes the user assigned to the specific file transfer | ||
| 495 | protocol-enabled server, as identified by its C<ServerId> property. | ||
| 496 | |||
| 497 | The response from this call returns the properties of the user | ||
| 498 | associated with the C<ServerId> value that was specified. | ||
| 499 | |||
| 500 | |||
| 501 | =head2 ImportSshPublicKey | ||
| 502 | |||
| 503 | =over | ||
| 504 | |||
| 505 | =item ServerId => Str | ||
| 506 | |||
| 507 | =item SshPublicKeyBody => Str | ||
| 508 | |||
| 509 | =item UserName => Str | ||
| 510 | |||
| 511 | |||
| 512 | =back | ||
| 513 | |||
| 514 | Each argument is described in detail in: L<Paws::Transfer::ImportSshPublicKey> | ||
| 515 | |||
| 516 | Returns: a L<Paws::Transfer::ImportSshPublicKeyResponse> instance | ||
| 517 | |||
| 518 | Adds a Secure Shell (SSH) public key to a user account identified by a | ||
| 519 | C<UserName> value assigned to the specific file transfer | ||
| 520 | protocol-enabled server, identified by C<ServerId>. | ||
| 521 | |||
| 522 | The response returns the C<UserName> value, the C<ServerId> value, and | ||
| 523 | the name of the C<SshPublicKeyId>. | ||
| 524 | |||
| 525 | |||
| 526 | =head2 ListAccesses | ||
| 527 | |||
| 528 | =over | ||
| 529 | |||
| 530 | =item ServerId => Str | ||
| 531 | |||
| 532 | =item [MaxResults => Int] | ||
| 533 | |||
| 534 | =item [NextToken => Str] | ||
| 535 | |||
| 536 | |||
| 537 | =back | ||
| 538 | |||
| 539 | Each argument is described in detail in: L<Paws::Transfer::ListAccesses> | ||
| 540 | |||
| 541 | Returns: a L<Paws::Transfer::ListAccessesResponse> instance | ||
| 542 | |||
| 543 | Lists the details for all the accesses you have on your server. | ||
| 544 | |||
| 545 | |||
| 546 | =head2 ListSecurityPolicies | ||
| 547 | |||
| 548 | =over | ||
| 549 | |||
| 550 | =item [MaxResults => Int] | ||
| 551 | |||
| 552 | =item [NextToken => Str] | ||
| 553 | |||
| 554 | |||
| 555 | =back | ||
| 556 | |||
| 557 | Each argument is described in detail in: L<Paws::Transfer::ListSecurityPolicies> | ||
| 558 | |||
| 559 | Returns: a L<Paws::Transfer::ListSecurityPoliciesResponse> instance | ||
| 560 | |||
| 561 | Lists the security policies that are attached to your file transfer | ||
| 562 | protocol-enabled servers. | ||
| 563 | |||
| 564 | |||
| 565 | =head2 ListServers | ||
| 566 | |||
| 567 | =over | ||
| 568 | |||
| 569 | =item [MaxResults => Int] | ||
| 570 | |||
| 571 | =item [NextToken => Str] | ||
| 572 | |||
| 573 | |||
| 574 | =back | ||
| 575 | |||
| 576 | Each argument is described in detail in: L<Paws::Transfer::ListServers> | ||
| 577 | |||
| 578 | Returns: a L<Paws::Transfer::ListServersResponse> instance | ||
| 579 | |||
| 580 | Lists the file transfer protocol-enabled servers that are associated | ||
| 581 | with your Amazon Web Services account. | ||
| 582 | |||
| 583 | |||
| 584 | =head2 ListTagsForResource | ||
| 585 | |||
| 586 | =over | ||
| 587 | |||
| 588 | =item Arn => Str | ||
| 589 | |||
| 590 | =item [MaxResults => Int] | ||
| 591 | |||
| 592 | =item [NextToken => Str] | ||
| 593 | |||
| 594 | |||
| 595 | =back | ||
| 596 | |||
| 597 | Each argument is described in detail in: L<Paws::Transfer::ListTagsForResource> | ||
| 598 | |||
| 599 | Returns: a L<Paws::Transfer::ListTagsForResourceResponse> instance | ||
| 600 | |||
| 601 | Lists all of the tags associated with the Amazon Resource Name (ARN) | ||
| 602 | that you specify. The resource can be a user, server, or role. | ||
| 603 | |||
| 604 | |||
| 605 | =head2 ListUsers | ||
| 606 | |||
| 607 | =over | ||
| 608 | |||
| 609 | =item ServerId => Str | ||
| 610 | |||
| 611 | =item [MaxResults => Int] | ||
| 612 | |||
| 613 | =item [NextToken => Str] | ||
| 614 | |||
| 615 | |||
| 616 | =back | ||
| 617 | |||
| 618 | Each argument is described in detail in: L<Paws::Transfer::ListUsers> | ||
| 619 | |||
| 620 | Returns: a L<Paws::Transfer::ListUsersResponse> instance | ||
| 621 | |||
| 622 | Lists the users for a file transfer protocol-enabled server that you | ||
| 623 | specify by passing the C<ServerId> parameter. | ||
| 624 | |||
| 625 | |||
| 626 | =head2 StartServer | ||
| 627 | |||
| 628 | =over | ||
| 629 | |||
| 630 | =item ServerId => Str | ||
| 631 | |||
| 632 | |||
| 633 | =back | ||
| 634 | |||
| 635 | Each argument is described in detail in: L<Paws::Transfer::StartServer> | ||
| 636 | |||
| 637 | Returns: nothing | ||
| 638 | |||
| 639 | Changes the state of a file transfer protocol-enabled server from | ||
| 640 | C<OFFLINE> to C<ONLINE>. It has no impact on a server that is already | ||
| 641 | C<ONLINE>. An C<ONLINE> server can accept and process file transfer | ||
| 642 | jobs. | ||
| 643 | |||
| 644 | The state of C<STARTING> indicates that the server is in an | ||
| 645 | intermediate state, either not fully able to respond, or not fully | ||
| 646 | online. The values of C<START_FAILED> can indicate an error condition. | ||
| 647 | |||
| 648 | No response is returned from this call. | ||
| 649 | |||
| 650 | |||
| 651 | =head2 StopServer | ||
| 652 | |||
| 653 | =over | ||
| 654 | |||
| 655 | =item ServerId => Str | ||
| 656 | |||
| 657 | |||
| 658 | =back | ||
| 659 | |||
| 660 | Each argument is described in detail in: L<Paws::Transfer::StopServer> | ||
| 661 | |||
| 662 | Returns: nothing | ||
| 663 | |||
| 664 | Changes the state of a file transfer protocol-enabled server from | ||
| 665 | C<ONLINE> to C<OFFLINE>. An C<OFFLINE> server cannot accept and process | ||
| 666 | file transfer jobs. Information tied to your server, such as server and | ||
| 667 | user properties, are not affected by stopping your server. | ||
| 668 | |||
| 669 | Stopping the server will not reduce or impact your file transfer | ||
| 670 | protocol endpoint billing; you must delete the server to stop being | ||
| 671 | billed. | ||
| 672 | |||
| 673 | The state of C<STOPPING> indicates that the server is in an | ||
| 674 | intermediate state, either not fully able to respond, or not fully | ||
| 675 | offline. The values of C<STOP_FAILED> can indicate an error condition. | ||
| 676 | |||
| 677 | No response is returned from this call. | ||
| 678 | |||
| 679 | |||
| 680 | =head2 TagResource | ||
| 681 | |||
| 682 | =over | ||
| 683 | |||
| 684 | =item Arn => Str | ||
| 685 | |||
| 686 | =item Tags => ArrayRef[L<Paws::Transfer::Tag>] | ||
| 687 | |||
| 688 | |||
| 689 | =back | ||
| 690 | |||
| 691 | Each argument is described in detail in: L<Paws::Transfer::TagResource> | ||
| 692 | |||
| 693 | Returns: nothing | ||
| 694 | |||
| 695 | Attaches a key-value pair to a resource, as identified by its Amazon | ||
| 696 | Resource Name (ARN). Resources are users, servers, roles, and other | ||
| 697 | entities. | ||
| 698 | |||
| 699 | There is no response returned from this call. | ||
| 700 | |||
| 701 | |||
| 702 | =head2 TestIdentityProvider | ||
| 703 | |||
| 704 | =over | ||
| 705 | |||
| 706 | =item ServerId => Str | ||
| 707 | |||
| 708 | =item UserName => Str | ||
| 709 | |||
| 710 | =item [ServerProtocol => Str] | ||
| 711 | |||
| 712 | =item [SourceIp => Str] | ||
| 713 | |||
| 714 | =item [UserPassword => Str] | ||
| 715 | |||
| 716 | |||
| 717 | =back | ||
| 718 | |||
| 719 | Each argument is described in detail in: L<Paws::Transfer::TestIdentityProvider> | ||
| 720 | |||
| 721 | Returns: a L<Paws::Transfer::TestIdentityProviderResponse> instance | ||
| 722 | |||
| 723 | If the C<IdentityProviderType> of a file transfer protocol-enabled | ||
| 724 | server is C<AWS_DIRECTORY_SERVICE> or C<API_Gateway>, tests whether | ||
| 725 | your identity provider is set up successfully. We highly recommend that | ||
| 726 | you call this operation to test your authentication method as soon as | ||
| 727 | you create your server. By doing so, you can troubleshoot issues with | ||
| 728 | the identity provider integration to ensure that your users can | ||
| 729 | successfully use the service. | ||
| 730 | |||
| 731 | |||
| 732 | =head2 UntagResource | ||
| 733 | |||
| 734 | =over | ||
| 735 | |||
| 736 | =item Arn => Str | ||
| 737 | |||
| 738 | =item TagKeys => ArrayRef[Str|Undef] | ||
| 739 | |||
| 740 | |||
| 741 | =back | ||
| 742 | |||
| 743 | Each argument is described in detail in: L<Paws::Transfer::UntagResource> | ||
| 744 | |||
| 745 | Returns: nothing | ||
| 746 | |||
| 747 | Detaches a key-value pair from a resource, as identified by its Amazon | ||
| 748 | Resource Name (ARN). Resources are users, servers, roles, and other | ||
| 749 | entities. | ||
| 750 | |||
| 751 | No response is returned from this call. | ||
| 752 | |||
| 753 | |||
| 754 | =head2 UpdateAccess | ||
| 755 | |||
| 756 | =over | ||
| 757 | |||
| 758 | =item ExternalId => Str | ||
| 759 | |||
| 760 | =item ServerId => Str | ||
| 761 | |||
| 762 | =item [HomeDirectory => Str] | ||
| 763 | |||
| 764 | =item [HomeDirectoryMappings => ArrayRef[L<Paws::Transfer::HomeDirectoryMapEntry>]] | ||
| 765 | |||
| 766 | =item [HomeDirectoryType => Str] | ||
| 767 | |||
| 768 | =item [Policy => Str] | ||
| 769 | |||
| 770 | =item [PosixProfile => L<Paws::Transfer::PosixProfile>] | ||
| 771 | |||
| 772 | =item [Role => Str] | ||
| 773 | |||
| 774 | |||
| 775 | =back | ||
| 776 | |||
| 777 | Each argument is described in detail in: L<Paws::Transfer::UpdateAccess> | ||
| 778 | |||
| 779 | Returns: a L<Paws::Transfer::UpdateAccessResponse> instance | ||
| 780 | |||
| 781 | Allows you to update parameters for the access specified in the | ||
| 782 | C<ServerID> and C<ExternalID> parameters. | ||
| 783 | |||
| 784 | |||
| 785 | =head2 UpdateServer | ||
| 786 | |||
| 787 | =over | ||
| 788 | |||
| 789 | =item ServerId => Str | ||
| 790 | |||
| 791 | =item [Certificate => Str] | ||
| 792 | |||
| 793 | =item [EndpointDetails => L<Paws::Transfer::EndpointDetails>] | ||
| 794 | |||
| 795 | =item [EndpointType => Str] | ||
| 796 | |||
| 797 | =item [HostKey => Str] | ||
| 798 | |||
| 799 | =item [IdentityProviderDetails => L<Paws::Transfer::IdentityProviderDetails>] | ||
| 800 | |||
| 801 | =item [LoggingRole => Str] | ||
| 802 | |||
| 803 | =item [ProtocolDetails => L<Paws::Transfer::ProtocolDetails>] | ||
| 804 | |||
| 805 | =item [Protocols => ArrayRef[Str|Undef]] | ||
| 806 | |||
| 807 | =item [SecurityPolicyName => Str] | ||
| 808 | |||
| 809 | |||
| 810 | =back | ||
| 811 | |||
| 812 | Each argument is described in detail in: L<Paws::Transfer::UpdateServer> | ||
| 813 | |||
| 814 | Returns: a L<Paws::Transfer::UpdateServerResponse> instance | ||
| 815 | |||
| 816 | Updates the file transfer protocol-enabled server's properties after | ||
| 817 | that server has been created. | ||
| 818 | |||
| 819 | The C<UpdateServer> call returns the C<ServerId> of the server you | ||
| 820 | updated. | ||
| 821 | |||
| 822 | |||
| 823 | =head2 UpdateUser | ||
| 824 | |||
| 825 | =over | ||
| 826 | |||
| 827 | =item ServerId => Str | ||
| 828 | |||
| 829 | =item UserName => Str | ||
| 830 | |||
| 831 | =item [HomeDirectory => Str] | ||
| 832 | |||
| 833 | =item [HomeDirectoryMappings => ArrayRef[L<Paws::Transfer::HomeDirectoryMapEntry>]] | ||
| 834 | |||
| 835 | =item [HomeDirectoryType => Str] | ||
| 836 | |||
| 837 | =item [Policy => Str] | ||
| 838 | |||
| 839 | =item [PosixProfile => L<Paws::Transfer::PosixProfile>] | ||
| 840 | |||
| 841 | =item [Role => Str] | ||
| 842 | |||
| 843 | |||
| 844 | =back | ||
| 845 | |||
| 846 | Each argument is described in detail in: L<Paws::Transfer::UpdateUser> | ||
| 847 | |||
| 848 | Returns: a L<Paws::Transfer::UpdateUserResponse> instance | ||
| 849 | |||
| 850 | Assigns new properties to a user. Parameters you pass modify any or all | ||
| 851 | of the following: the home directory, role, and policy for the | ||
| 852 | C<UserName> and C<ServerId> you specify. | ||
| 853 | |||
| 854 | The response returns the C<ServerId> and the C<UserName> for the | ||
| 855 | updated user. | ||
| 856 | |||
| 857 | |||
| 858 | |||
| 859 | |||
| 860 | =head1 PAGINATORS | ||
| 861 | |||
| 862 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 863 | |||
| 864 | =head2 ListAllServers(sub { },[MaxResults => Int, NextToken => Str]) | ||
| 865 | |||
| 866 | =head2 ListAllServers([MaxResults => Int, NextToken => Str]) | ||
| 867 | |||
| 868 | |||
| 869 | If passed a sub as first parameter, it will call the sub for each element found in : | ||
| 870 | |||
| 871 | - Servers, passing the object as the first parameter, and the string 'Servers' as the second parameter | ||
| 872 | |||
| 873 | If not, it will return a a L<Paws::Transfer::ListServersResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||
| 874 | |||
| 875 | |||
| 876 | |||
| 877 | |||
| 878 | |||
| 879 | =head1 SEE ALSO | ||
| 880 | |||
| 881 | This service class forms part of L<Paws> | ||
| 882 | |||
| 883 | =head1 BUGS and CONTRIBUTIONS | ||
| 884 | |||
| 885 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 886 | |||
| 887 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 888 | |||
| 889 | =cut | ||
| 890 |