libZSservicesZSamazonka-appsyncZSamazonka-appsync
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppSync.UpdateApiCache

Description

Updates the cache for the GraphQL API.

Synopsis

Creating a Request

data UpdateApiCache Source #

Represents the input of a UpdateApiCache operation.

See: newUpdateApiCache smart constructor.

Constructors

UpdateApiCache' 

Fields

  • apiId :: Text

    The GraphQL API Id.

  • ttl :: Integer

    TTL in seconds for cache entries.

    Valid values are between 1 and 3600 seconds.

  • apiCachingBehavior :: ApiCachingBehavior

    Caching behavior.

    • FULL_REQUEST_CACHING: All requests are fully cached.
    • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.
  • type' :: ApiCacheType

    The cache instance type. Valid values are

    • SMALL
    • MEDIUM
    • LARGE
    • XLARGE
    • LARGE_2X
    • LARGE_4X
    • LARGE_8X (not available in all regions)
    • LARGE_12X

    Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

    The following legacy instance types are available, but their use is discouraged:

    • T2_SMALL: A t2.small instance type.
    • T2_MEDIUM: A t2.medium instance type.
    • R4_LARGE: A r4.large instance type.
    • R4_XLARGE: A r4.xlarge instance type.
    • R4_2XLARGE: A r4.2xlarge instance type.
    • R4_4XLARGE: A r4.4xlarge instance type.
    • R4_8XLARGE: A r4.8xlarge instance type.

Instances

Instances details
Eq UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Methods

(==) :: UpdateApiCache -> UpdateApiCache -> Bool #

(/=) :: UpdateApiCache -> UpdateApiCache -> Bool #

Read UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Methods

readsPrec :: Int -> ReadS UpdateApiCache #

readList :: ReadS [UpdateApiCache] #

readPrec :: ReadPrec UpdateApiCache #

readListPrec :: ReadPrec [UpdateApiCache] #

Show UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Methods

showsPrec :: Int -> UpdateApiCache -> ShowS #

show :: UpdateApiCache -> String #

showList :: [UpdateApiCache] -> ShowS #

Generic UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Associated Types

type Rep UpdateApiCache :: Type -> Type #

Methods

from :: UpdateApiCache -> Rep UpdateApiCache x #

to :: Rep UpdateApiCache x -> UpdateApiCache #

NFData UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Methods

rnf :: UpdateApiCache -> () #

Hashable UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Methods

hashWithSalt :: Int -> UpdateApiCache -> Int #

hash :: UpdateApiCache -> Int #

ToJSON UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Methods

toJSON :: UpdateApiCache -> Value #

toEncoding :: UpdateApiCache -> Encoding #

toJSONList :: [UpdateApiCache] -> Value #

toEncodingList :: [UpdateApiCache] -> Encoding #

AWSRequest UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Associated Types

type AWSResponse UpdateApiCache #

Methods

request :: UpdateApiCache -> Request UpdateApiCache #

response :: MonadResource m => Logger -> Service -> Proxy UpdateApiCache -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateApiCache))) #

ToHeaders UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Methods

toHeaders :: UpdateApiCache -> [Header] #

ToPath UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Methods

toPath :: UpdateApiCache -> ByteString #

ToQuery UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Methods

toQuery :: UpdateApiCache -> QueryString #

type Rep UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

type Rep UpdateApiCache = D1 ('MetaData "UpdateApiCache" "Amazonka.AppSync.UpdateApiCache" "libZSservicesZSamazonka-appsyncZSamazonka-appsync" 'False) (C1 ('MetaCons "UpdateApiCache'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "ttl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)) :*: (S1 ('MetaSel ('Just "apiCachingBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ApiCachingBehavior) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ApiCacheType))))
type AWSResponse UpdateApiCache Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

type AWSResponse UpdateApiCache = UpdateApiCacheResponse

newUpdateApiCache Source #

Arguments

:: Text

$sel:apiId:UpdateApiCache'

-> Integer

$sel:ttl:UpdateApiCache'

-> ApiCachingBehavior

$sel:apiCachingBehavior:UpdateApiCache'

-> ApiCacheType

$sel:type':UpdateApiCache'

-> UpdateApiCache 

Create a value of UpdateApiCache 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:apiId:UpdateApiCache', updateApiCache_apiId - The GraphQL API Id.

$sel:ttl:UpdateApiCache', updateApiCache_ttl - TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

$sel:apiCachingBehavior:UpdateApiCache', updateApiCache_apiCachingBehavior - Caching behavior.

  • FULL_REQUEST_CACHING: All requests are fully cached.
  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

