Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DataSync.DescribeLocationS3

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns metadata, such as bucket name, about an Amazon S3 bucket location.

Synopsis

data DescribeLocationS3 = DescribeLocationS3' {
- locationArn :: Text
}
newDescribeLocationS3 :: Text -> DescribeLocationS3
describeLocationS3_locationArn :: Lens' DescribeLocationS3 Text
data DescribeLocationS3Response = DescribeLocationS3Response' {
- creationTime :: Maybe POSIX
- agentArns :: Maybe (NonEmpty Text)
- s3StorageClass :: Maybe S3StorageClass
- locationUri :: Maybe Text
- s3Config :: Maybe S3Config
- locationArn :: Maybe Text
- httpStatus :: Int
}
newDescribeLocationS3Response :: Int -> DescribeLocationS3Response
describeLocationS3Response_creationTime :: Lens' DescribeLocationS3Response (Maybe UTCTime)
describeLocationS3Response_agentArns :: Lens' DescribeLocationS3Response (Maybe (NonEmpty Text))
describeLocationS3Response_s3StorageClass :: Lens' DescribeLocationS3Response (Maybe S3StorageClass)
describeLocationS3Response_locationUri :: Lens' DescribeLocationS3Response (Maybe Text)
describeLocationS3Response_s3Config :: Lens' DescribeLocationS3Response (Maybe S3Config)
describeLocationS3Response_locationArn :: Lens' DescribeLocationS3Response (Maybe Text)
describeLocationS3Response_httpStatus :: Lens' DescribeLocationS3Response Int

Creating a Request

data DescribeLocationS3 Source #

DescribeLocationS3Request

See: newDescribeLocationS3 smart constructor.

Constructors

DescribeLocationS3'
Fields locationArn :: Text The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.

Instances

Instances details

