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.IoTThingsGraph.GetUploadStatus

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the status of the specified upload.

Synopsis

data GetUploadStatus = GetUploadStatus' {
- uploadId :: Text
}
newGetUploadStatus :: Text -> GetUploadStatus
getUploadStatus_uploadId :: Lens' GetUploadStatus Text
data GetUploadStatusResponse = GetUploadStatusResponse' {
- failureReason :: Maybe [Text]
- namespaceArn :: Maybe Text
- namespaceVersion :: Maybe Integer
- namespaceName :: Maybe Text
- httpStatus :: Int
- uploadId :: Text
- uploadStatus :: UploadStatus
- createdDate :: POSIX
}
newGetUploadStatusResponse :: Int -> Text -> UploadStatus -> UTCTime -> GetUploadStatusResponse
getUploadStatusResponse_failureReason :: Lens' GetUploadStatusResponse (Maybe [Text])
getUploadStatusResponse_namespaceArn :: Lens' GetUploadStatusResponse (Maybe Text)
getUploadStatusResponse_namespaceVersion :: Lens' GetUploadStatusResponse (Maybe Integer)
getUploadStatusResponse_namespaceName :: Lens' GetUploadStatusResponse (Maybe Text)
getUploadStatusResponse_httpStatus :: Lens' GetUploadStatusResponse Int
getUploadStatusResponse_uploadId :: Lens' GetUploadStatusResponse Text
getUploadStatusResponse_uploadStatus :: Lens' GetUploadStatusResponse UploadStatus
getUploadStatusResponse_createdDate :: Lens' GetUploadStatusResponse UTCTime

Creating a Request

data GetUploadStatus Source #

See: newGetUploadStatus smart constructor.

Constructors

GetUploadStatus'
Fields uploadId :: Text The ID of the upload. This value is returned by the `UploadEntityDefinitions` action.

Instances

Instances details

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

newGetUploadStatus Source #

Arguments

:: Text	`$sel:uploadId:GetUploadStatus'`
-> GetUploadStatus

Create a value of GetUploadStatus 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:uploadId:GetUploadStatus', getUploadStatus_uploadId - The ID of the upload. This value is returned by the UploadEntityDefinitions action.

Request Lenses

getUploadStatus_uploadId :: Lens' GetUploadStatus Text Source #

The ID of the upload. This value is returned by the UploadEntityDefinitions action.

Destructuring the Response

data GetUploadStatusResponse Source #

See: newGetUploadStatusResponse smart constructor.

Constructors

GetUploadStatusResponse'

Fields

failureReason :: Maybe [Text]
The reason for an upload failure.
namespaceArn :: Maybe Text
The ARN of the upload.
namespaceVersion :: Maybe Integer
The version of the user's namespace. Defaults to the latest version of the user's namespace.
namespaceName :: Maybe Text
The name of the upload's namespace.
httpStatus :: Int
The response's http status code.
uploadId :: Text
The ID of the upload.
uploadStatus :: UploadStatus
The status of the upload. The initial status is IN_PROGRESS. The response show all validation failures if the upload fails.
createdDate :: POSIX
The date at which the upload was created.

Instances

Instances details

Eq GetUploadStatusResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.GetUploadStatus Methods (==) :: GetUploadStatusResponse -> GetUploadStatusResponse -> Bool # (/=) :: GetUploadStatusResponse -> GetUploadStatusResponse -> Bool #
Read GetUploadStatusResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.GetUploadStatus Methods readsPrec :: Int -> ReadS GetUploadStatusResponse # readList :: ReadS [GetUploadStatusResponse] # readPrec :: ReadPrec GetUploadStatusResponse # readListPrec :: ReadPrec [GetUploadStatusResponse] #
Show GetUploadStatusResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.GetUploadStatus Methods showsPrec :: Int -> GetUploadStatusResponse -> ShowS # show :: GetUploadStatusResponse -> String # showList :: [GetUploadStatusResponse] -> ShowS #
Generic GetUploadStatusResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.GetUploadStatus Associated Types type Rep GetUploadStatusResponse :: Type -> Type # Methods from :: GetUploadStatusResponse -> Rep GetUploadStatusResponse x # to :: Rep GetUploadStatusResponse x -> GetUploadStatusResponse #
NFData GetUploadStatusResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.GetUploadStatus Methods rnf :: GetUploadStatusResponse -> () #
type Rep GetUploadStatusResponse Source #
Instance details Defined in Amazonka.IoTThingsGraph.GetUploadStatus type Rep GetUploadStatusResponse = D1 ('MetaData "GetUploadStatusResponse" "Amazonka.IoTThingsGraph.GetUploadStatus" "libZSservicesZSamazonka-iotthingsgraphZSamazonka-iotthingsgraph" 'False) (C1 ('MetaCons "GetUploadStatusResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "namespaceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "namespaceVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "namespaceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "uploadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "uploadStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UploadStatus) :*: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newGetUploadStatusResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetUploadStatusResponse'`
-> Text	`$sel:uploadId:GetUploadStatus'`
-> UploadStatus	`$sel:uploadStatus:GetUploadStatusResponse'`
-> UTCTime	`$sel:createdDate:GetUploadStatusResponse'`
-> GetUploadStatusResponse

Create a value of GetUploadStatusResponse 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:failureReason:GetUploadStatusResponse', getUploadStatusResponse_failureReason - The reason for an upload failure.

$sel:namespaceArn:GetUploadStatusResponse', getUploadStatusResponse_namespaceArn - The ARN of the upload.

$sel:namespaceVersion:GetUploadStatusResponse', getUploadStatusResponse_namespaceVersion - The version of the user's namespace. Defaults to the latest version of the user's namespace.

$sel:namespaceName:GetUploadStatusResponse', getUploadStatusResponse_namespaceName - The name of the upload's namespace.

$sel:httpStatus:GetUploadStatusResponse', getUploadStatusResponse_httpStatus - The response's http status code.

$sel:uploadId:GetUploadStatus', getUploadStatusResponse_uploadId - The ID of the upload.

$sel:uploadStatus:GetUploadStatusResponse', getUploadStatusResponse_uploadStatus - The status of the upload. The initial status is IN_PROGRESS. The response show all validation failures if the upload fails.

$sel:createdDate:GetUploadStatusResponse', getUploadStatusResponse_createdDate - The date at which the upload was created.