$sel:type':UpdateApiCache', updateApiCache_type - The cache instance type. Valid values are

  • SMALL
  • MEDIUM
  • LARGE
  • XLARGE
  • LARGE_2X
  • LARGE_4X
  • LARGE_8X (not available in all regions)
  • LARGE_12X

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

  • T2_SMALL: A t2.small instance type.
  • T2_MEDIUM: A t2.medium instance type.
  • R4_LARGE: A r4.large instance type.
  • R4_XLARGE: A r4.xlarge instance type.
  • R4_2XLARGE: A r4.2xlarge instance type.
  • R4_4XLARGE: A r4.4xlarge instance type.
  • R4_8XLARGE: A r4.8xlarge instance type.

Request Lenses

updateApiCache_apiId :: Lens' UpdateApiCache Text Source #

The GraphQL API Id.

updateApiCache_ttl :: Lens' UpdateApiCache Integer Source #

TTL in seconds for cache entries.

Valid values are between 1 and 3600 seconds.

updateApiCache_apiCachingBehavior :: Lens' UpdateApiCache ApiCachingBehavior Source #

Caching behavior.

  • FULL_REQUEST_CACHING: All requests are fully cached.
  • PER_RESOLVER_CACHING: Individual resolvers that you specify are cached.

updateApiCache_type :: Lens' UpdateApiCache ApiCacheType Source #

The cache instance type. Valid values are

  • SMALL
  • MEDIUM
  • LARGE
  • XLARGE
  • LARGE_2X
  • LARGE_4X
  • LARGE_8X (not available in all regions)
  • LARGE_12X

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are available, but their use is discouraged:

  • T2_SMALL: A t2.small instance type.
  • T2_MEDIUM: A t2.medium instance type.
  • R4_LARGE: A r4.large instance type.
  • R4_XLARGE: A r4.xlarge instance type.
  • R4_2XLARGE: A r4.2xlarge instance type.
  • R4_4XLARGE: A r4.4xlarge instance type.
  • R4_8XLARGE: A r4.8xlarge instance type.

Destructuring the Response

data UpdateApiCacheResponse Source #

Represents the output of a UpdateApiCache operation.

See: newUpdateApiCacheResponse smart constructor.

Constructors

UpdateApiCacheResponse' 

Fields

Instances

Instances details
Eq UpdateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Methods

(==) :: UpdateApiCacheResponse -> UpdateApiCacheResponse -> Bool #

(/=) :: UpdateApiCacheResponse -> UpdateApiCacheResponse -> Bool #

Read UpdateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Methods

readsPrec :: Int -> ReadS UpdateApiCacheResponse #

readList :: ReadS [UpdateApiCacheResponse] #

readPrec :: ReadPrec UpdateApiCacheResponse #

readListPrec :: ReadPrec [UpdateApiCacheResponse] #

Show UpdateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Methods

showsPrec :: Int -> UpdateApiCacheResponse -> ShowS #

show :: UpdateApiCacheResponse -> String #

showList :: [UpdateApiCacheResponse] -> ShowS #

Generic UpdateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Associated Types

type Rep UpdateApiCacheResponse :: Type -> Type #

Methods

from :: UpdateApiCacheResponse -> Rep UpdateApiCacheResponse x #

to :: Rep UpdateApiCacheResponse x -> UpdateApiCacheResponse #

NFData UpdateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

Methods

rnf :: UpdateApiCacheResponse -> () #

type Rep UpdateApiCacheResponse Source # 
Instance details

Defined in Amazonka.AppSync.UpdateApiCache

type Rep UpdateApiCacheResponse = D1 ('MetaData "UpdateApiCacheResponse" "Amazonka.AppSync.UpdateApiCache" "libZSservicesZSamazonka-appsyncZSamazonka-appsync" 'False) (C1 ('MetaCons "UpdateApiCacheResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "apiCache") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiCache)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateApiCacheResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateApiCacheResponse'

-> UpdateApiCacheResponse 

Create a value of UpdateApiCacheResponse 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:apiCache:UpdateApiCacheResponse', updateApiCacheResponse_apiCache - The ApiCache object.

$sel:httpStatus:UpdateApiCacheResponse', updateApiCacheResponse_httpStatus - The response's http status code.

Response Lenses

updateApiCacheResponse_apiCache :: Lens' UpdateApiCacheResponse (Maybe ApiCache) Source #

The ApiCache object.

updateApiCacheResponse_httpStatus :: Lens' UpdateApiCacheResponse Int Source #

The response's http status code.