Eq DescribeLocationS3 Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 Methods (==) :: DescribeLocationS3 -> DescribeLocationS3 -> Bool # (/=) :: DescribeLocationS3 -> DescribeLocationS3 -> Bool #
Read DescribeLocationS3 Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 Methods readsPrec :: Int -> ReadS DescribeLocationS3 # readList :: ReadS [DescribeLocationS3] # readPrec :: ReadPrec DescribeLocationS3 # readListPrec :: ReadPrec [DescribeLocationS3] #
Show DescribeLocationS3 Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 Methods showsPrec :: Int -> DescribeLocationS3 -> ShowS # show :: DescribeLocationS3 -> String # showList :: [DescribeLocationS3] -> ShowS #
Generic DescribeLocationS3 Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 Associated Types type Rep DescribeLocationS3 :: Type -> Type # Methods from :: DescribeLocationS3 -> Rep DescribeLocationS3 x # to :: Rep DescribeLocationS3 x -> DescribeLocationS3 #
NFData DescribeLocationS3 Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 Methods rnf :: DescribeLocationS3 -> () #
Hashable DescribeLocationS3 Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 Methods hashWithSalt :: Int -> DescribeLocationS3 -> Int # hash :: DescribeLocationS3 -> Int #
ToJSON DescribeLocationS3 Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 Methods toJSON :: DescribeLocationS3 -> Value # toEncoding :: DescribeLocationS3 -> Encoding # toJSONList :: [DescribeLocationS3] -> Value # toEncodingList :: [DescribeLocationS3] -> Encoding #
AWSRequest DescribeLocationS3 Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 Associated Types type AWSResponse DescribeLocationS3 # Methods request :: DescribeLocationS3 -> Request DescribeLocationS3 # response :: MonadResource m => Logger -> Service -> Proxy DescribeLocationS3 -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeLocationS3))) #
ToHeaders DescribeLocationS3 Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 Methods toHeaders :: DescribeLocationS3 -> [Header] #
ToPath DescribeLocationS3 Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 Methods toPath :: DescribeLocationS3 -> ByteString #
ToQuery DescribeLocationS3 Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 Methods toQuery :: DescribeLocationS3 -> QueryString #
type Rep DescribeLocationS3 Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 type Rep DescribeLocationS3 = D1 ('MetaData "DescribeLocationS3" "Amazonka.DataSync.DescribeLocationS3" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "DescribeLocationS3'" 'PrefixI 'True) (S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeLocationS3 Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 type AWSResponse DescribeLocationS3 = DescribeLocationS3Response

newDescribeLocationS3 Source #

Arguments

:: Text	`$sel:locationArn:DescribeLocationS3'`
-> DescribeLocationS3

Create a value of DescribeLocationS3 with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:locationArn:DescribeLocationS3', describeLocationS3_locationArn - The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.

Request Lenses

describeLocationS3_locationArn :: Lens' DescribeLocationS3 Text Source #

The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.

Destructuring the Response

data DescribeLocationS3Response Source #

DescribeLocationS3Response

See: newDescribeLocationS3Response smart constructor.

Constructors

DescribeLocationS3Response'

Fields

creationTime :: Maybe POSIX
The time that the Amazon S3 bucket location was created.
agentArns :: Maybe (NonEmpty Text)
If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name (ARNs) of the EC2 agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.
s3StorageClass :: Maybe S3StorageClass
The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.
locationUri :: Maybe Text
The URL of the Amazon S3 location that was described.
s3Config :: Maybe S3Config
locationArn :: Maybe Text
The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeLocationS3Response Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 Methods (==) :: DescribeLocationS3Response -> DescribeLocationS3Response -> Bool # (/=) :: DescribeLocationS3Response -> DescribeLocationS3Response -> Bool #
Read DescribeLocationS3Response Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 Methods readsPrec :: Int -> ReadS DescribeLocationS3Response # readList :: ReadS [DescribeLocationS3Response] # readPrec :: ReadPrec DescribeLocationS3Response # readListPrec :: ReadPrec [DescribeLocationS3Response] #
Show DescribeLocationS3Response Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 Methods showsPrec :: Int -> DescribeLocationS3Response -> ShowS # show :: DescribeLocationS3Response -> String # showList :: [DescribeLocationS3Response] -> ShowS #
Generic DescribeLocationS3Response Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 Associated Types type Rep DescribeLocationS3Response :: Type -> Type # Methods from :: DescribeLocationS3Response -> Rep DescribeLocationS3Response x # to :: Rep DescribeLocationS3Response x -> DescribeLocationS3Response #
NFData DescribeLocationS3Response Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 Methods rnf :: DescribeLocationS3Response -> () #
type Rep DescribeLocationS3Response Source #
Instance details Defined in Amazonka.DataSync.DescribeLocationS3 type Rep DescribeLocationS3Response = D1 ('MetaData "DescribeLocationS3Response" "Amazonka.DataSync.DescribeLocationS3" "libZSservicesZSamazonka-datasyncZSamazonka-datasync" 'False) (C1 ('MetaCons "DescribeLocationS3Response'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "agentArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: S1 ('MetaSel ('Just "s3StorageClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3StorageClass)))) :: ((S1 ('MetaSel ('Just "locationUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "s3Config") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Config))) :: (S1 ('MetaSel ('Just "locationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeLocationS3Response Source #

Arguments

:: Int	`$sel:httpStatus:DescribeLocationS3Response'`
-> DescribeLocationS3Response

Create a value of DescribeLocationS3Response with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationTime:DescribeLocationS3Response', describeLocationS3Response_creationTime - The time that the Amazon S3 bucket location was created.

$sel:agentArns:DescribeLocationS3Response', describeLocationS3Response_agentArns - If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name (ARNs) of the EC2 agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

$sel:s3StorageClass:DescribeLocationS3Response', describeLocationS3Response_s3StorageClass - The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

$sel:locationUri:DescribeLocationS3Response', describeLocationS3Response_locationUri - The URL of the Amazon S3 location that was described.

$sel:s3Config:DescribeLocationS3Response', describeLocationS3Response_s3Config - Undocumented member.

$sel:locationArn:DescribeLocationS3', describeLocationS3Response_locationArn - The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.

$sel:httpStatus:DescribeLocationS3Response', describeLocationS3Response_httpStatus - The response's http status code.

Response Lenses

describeLocationS3Response_creationTime :: Lens' DescribeLocationS3Response (Maybe UTCTime) Source #

The time that the Amazon S3 bucket location was created.

describeLocationS3Response_agentArns :: Lens' DescribeLocationS3Response (Maybe (NonEmpty Text)) Source #

If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource Name (ARNs) of the EC2 agents deployed on your Outpost. For more information about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy your DataSync agent on Outposts.

describeLocationS3Response_s3StorageClass :: Lens' DescribeLocationS3Response (Maybe S3StorageClass) Source #

The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see Considerations when working with S3 storage classes in DataSync.

describeLocationS3Response_locationUri :: Lens' DescribeLocationS3Response (Maybe Text) Source #

The URL of the Amazon S3 location that was described.

describeLocationS3Response_s3Config :: Lens' DescribeLocationS3Response (Maybe S3Config) Source #

Undocumented member.

describeLocationS3Response_locationArn :: Lens' DescribeLocationS3Response (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.

describeLocationS3Response_httpStatus :: Lens' DescribeLocationS3Response Int Source #

The response's http status code.