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.IoTFleetHub.DescribeApplication

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about a Fleet Hub for AWS IoT Device Management web application.

Fleet Hub for AWS IoT Device Management is in public preview and is subject to change.

Synopsis

data DescribeApplication = DescribeApplication' {
- applicationId :: Text
}
newDescribeApplication :: Text -> DescribeApplication
describeApplication_applicationId :: Lens' DescribeApplication Text
data DescribeApplicationResponse = DescribeApplicationResponse' {
- applicationDescription :: Maybe Text
- ssoClientId :: Maybe Text
- errorMessage :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- applicationId :: Text
- applicationArn :: Text
- applicationName :: Text
- applicationUrl :: Text
- applicationState :: ApplicationState
- applicationCreationDate :: Integer
- applicationLastUpdateDate :: Integer
- roleArn :: Text
}
newDescribeApplicationResponse :: Int -> Text -> Text -> Text -> Text -> ApplicationState -> Integer -> Integer -> Text -> DescribeApplicationResponse
describeApplicationResponse_applicationDescription :: Lens' DescribeApplicationResponse (Maybe Text)
describeApplicationResponse_ssoClientId :: Lens' DescribeApplicationResponse (Maybe Text)
describeApplicationResponse_errorMessage :: Lens' DescribeApplicationResponse (Maybe Text)
describeApplicationResponse_tags :: Lens' DescribeApplicationResponse (Maybe (HashMap Text Text))
describeApplicationResponse_httpStatus :: Lens' DescribeApplicationResponse Int
describeApplicationResponse_applicationId :: Lens' DescribeApplicationResponse Text
describeApplicationResponse_applicationArn :: Lens' DescribeApplicationResponse Text
describeApplicationResponse_applicationName :: Lens' DescribeApplicationResponse Text
describeApplicationResponse_applicationUrl :: Lens' DescribeApplicationResponse Text
describeApplicationResponse_applicationState :: Lens' DescribeApplicationResponse ApplicationState
describeApplicationResponse_applicationCreationDate :: Lens' DescribeApplicationResponse Integer
describeApplicationResponse_applicationLastUpdateDate :: Lens' DescribeApplicationResponse Integer
describeApplicationResponse_roleArn :: Lens' DescribeApplicationResponse Text

Creating a Request

data DescribeApplication Source #

See: newDescribeApplication smart constructor.

Constructors

DescribeApplication'
Fields applicationId :: Text The unique Id of the web application.

Instances

Instances details

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

newDescribeApplication Source #

Arguments

:: Text	`$sel:applicationId:DescribeApplication'`
-> DescribeApplication

Create a value of DescribeApplication 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:applicationId:DescribeApplication', describeApplication_applicationId - The unique Id of the web application.

Request Lenses

describeApplication_applicationId :: Lens' DescribeApplication Text Source #

The unique Id of the web application.

Destructuring the Response

data DescribeApplicationResponse Source #

See: newDescribeApplicationResponse smart constructor.

Constructors

DescribeApplicationResponse'

Fields

applicationDescription :: Maybe Text
An optional description of the web application.
ssoClientId :: Maybe Text
The Id of the single sign-on client that you use to authenticate and authorize users on the web application.
errorMessage :: Maybe Text
A message indicating why the DescribeApplication API failed.
tags :: Maybe (HashMap Text Text)
A set of key/value pairs that you can use to manage the web application resource.
httpStatus :: Int
The response's http status code.
applicationId :: Text
The unique Id of the web application.
applicationArn :: Text
The ARN of the web application.
applicationName :: Text
The name of the web application.
applicationUrl :: Text
The URL of the web application.
applicationState :: ApplicationState
The current state of the web application.
applicationCreationDate :: Integer
The date (in Unix epoch time) when the application was created.
applicationLastUpdateDate :: Integer
The date (in Unix epoch time) when the application was last updated.
roleArn :: Text
The ARN of the role that the web application assumes when it interacts with AWS IoT Core.

Instances

Instances details

