Amazonka.KinesisAnalytics.DescribeApplication

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Returns information about a specific Amazon Kinesis Analytics application.

If you want to retrieve a list of all applications in your account, use the ListApplications operation.

This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update.

Creating a Request

data DescribeApplication

See: newDescribeApplication smart constructor.

Constructors

DescribeApplication'

Fields

• applicationName :: Text

  Name of the application.

Instances

ToJSON DescribeApplication

Defined in Amazonka.KinesisAnalytics.DescribeApplication

Methods

toJSON :: DescribeApplication -> Value

toEncoding :: DescribeApplication -> Encoding

toJSONList :: [DescribeApplication] -> Value

toEncodingList :: [DescribeApplication] -> Encoding

ToHeaders DescribeApplication

Defined in Amazonka.KinesisAnalytics.DescribeApplication

Methods

toHeaders :: DescribeApplication -> [Header]

ToPath DescribeApplication

Defined in Amazonka.KinesisAnalytics.DescribeApplication

Methods

toPath :: DescribeApplication -> ByteString

ToQuery DescribeApplication

Defined in Amazonka.KinesisAnalytics.DescribeApplication

Methods

toQuery :: DescribeApplication -> QueryString

AWSRequest DescribeApplication

Defined in Amazonka.KinesisAnalytics.DescribeApplication

Associated Types

type AWSResponse DescribeApplication

Methods

request :: (Service -> Service) -> DescribeApplication -> Request DescribeApplication

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeApplication -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeApplication)))

Generic DescribeApplication

Defined in Amazonka.KinesisAnalytics.DescribeApplication

Associated Types

type Rep DescribeApplication :: Type -> Type

Methods

from :: DescribeApplication -> Rep DescribeApplication x

to :: Rep DescribeApplication x -> DescribeApplication

Read DescribeApplication

Defined in Amazonka.KinesisAnalytics.DescribeApplication

Methods

readsPrec :: Int -> ReadS DescribeApplication

readList :: ReadS [DescribeApplication]

readPrec :: ReadPrec DescribeApplication

readListPrec :: ReadPrec [DescribeApplication]

Show DescribeApplication

Defined in Amazonka.KinesisAnalytics.DescribeApplication

Methods

showsPrec :: Int -> DescribeApplication -> ShowS

show :: DescribeApplication -> String

showList :: [DescribeApplication] -> ShowS

NFData DescribeApplication

Defined in Amazonka.KinesisAnalytics.DescribeApplication

Methods

rnf :: DescribeApplication -> ()

Eq DescribeApplication

Defined in Amazonka.KinesisAnalytics.DescribeApplication

Methods

(==) :: DescribeApplication -> DescribeApplication -> Bool

(/=) :: DescribeApplication -> DescribeApplication -> Bool

Hashable DescribeApplication

Defined in Amazonka.KinesisAnalytics.DescribeApplication

Methods

hashWithSalt :: Int -> DescribeApplication -> Int

hash :: DescribeApplication -> Int

type AWSResponse DescribeApplication

Defined in Amazonka.KinesisAnalytics.DescribeApplication

type AWSResponse DescribeApplication = DescribeApplicationResponse

type Rep DescribeApplication

Defined in Amazonka.KinesisAnalytics.DescribeApplication

type Rep DescribeApplication = D1 ('MetaData "DescribeApplication" "Amazonka.KinesisAnalytics.DescribeApplication" "amazonka-kinesis-analytics-2.0-7I8X2DEyFUlG6TCxCRLiwg" 'False) (C1 ('MetaCons "DescribeApplication'" 'PrefixI 'True) (S1 ('MetaSel ('Just "applicationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeApplication

Arguments

:: Text

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:

DescribeApplication, describeApplication_applicationName - Name of the application.

Request Lenses

describeApplication_applicationName :: Lens' DescribeApplication Text

Name of the application.

Destructuring the Response

data DescribeApplicationResponse

See: newDescribeApplicationResponse smart constructor.

Constructors

DescribeApplicationResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• applicationDetail :: ApplicationDetail

  Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest version, and input and output configuration details.

Instances

Generic DescribeApplicationResponse

Defined in Amazonka.KinesisAnalytics.DescribeApplication

Associated Types

type Rep DescribeApplicationResponse :: Type -> Type

Methods

from :: DescribeApplicationResponse -> Rep DescribeApplicationResponse x

to :: Rep DescribeApplicationResponse x -> DescribeApplicationResponse

Read DescribeApplicationResponse

Defined in Amazonka.KinesisAnalytics.DescribeApplication

Methods

readsPrec :: Int -> ReadS DescribeApplicationResponse

readList :: ReadS [DescribeApplicationResponse]

readPrec :: ReadPrec DescribeApplicationResponse

readListPrec :: ReadPrec [DescribeApplicationResponse]

Show DescribeApplicationResponse

Defined in Amazonka.KinesisAnalytics.DescribeApplication

Methods

showsPrec :: Int -> DescribeApplicationResponse -> ShowS

show :: DescribeApplicationResponse -> String

showList :: [DescribeApplicationResponse] -> ShowS

NFData DescribeApplicationResponse

Defined in Amazonka.KinesisAnalytics.DescribeApplication

Methods

rnf :: DescribeApplicationResponse -> ()

Eq DescribeApplicationResponse

Defined in Amazonka.KinesisAnalytics.DescribeApplication

Methods

(==) :: DescribeApplicationResponse -> DescribeApplicationResponse -> Bool

(/=) :: DescribeApplicationResponse -> DescribeApplicationResponse -> Bool

type Rep DescribeApplicationResponse

Defined in Amazonka.KinesisAnalytics.DescribeApplication

type Rep DescribeApplicationResponse = D1 ('MetaData "DescribeApplicationResponse" "Amazonka.KinesisAnalytics.DescribeApplication" "amazonka-kinesis-analytics-2.0-7I8X2DEyFUlG6TCxCRLiwg" 'False) (C1 ('MetaCons "DescribeApplicationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "applicationDetail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ApplicationDetail)))

newDescribeApplicationResponse

Arguments

:: Int

$sel:httpStatus:DescribeApplicationResponse'

-> ApplicationDetail

$sel:applicationDetail: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:httpStatus:DescribeApplicationResponse', describeApplicationResponse_httpStatus - The response's http status code.

$sel:applicationDetail:DescribeApplicationResponse', describeApplicationResponse_applicationDetail - Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest version, and input and output configuration details.

Response Lenses

describeApplicationResponse_httpStatus :: Lens' DescribeApplicationResponse Int

The response's http status code.

describeApplicationResponse_applicationDetail :: Lens' DescribeApplicationResponse ApplicationDetail

Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest version, and input and output configuration details.