AWS SDK for PHP
  • Namespace
  • Class
  • Tree
  • Download

Namespaces

  • Aws
    • AutoScaling
      • Enum
      • Exception
    • CloudFormation
      • Enum
      • Exception
    • CloudFront
      • Enum
      • Exception
    • CloudFront_2012_05_05
    • CloudHsm
      • Exception
    • CloudSearch
      • Enum
      • Exception
    • CloudSearch_2011_02_01
    • CloudSearchDomain
      • Exception
    • CloudTrail
      • Exception
    • CloudWatch
      • Enum
      • Exception
    • CloudWatchLogs
      • Exception
    • CodeCommit
      • Exception
    • CodeDeploy
      • Exception
    • CodePipeline
      • Exception
    • CognitoIdentity
      • Exception
    • CognitoSync
      • Exception
    • Common
      • Client
      • Command
      • Credentials
      • Enum
      • Exception
        • Parser
      • Hash
      • InstanceMetadata
        • Waiter
      • Iterator
      • Model
        • MultipartUpload
      • Signature
      • Waiter
    • ConfigService
      • Exception
    • DataPipeline
      • Enum
      • Exception
    • DeviceFarm
      • Exception
    • DirectConnect
      • Enum
      • Exception
    • DirectoryService
      • Exception
    • DynamoDb
      • Enum
      • Exception
      • Model
        • BatchRequest
      • Session
        • LockingStrategy
    • DynamoDb_2011_12_05
    • DynamoDbStreams
      • Exception
    • Ec2
      • Enum
      • Exception
      • Iterator
    • Ecs
      • Exception
    • Efs
      • Exception
    • ElastiCache
      • Enum
      • Exception
    • ElasticBeanstalk
      • Enum
      • Exception
    • ElasticFileSystem
    • ElasticLoadBalancing
      • Exception
    • ElasticTranscoder
      • Exception
    • Emr
      • Enum
      • Exception
    • Glacier
      • Enum
      • Exception
      • Model
        • MultipartUpload
    • Iam
      • Enum
      • Exception
    • ImportExport
      • Enum
      • Exception
    • Kinesis
      • Enum
      • Exception
    • Kms
      • Exception
    • Lambda
      • Exception
    • MachineLearning
      • Exception
    • OpsWorks
      • Enum
      • Exception
    • Rds
      • Enum
      • Exception
    • Redshift
      • Enum
      • Exception
    • Route53
      • Enum
      • Exception
    • Route53Domains
      • Exception
    • S3
      • Command
      • Enum
      • Exception
        • Parser
      • Iterator
      • Model
        • MultipartUpload
      • Sync
    • Ses
      • Enum
      • Exception
    • SimpleDb
      • Exception
    • Sns
      • Exception
      • MessageValidator
        • Exception
    • Sqs
      • Enum
      • Exception
    • Ssm
      • Exception
    • StorageGateway
      • Enum
      • Exception
    • Sts
      • Exception
    • Support
      • Exception
    • Swf
      • Enum
      • Exception
    • WorkSpaces
      • Exception
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP

Classes

  • AbstractTransfer
  • AbstractTransferState
  • AbstractUploadBuilder
  • AbstractUploadId
  • AbstractUploadPart

Interfaces

  • TransferInterface
  • TransferStateInterface
  • UploadIdInterface
  • UploadPartInterface
NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

Interface TransferInterface

Interface for transferring the contents of a data source to an AWS service via a multipart upload interface

Aws\Common\Model\MultipartUpload\TransferInterface implements Guzzle\Common\HasDispatcherInterface

Direct known implementers

Aws\Common\Model\MultipartUpload\AbstractTransfer

Indirect known implementers

Aws\Glacier\Model\MultipartUpload\AbstractTransfer, Aws\Glacier\Model\MultipartUpload\ParallelTransfer, Aws\Glacier\Model\MultipartUpload\SerialTransfer, Aws\S3\Model\MultipartUpload\AbstractTransfer, Aws\S3\Model\MultipartUpload\ParallelTransfer, Aws\S3\Model\MultipartUpload\SerialTransfer

Namespace: Aws\Common\Model\MultipartUpload
Located at Aws/Common/Model/MultipartUpload/TransferInterface.php

Methods summary

  • public upload ( )

    Upload the source to using a multipart upload

  • public abort ( )

    Abort the upload

  • public getState ( )

    Get the current state of the upload

  • public stop ( )

    Stop the transfer and retrieve the current state.

  • public setOption ( string $option, mixed $value )

    Set an option on the transfer object

Methods detail

# public Guzzle\Service\Resource\Model|null
upload( )

Upload the source to using a multipart upload

Returns

Guzzle\Service\Resource\Model|null
Result of the complete multipart upload command or null if uploading was stopped
# public Guzzle\Service\Resource\Model
abort( )

Abort the upload

Returns

Guzzle\Service\Resource\Model
Returns the result of the abort multipart upload command
# public Aws\Common\Model\MultipartUpload\TransferStateInterface
getState( )

Get the current state of the upload

Returns

Aws\Common\Model\MultipartUpload\TransferStateInterface
# public Aws\Common\Model\MultipartUpload\TransferStateInterface
stop( )

Stop the transfer and retrieve the current state.

This allows you to stop and later resume a long running transfer if needed.

Returns

Aws\Common\Model\MultipartUpload\TransferStateInterface
# public Aws\Common\Model\MultipartUpload\TransferInterface
setOption( string $option, mixed $value )

Set an option on the transfer object

Parameters

$option
string
$option Option to set
$value
mixed
$value The value to set

Returns

Aws\Common\Model\MultipartUpload\TransferInterface

Methods inherited from Guzzle\Common\HasDispatcherInterface

addSubscriber(), dispatch(), getAllEvents(), getEventDispatcher(), setEventDispatcher()

Magic methods summary

AWS SDK for PHP API documentation generated by ApiGen 2.8.0
June sale

45%

off sitewide

June sale — 45% off at checkout, applied automatically. Valid for 60 minutes. One per customer.

Offer ends in

60:00
45% Jun 60:00