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.Glue.StartCrawler

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException.

Synopsis

data StartCrawler = StartCrawler' {
- name :: Text
}
newStartCrawler :: Text -> StartCrawler
startCrawler_name :: Lens' StartCrawler Text
data StartCrawlerResponse = StartCrawlerResponse' {
- httpStatus :: Int
}
newStartCrawlerResponse :: Int -> StartCrawlerResponse
startCrawlerResponse_httpStatus :: Lens' StartCrawlerResponse Int

Creating a Request

data StartCrawler Source #

See: newStartCrawler smart constructor.

Constructors

StartCrawler'
Fields name :: Text Name of the crawler to start.

Instances

Instances details

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

newStartCrawler Source #

Arguments

:: Text	`StartCrawler`
-> StartCrawler

Create a value of StartCrawler 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:

StartCrawler, startCrawler_name - Name of the crawler to start.

Request Lenses

startCrawler_name :: Lens' StartCrawler Text Source #

Name of the crawler to start.

Destructuring the Response

data StartCrawlerResponse Source #

See: newStartCrawlerResponse smart constructor.

Constructors

StartCrawlerResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStartCrawlerResponse Source #

Arguments

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

Create a value of StartCrawlerResponse 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:StartCrawlerResponse', startCrawlerResponse_httpStatus - The response's http status code.

Response Lenses

startCrawlerResponse_httpStatus :: Lens' StartCrawlerResponse Int Source #

The response's http status code.