Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppStream.DescribeImageBuilders

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.

This operation returns paginated results.

Synopsis

data DescribeImageBuilders = DescribeImageBuilders' {
- maxResults :: Maybe Int
- names :: Maybe [Text]
- nextToken :: Maybe Text
}
newDescribeImageBuilders :: DescribeImageBuilders
describeImageBuilders_maxResults :: Lens' DescribeImageBuilders (Maybe Int)
describeImageBuilders_names :: Lens' DescribeImageBuilders (Maybe [Text])
describeImageBuilders_nextToken :: Lens' DescribeImageBuilders (Maybe Text)
data DescribeImageBuildersResponse = DescribeImageBuildersResponse' {
- imageBuilders :: Maybe [ImageBuilder]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeImageBuildersResponse :: Int -> DescribeImageBuildersResponse
describeImageBuildersResponse_imageBuilders :: Lens' DescribeImageBuildersResponse (Maybe [ImageBuilder])
describeImageBuildersResponse_nextToken :: Lens' DescribeImageBuildersResponse (Maybe Text)
describeImageBuildersResponse_httpStatus :: Lens' DescribeImageBuildersResponse Int

Creating a Request

data DescribeImageBuilders Source #

See: newDescribeImageBuilders smart constructor.

Constructors

DescribeImageBuilders'
Fields maxResults :: Maybe Int The maximum size of each page of results. names :: Maybe [Text] The names of the image builders to describe. nextToken :: Maybe Text The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Instances

Instances details

ToJSON DescribeImageBuilders Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Methods toJSON :: DescribeImageBuilders -> Value # toEncoding :: DescribeImageBuilders -> Encoding # toJSONList :: [DescribeImageBuilders] -> Value # toEncodingList :: [DescribeImageBuilders] -> Encoding #
ToHeaders DescribeImageBuilders Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Methods toHeaders :: DescribeImageBuilders -> [Header] #
ToPath DescribeImageBuilders Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Methods toPath :: DescribeImageBuilders -> ByteString #
ToQuery DescribeImageBuilders Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Methods toQuery :: DescribeImageBuilders -> QueryString #
AWSPager DescribeImageBuilders Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Methods page :: DescribeImageBuilders -> AWSResponse DescribeImageBuilders -> Maybe DescribeImageBuilders #
AWSRequest DescribeImageBuilders Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Associated Types type AWSResponse DescribeImageBuilders # Methods request :: (Service -> Service) -> DescribeImageBuilders -> Request DescribeImageBuilders # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeImageBuilders -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeImageBuilders))) #
Generic DescribeImageBuilders Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Associated Types type Rep DescribeImageBuilders :: Type -> Type # Methods from :: DescribeImageBuilders -> Rep DescribeImageBuilders x # to :: Rep DescribeImageBuilders x -> DescribeImageBuilders #
Read DescribeImageBuilders Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Methods readsPrec :: Int -> ReadS DescribeImageBuilders # readList :: ReadS [DescribeImageBuilders] # readPrec :: ReadPrec DescribeImageBuilders # readListPrec :: ReadPrec [DescribeImageBuilders] #
Show DescribeImageBuilders Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Methods showsPrec :: Int -> DescribeImageBuilders -> ShowS # show :: DescribeImageBuilders -> String # showList :: [DescribeImageBuilders] -> ShowS #
NFData DescribeImageBuilders Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Methods rnf :: DescribeImageBuilders -> () #
Eq DescribeImageBuilders Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Methods (==) :: DescribeImageBuilders -> DescribeImageBuilders -> Bool # (/=) :: DescribeImageBuilders -> DescribeImageBuilders -> Bool #
Hashable DescribeImageBuilders Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Methods hashWithSalt :: Int -> DescribeImageBuilders -> Int # hash :: DescribeImageBuilders -> Int #
type AWSResponse DescribeImageBuilders Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders type AWSResponse DescribeImageBuilders = DescribeImageBuildersResponse
type Rep DescribeImageBuilders Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders type Rep DescribeImageBuilders = D1 ('MetaData "DescribeImageBuilders" "Amazonka.AppStream.DescribeImageBuilders" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "DescribeImageBuilders'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "names") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeImageBuilders :: DescribeImageBuilders Source #

Create a value of DescribeImageBuilders 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:maxResults:DescribeImageBuilders', describeImageBuilders_maxResults - The maximum size of each page of results.

$sel:names:DescribeImageBuilders', describeImageBuilders_names - The names of the image builders to describe.

DescribeImageBuilders, describeImageBuilders_nextToken - The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Request Lenses

describeImageBuilders_maxResults :: Lens' DescribeImageBuilders (Maybe Int) Source #

The maximum size of each page of results.

describeImageBuilders_names :: Lens' DescribeImageBuilders (Maybe [Text]) Source #

The names of the image builders to describe.

describeImageBuilders_nextToken :: Lens' DescribeImageBuilders (Maybe Text) Source #

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Destructuring the Response

data DescribeImageBuildersResponse Source #

See: newDescribeImageBuildersResponse smart constructor.

Constructors

DescribeImageBuildersResponse'
Fields imageBuilders :: Maybe [ImageBuilder] Information about the image builders. nextToken :: Maybe Text The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeImageBuildersResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Associated Types type Rep DescribeImageBuildersResponse :: Type -> Type # Methods from :: DescribeImageBuildersResponse -> Rep DescribeImageBuildersResponse x # to :: Rep DescribeImageBuildersResponse x -> DescribeImageBuildersResponse #
Read DescribeImageBuildersResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Methods readsPrec :: Int -> ReadS DescribeImageBuildersResponse # readList :: ReadS [DescribeImageBuildersResponse] # readPrec :: ReadPrec DescribeImageBuildersResponse # readListPrec :: ReadPrec [DescribeImageBuildersResponse] #
Show DescribeImageBuildersResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Methods showsPrec :: Int -> DescribeImageBuildersResponse -> ShowS # show :: DescribeImageBuildersResponse -> String # showList :: [DescribeImageBuildersResponse] -> ShowS #
NFData DescribeImageBuildersResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Methods rnf :: DescribeImageBuildersResponse -> () #
Eq DescribeImageBuildersResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders Methods (==) :: DescribeImageBuildersResponse -> DescribeImageBuildersResponse -> Bool # (/=) :: DescribeImageBuildersResponse -> DescribeImageBuildersResponse -> Bool #
type Rep DescribeImageBuildersResponse Source #
Instance details Defined in Amazonka.AppStream.DescribeImageBuilders type Rep DescribeImageBuildersResponse = D1 ('MetaData "DescribeImageBuildersResponse" "Amazonka.AppStream.DescribeImageBuilders" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "DescribeImageBuildersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "imageBuilders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ImageBuilder])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeImageBuildersResponse Source #

Arguments

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

Create a value of DescribeImageBuildersResponse 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:imageBuilders:DescribeImageBuildersResponse', describeImageBuildersResponse_imageBuilders - Information about the image builders.

DescribeImageBuilders, describeImageBuildersResponse_nextToken - The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

$sel:httpStatus:DescribeImageBuildersResponse', describeImageBuildersResponse_httpStatus - The response's http status code.

Response Lenses

describeImageBuildersResponse_imageBuilders :: Lens' DescribeImageBuildersResponse (Maybe [ImageBuilder]) Source #

Information about the image builders.

describeImageBuildersResponse_nextToken :: Lens' DescribeImageBuildersResponse (Maybe Text) Source #

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

describeImageBuildersResponse_httpStatus :: Lens' DescribeImageBuildersResponse Int Source #

The response's http status code.