Network.AWS.APIGateway.UpdateIntegration

Represents an update integration.

Creating a Request

updateIntegration

Arguments

:: Text

updRestAPIId

-> Text

updResourceId

-> Text

updHttpMethod

-> UpdateIntegration

Creates a value of UpdateIntegration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• updPatchOperations
• updRestAPIId
• updResourceId
• updHttpMethod

data UpdateIntegration

Represents an update integration request.

See: updateIntegration smart constructor.

Instances

Eq UpdateIntegration

Methods

(==) :: UpdateIntegration -> UpdateIntegration -> Bool

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

Data UpdateIntegration

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateIntegration -> c UpdateIntegration

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateIntegration

toConstr :: UpdateIntegration -> Constr

dataTypeOf :: UpdateIntegration -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateIntegration)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateIntegration)

gmapT :: (forall b. Data b => b -> b) -> UpdateIntegration -> UpdateIntegration

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateIntegration -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateIntegration -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateIntegration -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateIntegration -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateIntegration -> m UpdateIntegration

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateIntegration -> m UpdateIntegration

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateIntegration -> m UpdateIntegration

Read UpdateIntegration

Methods

readsPrec :: Int -> ReadS UpdateIntegration

readList :: ReadS [UpdateIntegration]

readPrec :: ReadPrec UpdateIntegration

readListPrec :: ReadPrec [UpdateIntegration]

Show UpdateIntegration

Methods

showsPrec :: Int -> UpdateIntegration -> ShowS

show :: UpdateIntegration -> String

showList :: [UpdateIntegration] -> ShowS

Generic UpdateIntegration

Associated Types

type Rep UpdateIntegration :: * -> *

Methods

from :: UpdateIntegration -> Rep UpdateIntegration x

to :: Rep UpdateIntegration x -> UpdateIntegration

Hashable UpdateIntegration

Methods

hashWithSalt :: Int -> UpdateIntegration -> Int

hash :: UpdateIntegration -> Int

ToJSON UpdateIntegration

Methods

toJSON :: UpdateIntegration -> Value

toEncoding :: UpdateIntegration -> Encoding

toJSONList :: [UpdateIntegration] -> Value

toEncodingList :: [UpdateIntegration] -> Encoding

NFData UpdateIntegration

Methods

rnf :: UpdateIntegration -> ()

AWSRequest UpdateIntegration

Associated Types

type Rs UpdateIntegration :: *

Methods

request :: UpdateIntegration -> Request UpdateIntegration

response :: MonadResource m => Logger -> Service -> Proxy * UpdateIntegration -> ClientResponse -> m (Response UpdateIntegration)

ToQuery UpdateIntegration

Methods

toQuery :: UpdateIntegration -> QueryString

ToPath UpdateIntegration

Methods

toPath :: UpdateIntegration -> ByteString

ToHeaders UpdateIntegration

Methods

toHeaders :: UpdateIntegration -> [Header]

type Rep UpdateIntegration

type Rep UpdateIntegration = D1 (MetaData "UpdateIntegration" "Network.AWS.APIGateway.UpdateIntegration" "amazonka-apigateway-1.4.1-9LwN6bvDRGjBL5d3wQjvoh" False) (C1 (MetaCons "UpdateIntegration'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_updPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PatchOperation]))) (S1 (MetaSel (Just Symbol "_updRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_updResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_updHttpMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs UpdateIntegration

type Rs UpdateIntegration = Integration

Request Lenses

updPatchOperations :: Lens' UpdateIntegration [PatchOperation]

A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list.

updRestAPIId :: Lens' UpdateIntegration Text

Represents an update integration request's API identifier.

updResourceId :: Lens' UpdateIntegration Text

Represents an update integration request's resource identifier.

updHttpMethod :: Lens' UpdateIntegration Text

Represents an update integration request's HTTP method.

Destructuring the Response

integration :: Integration

Creates a value of Integration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• iHttpMethod
• iRequestTemplates
• iCredentials
• iRequestParameters
• iUri
• iIntegrationResponses
• iCacheNamespace
• iType
• iCacheKeyParameters

data Integration

Represents a HTTP, AWS, or Mock integration.

See: integration smart constructor.

Instances

Eq Integration

Methods

(==) :: Integration -> Integration -> Bool

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

Data Integration

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Integration -> c Integration

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Integration

toConstr :: Integration -> Constr

dataTypeOf :: Integration -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Integration)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Integration)

gmapT :: (forall b. Data b => b -> b) -> Integration -> Integration

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Integration -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Integration -> r

gmapQ :: (forall d. Data d => d -> u) -> Integration -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Integration -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Integration -> m Integration

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Integration -> m Integration

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Integration -> m Integration

Read Integration

Methods

readsPrec :: Int -> ReadS Integration

readList :: ReadS [Integration]

readPrec :: ReadPrec Integration

readListPrec :: ReadPrec [Integration]

Show Integration

Methods

showsPrec :: Int -> Integration -> ShowS

show :: Integration -> String

showList :: [Integration] -> ShowS

Generic Integration

Associated Types

type Rep Integration :: * -> *

Methods

from :: Integration -> Rep Integration x

to :: Rep Integration x -> Integration

Hashable Integration

Methods

hashWithSalt :: Int -> Integration -> Int

hash :: Integration -> Int

FromJSON Integration

Methods

parseJSON :: Value -> Parser Integration

parseJSONList :: Value -> Parser [Integration]

NFData Integration

Methods

rnf :: Integration -> ()

type Rep Integration

type Rep Integration = D1 (MetaData "Integration" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.1-9LwN6bvDRGjBL5d3wQjvoh" False) (C1 (MetaCons "Integration'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_iHttpMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_iRequestTemplates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_iCredentials") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_iRequestParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_iUri") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_iIntegrationResponses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text IntegrationResponse))))) ((:*:) (S1 (MetaSel (Just Symbol "_iCacheNamespace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_iType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe IntegrationType))) (S1 (MetaSel (Just Symbol "_iCacheKeyParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))))))

Response Lenses

iHttpMethod :: Lens' Integration (Maybe Text)

Specifies the integration's HTTP method type.

iRequestTemplates :: Lens' Integration (HashMap Text Text)

Specifies the integration's request templates.

iCredentials :: Lens' Integration (Maybe Text)

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string 'arn:aws:iam::\\*:user\/\\*'. To use resource-based permissions on supported AWS services, specify null.

iRequestParameters :: Lens' Integration (HashMap Text Text)

Represents requests parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern 'integration.request.{location}.{name}', where location is either querystring, path, or header. name must be a valid, unique parameter name.

iUri :: Lens' Integration (Maybe Text)

Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification. For AWS integrations, the URI should be of the form 'arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api}'. Region, subdomain and service are used to determine the right endpoint. For AWS services that use the 'Action=' query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial \/.

iIntegrationResponses :: Lens' Integration (HashMap Text IntegrationResponse)

Specifies the integration's responses.

iCacheNamespace :: Lens' Integration (Maybe Text)

Specifies the integration's cache namespace.

iType :: Lens' Integration (Maybe IntegrationType)

Specifies the integration's type. The valid value is HTTP, AWS, or MOCK.

iCacheKeyParameters :: Lens' Integration [Text]

Specifies the integration's cache key parameters.