Amazonka.AppSync.UpdateApiCache

Updates the cache for the GraphQL API.

Creating a Request

data UpdateApiCache

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 1–3,600 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

ToJSON UpdateApiCache

Defined in Amazonka.AppSync.UpdateApiCache

Methods

toJSON :: UpdateApiCache -> Value

toEncoding :: UpdateApiCache -> Encoding

toJSONList :: [UpdateApiCache] -> Value

toEncodingList :: [UpdateApiCache] -> Encoding

ToHeaders UpdateApiCache

Defined in Amazonka.AppSync.UpdateApiCache

Methods

toHeaders :: UpdateApiCache -> [Header]

ToPath UpdateApiCache

Defined in Amazonka.AppSync.UpdateApiCache

Methods

toPath :: UpdateApiCache -> ByteString

ToQuery UpdateApiCache

Defined in Amazonka.AppSync.UpdateApiCache

Methods

toQuery :: UpdateApiCache -> QueryString

AWSRequest UpdateApiCache

Defined in Amazonka.AppSync.UpdateApiCache

Associated Types

type AWSResponse UpdateApiCache

Methods

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

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

Generic UpdateApiCache

Defined in Amazonka.AppSync.UpdateApiCache

Associated Types

type Rep UpdateApiCache :: Type -> Type

Methods

from :: UpdateApiCache -> Rep UpdateApiCache x

to :: Rep UpdateApiCache x -> UpdateApiCache

Read UpdateApiCache

Defined in Amazonka.AppSync.UpdateApiCache

Methods

readsPrec :: Int -> ReadS UpdateApiCache

readList :: ReadS [UpdateApiCache]

readPrec :: ReadPrec UpdateApiCache

readListPrec :: ReadPrec [UpdateApiCache]

Show UpdateApiCache

Defined in Amazonka.AppSync.UpdateApiCache

Methods

showsPrec :: Int -> UpdateApiCache -> ShowS

show :: UpdateApiCache -> String

showList :: [UpdateApiCache] -> ShowS

NFData UpdateApiCache

Defined in Amazonka.AppSync.UpdateApiCache

Methods

rnf :: UpdateApiCache -> ()

Eq UpdateApiCache

Defined in Amazonka.AppSync.UpdateApiCache

Methods

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

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

Hashable UpdateApiCache

Defined in Amazonka.AppSync.UpdateApiCache

Methods

hashWithSalt :: Int -> UpdateApiCache -> Int

hash :: UpdateApiCache -> Int

type AWSResponse UpdateApiCache

Defined in Amazonka.AppSync.UpdateApiCache

type AWSResponse UpdateApiCache = UpdateApiCacheResponse

type Rep UpdateApiCache

Defined in Amazonka.AppSync.UpdateApiCache

type Rep UpdateApiCache = D1 ('MetaData "UpdateApiCache" "Amazonka.AppSync.UpdateApiCache" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" '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))))

newUpdateApiCache

Arguments

:: Text

UpdateApiCache

-> Integer

UpdateApiCache

-> ApiCachingBehavior

UpdateApiCache

-> ApiCacheType

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:

UpdateApiCache, updateApiCache_apiId - The GraphQL API ID.

UpdateApiCache, updateApiCache_ttl - TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

UpdateApiCache, updateApiCache_apiCachingBehavior - Caching behavior.

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

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

The GraphQL API ID.

updateApiCache_ttl :: Lens' UpdateApiCache Integer

TTL in seconds for cache entries.

Valid values are 1–3,600 seconds.

updateApiCache_apiCachingBehavior :: Lens' UpdateApiCache ApiCachingBehavior

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

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

Represents the output of a UpdateApiCache operation.

See: newUpdateApiCacheResponse smart constructor.

Constructors

UpdateApiCacheResponse'

Fields

• apiCache :: Maybe ApiCache

  The ApiCache object.

• httpStatus :: Int

  The response's http status code.

Instances

Generic UpdateApiCacheResponse

Defined in Amazonka.AppSync.UpdateApiCache

Associated Types

type Rep UpdateApiCacheResponse :: Type -> Type

Methods

from :: UpdateApiCacheResponse -> Rep UpdateApiCacheResponse x

to :: Rep UpdateApiCacheResponse x -> UpdateApiCacheResponse

Read UpdateApiCacheResponse

Defined in Amazonka.AppSync.UpdateApiCache

Methods

readsPrec :: Int -> ReadS UpdateApiCacheResponse

readList :: ReadS [UpdateApiCacheResponse]

readPrec :: ReadPrec UpdateApiCacheResponse

readListPrec :: ReadPrec [UpdateApiCacheResponse]

Show UpdateApiCacheResponse

Defined in Amazonka.AppSync.UpdateApiCache

Methods

showsPrec :: Int -> UpdateApiCacheResponse -> ShowS

show :: UpdateApiCacheResponse -> String

showList :: [UpdateApiCacheResponse] -> ShowS

NFData UpdateApiCacheResponse

Defined in Amazonka.AppSync.UpdateApiCache

Methods

rnf :: UpdateApiCacheResponse -> ()

Eq UpdateApiCacheResponse

Defined in Amazonka.AppSync.UpdateApiCache

Methods

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

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

type Rep UpdateApiCacheResponse

Defined in Amazonka.AppSync.UpdateApiCache

type Rep UpdateApiCacheResponse = D1 ('MetaData "UpdateApiCacheResponse" "Amazonka.AppSync.UpdateApiCache" "amazonka-appsync-2.0-4Pb6UqteLv1I9NIWaj90bg" '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

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)

The ApiCache object.

updateApiCacheResponse_httpStatus :: Lens' UpdateApiCacheResponse Int

The response's http status code.