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.MediaConvert.DescribeEndpoints

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Send an request with an empty body to the regional API endpoint to get your account API endpoint.

This operation returns paginated results.

Creating a Request

data DescribeEndpoints Source #

DescribeEndpointsRequest

See: newDescribeEndpoints smart constructor.

Constructors

DescribeEndpoints'

Fields

maxResults :: Maybe Int
Optional. Max number of endpoints, up to twenty, that will be returned at one time.
mode :: Maybe DescribeEndpointsMode
Optional field, defaults to DEFAULT. Specify DEFAULT for this operation to return your endpoints if any exist, or to create an endpoint for you and return it if one doesn't already exist. Specify GET_ONLY to return your endpoints if any exist, or an empty list if none exist.
nextToken :: Maybe Text
Use this string, provided with the response to a previous request, to request the next batch of endpoints.

Instances

Instances details

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

newDescribeEndpoints :: DescribeEndpoints Source #

Create a value of DescribeEndpoints 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:DescribeEndpoints', describeEndpoints_maxResults - Optional. Max number of endpoints, up to twenty, that will be returned at one time.

DescribeEndpoints, describeEndpoints_mode - Optional field, defaults to DEFAULT. Specify DEFAULT for this operation to return your endpoints if any exist, or to create an endpoint for you and return it if one doesn't already exist. Specify GET_ONLY to return your endpoints if any exist, or an empty list if none exist.

DescribeEndpoints, describeEndpoints_nextToken - Use this string, provided with the response to a previous request, to request the next batch of endpoints.

Request Lenses

describeEndpoints_maxResults :: Lens' DescribeEndpoints (Maybe Int) Source #

Optional. Max number of endpoints, up to twenty, that will be returned at one time.

describeEndpoints_mode :: Lens' DescribeEndpoints (Maybe DescribeEndpointsMode) Source #

Optional field, defaults to DEFAULT. Specify DEFAULT for this operation to return your endpoints if any exist, or to create an endpoint for you and return it if one doesn't already exist. Specify GET_ONLY to return your endpoints if any exist, or an empty list if none exist.

describeEndpoints_nextToken :: Lens' DescribeEndpoints (Maybe Text) Source #

Use this string, provided with the response to a previous request, to request the next batch of endpoints.

Destructuring the Response

data DescribeEndpointsResponse Source #

See: newDescribeEndpointsResponse smart constructor.

Constructors

DescribeEndpointsResponse'
Fields endpoints :: Maybe [Endpoint] List of endpoints nextToken :: Maybe Text Use this string to request the next batch of endpoints. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeEndpointsResponse Source #

Arguments

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

Create a value of DescribeEndpointsResponse 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:endpoints:DescribeEndpointsResponse', describeEndpointsResponse_endpoints - List of endpoints

DescribeEndpoints, describeEndpointsResponse_nextToken - Use this string to request the next batch of endpoints.

$sel:httpStatus:DescribeEndpointsResponse', describeEndpointsResponse_httpStatus - The response's http status code.

Response Lenses

describeEndpointsResponse_endpoints :: Lens' DescribeEndpointsResponse (Maybe [Endpoint]) Source #

List of endpoints

describeEndpointsResponse_nextToken :: Lens' DescribeEndpointsResponse (Maybe Text) Source #

Use this string to request the next batch of endpoints.

describeEndpointsResponse_httpStatus :: Lens' DescribeEndpointsResponse Int Source #

The response's http status code.