Eq DescribeApplicationResponse Source #
Instance details Defined in Amazonka.IoTFleetHub.DescribeApplication Methods (==) :: DescribeApplicationResponse -> DescribeApplicationResponse -> Bool # (/=) :: DescribeApplicationResponse -> DescribeApplicationResponse -> Bool #
Read DescribeApplicationResponse Source #
Instance details Defined in Amazonka.IoTFleetHub.DescribeApplication Methods readsPrec :: Int -> ReadS DescribeApplicationResponse # readList :: ReadS [DescribeApplicationResponse] # readPrec :: ReadPrec DescribeApplicationResponse # readListPrec :: ReadPrec [DescribeApplicationResponse] #
Show DescribeApplicationResponse Source #
Instance details Defined in Amazonka.IoTFleetHub.DescribeApplication Methods showsPrec :: Int -> DescribeApplicationResponse -> ShowS # show :: DescribeApplicationResponse -> String # showList :: [DescribeApplicationResponse] -> ShowS #
Generic DescribeApplicationResponse Source #
Instance details Defined in Amazonka.IoTFleetHub.DescribeApplication Associated Types type Rep DescribeApplicationResponse :: Type -> Type # Methods from :: DescribeApplicationResponse -> Rep DescribeApplicationResponse x # to :: Rep DescribeApplicationResponse x -> DescribeApplicationResponse #
NFData DescribeApplicationResponse Source #
Instance details Defined in Amazonka.IoTFleetHub.DescribeApplication Methods rnf :: DescribeApplicationResponse -> () #
type Rep DescribeApplicationResponse Source #
Instance details Defined in Amazonka.IoTFleetHub.DescribeApplication type Rep DescribeApplicationResponse = D1 ('MetaData "DescribeApplicationResponse" "Amazonka.IoTFleetHub.DescribeApplication" "libZSservicesZSamazonka-iotfleethubZSamazonka-iotfleethub" 'False) (C1 ('MetaCons "DescribeApplicationResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "applicationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "ssoClientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :: ((S1 ('MetaSel ('Just "applicationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "applicationUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "applicationState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ApplicationState) :: S1 ('MetaSel ('Just "applicationCreationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)) :: (S1 ('MetaSel ('Just "applicationLastUpdateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newDescribeApplicationResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeApplicationResponse'`
-> Text	`$sel:applicationId:DescribeApplication'`
-> Text	`$sel:applicationArn:DescribeApplicationResponse'`
-> Text	`$sel:applicationName:DescribeApplicationResponse'`
-> Text	`$sel:applicationUrl:DescribeApplicationResponse'`
-> ApplicationState	`$sel:applicationState:DescribeApplicationResponse'`
-> Integer	`$sel:applicationCreationDate:DescribeApplicationResponse'`
-> Integer	`$sel:applicationLastUpdateDate:DescribeApplicationResponse'`
-> Text	`$sel:roleArn:DescribeApplicationResponse'`
-> DescribeApplicationResponse

Create a value of DescribeApplicationResponse 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:applicationDescription:DescribeApplicationResponse', describeApplicationResponse_applicationDescription - An optional description of the web application.

$sel:ssoClientId:DescribeApplicationResponse', describeApplicationResponse_ssoClientId - The Id of the single sign-on client that you use to authenticate and authorize users on the web application.

$sel:errorMessage:DescribeApplicationResponse', describeApplicationResponse_errorMessage - A message indicating why the DescribeApplication API failed.

$sel:tags:DescribeApplicationResponse', describeApplicationResponse_tags - A set of key/value pairs that you can use to manage the web application resource.

$sel:httpStatus:DescribeApplicationResponse', describeApplicationResponse_httpStatus - The response's http status code.

$sel:applicationId:DescribeApplication', describeApplicationResponse_applicationId - The unique Id of the web application.

$sel:applicationArn:DescribeApplicationResponse', describeApplicationResponse_applicationArn - The ARN of the web application.

$sel:applicationName:DescribeApplicationResponse', describeApplicationResponse_applicationName - The name of the web application.

$sel:applicationUrl:DescribeApplicationResponse', describeApplicationResponse_applicationUrl - The URL of the web application.

$sel:applicationState:DescribeApplicationResponse', describeApplicationResponse_applicationState - The current state of the web application.

$sel:applicationCreationDate:DescribeApplicationResponse', describeApplicationResponse_applicationCreationDate - The date (in Unix epoch time) when the application was created.

$sel:applicationLastUpdateDate:DescribeApplicationResponse', describeApplicationResponse_applicationLastUpdateDate - The date (in Unix epoch time) when the application was last updated.

$sel:roleArn:DescribeApplicationResponse', describeApplicationResponse_roleArn - The ARN of the role that the web application assumes when it interacts with AWS IoT Core.

Response Lenses

describeApplicationResponse_applicationDescription :: Lens' DescribeApplicationResponse (Maybe Text) Source #

An optional description of the web application.

describeApplicationResponse_ssoClientId :: Lens' DescribeApplicationResponse (Maybe Text) Source #

The Id of the single sign-on client that you use to authenticate and authorize users on the web application.

describeApplicationResponse_errorMessage :: Lens' DescribeApplicationResponse (Maybe Text) Source #

A message indicating why the DescribeApplication API failed.

describeApplicationResponse_tags :: Lens' DescribeApplicationResponse (Maybe (HashMap Text Text)) Source #

A set of key/value pairs that you can use to manage the web application resource.

describeApplicationResponse_httpStatus :: Lens' DescribeApplicationResponse Int Source #

The response's http status code.

describeApplicationResponse_applicationId :: Lens' DescribeApplicationResponse Text Source #

The unique Id of the web application.

describeApplicationResponse_applicationArn :: Lens' DescribeApplicationResponse Text Source #

The ARN of the web application.

describeApplicationResponse_applicationName :: Lens' DescribeApplicationResponse Text Source #

The name of the web application.

describeApplicationResponse_applicationUrl :: Lens' DescribeApplicationResponse Text Source #

The URL of the web application.

describeApplicationResponse_applicationState :: Lens' DescribeApplicationResponse ApplicationState Source #

The current state of the web application.

describeApplicationResponse_applicationCreationDate :: Lens' DescribeApplicationResponse Integer Source #

The date (in Unix epoch time) when the application was created.

describeApplicationResponse_applicationLastUpdateDate :: Lens' DescribeApplicationResponse Integer Source #

The date (in Unix epoch time) when the application was last updated.

describeApplicationResponse_roleArn :: Lens' DescribeApplicationResponse Text Source #

The ARN of the role that the web application assumes when it interacts with AWS IoT Core.