Network.AWS.APIGateway.UpdateResource

Changes information about a Resource resource.

Creating a Request

updateResource

Arguments

:: Text

urRestAPIId

-> Text

urResourceId

-> UpdateResource

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

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

• urPatchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.
• urRestAPIId - [Required] The string identifier of the associated RestApi .
• urResourceId - [Required] The identifier of the Resource resource.

data UpdateResource

Request to change information about a Resource resource.

See: updateResource smart constructor.

Instances

Eq UpdateResource

Defined in Network.AWS.APIGateway.UpdateResource

Methods

(==) :: UpdateResource -> UpdateResource -> Bool

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

Data UpdateResource

Defined in Network.AWS.APIGateway.UpdateResource

Methods

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

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

toConstr :: UpdateResource -> Constr

dataTypeOf :: UpdateResource -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpdateResource

Defined in Network.AWS.APIGateway.UpdateResource

Methods

readsPrec :: Int -> ReadS UpdateResource

readList :: ReadS [UpdateResource]

readPrec :: ReadPrec UpdateResource

readListPrec :: ReadPrec [UpdateResource]

Show UpdateResource

Defined in Network.AWS.APIGateway.UpdateResource

Methods

showsPrec :: Int -> UpdateResource -> ShowS

show :: UpdateResource -> String

showList :: [UpdateResource] -> ShowS

Generic UpdateResource

Defined in Network.AWS.APIGateway.UpdateResource

Associated Types

type Rep UpdateResource :: Type -> Type

Methods

from :: UpdateResource -> Rep UpdateResource x

to :: Rep UpdateResource x -> UpdateResource

Hashable UpdateResource

Defined in Network.AWS.APIGateway.UpdateResource

Methods

hashWithSalt :: Int -> UpdateResource -> Int

hash :: UpdateResource -> Int

ToJSON UpdateResource

Defined in Network.AWS.APIGateway.UpdateResource

Methods

toJSON :: UpdateResource -> Value

toEncoding :: UpdateResource -> Encoding

toJSONList :: [UpdateResource] -> Value

toEncodingList :: [UpdateResource] -> Encoding

AWSRequest UpdateResource

Defined in Network.AWS.APIGateway.UpdateResource

Associated Types

type Rs UpdateResource :: Type

Methods

request :: UpdateResource -> Request UpdateResource

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UpdateResource -> ClientResponse -> m (Response UpdateResource)

ToHeaders UpdateResource

Defined in Network.AWS.APIGateway.UpdateResource

Methods

toHeaders :: UpdateResource -> [Header]

ToPath UpdateResource

Defined in Network.AWS.APIGateway.UpdateResource

Methods

toPath :: UpdateResource -> ByteString

ToQuery UpdateResource

Defined in Network.AWS.APIGateway.UpdateResource

Methods

toQuery :: UpdateResource -> QueryString

NFData UpdateResource

Defined in Network.AWS.APIGateway.UpdateResource

Methods

rnf :: UpdateResource -> ()

type Rep UpdateResource

Defined in Network.AWS.APIGateway.UpdateResource

type Rep UpdateResource = D1 (MetaData "UpdateResource" "Network.AWS.APIGateway.UpdateResource" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "UpdateResource'" PrefixI True) (S1 (MetaSel (Just "_urPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: (S1 (MetaSel (Just "_urRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_urResourceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs UpdateResource

Defined in Network.AWS.APIGateway.UpdateResource

type Rs UpdateResource = Resource

Request Lenses

urPatchOperations :: Lens' UpdateResource [PatchOperation]

A list of update operations to be applied to the specified resource and in the order specified in this list.

urRestAPIId :: Lens' UpdateResource Text

Required

The string identifier of the associated RestApi .

urResourceId :: Lens' UpdateResource Text

Required

The identifier of the Resource resource.

Destructuring the Response

resource :: Resource

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

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

• rPathPart - The last path segment for this resource.
• rPath - The full path for this resource.
• rId - The resource's identifier.
• rResourceMethods - Gets an API resource's method of a given HTTP verb. The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET restapis{restapi_id}resources{resource_id} or GET restapis{restapi_id}resources{resource_id}?embed=methods request. Example: Get the GET method of an API resource Request @GET restapisfugvjdxtriresources3kzxbg5sa2methodsGET HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}20170223us-east-1apigatewayaws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response { "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGET", "name": GET, "title": GET }, "integration:put": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "method:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGET" }, "method:integration": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "method:responses": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200", "name": "200", "title": "200" }, "method:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGET" }, "methodresponse:put": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses{status_code}", "templated": true } }, "apiKeyRequired": false, "authorizationType": NONE, "httpMethod": GET, "_embedded": { "method:integration": { "_links": { "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "integration:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "integration:responses": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200", "name": "200", "title": "200" }, "integration:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "integrationresponse:put": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:roleapigAwsProxyRole", "httpMethod": POST, "passthroughBehavior": WHEN_NO_MATCH, "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "applicationjson": "{n}" }, "type": AWS, "uri": "arn:aws:apigateway:us-east-1:kinesis:actionListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" }, "integrationresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" } }, "responseParameters": { "method.response.header.Content-Type": "'applicationxml'" }, "responseTemplates": { "applicationjson": "$util.urlDecode("%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3Cname%3E%3Cstream%3E#end%3CkinesisStreams%3E")n" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200" }, "methodresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200" } }, "responseModels": { "application/json": Empty }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } } If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS@ .
• rParentId - The parent resource's identifier.

data Resource

Represents an API resource.

Create an API

See: resource smart constructor.

Instances

Eq Resource

Defined in Network.AWS.APIGateway.Types.Product

Methods

(==) :: Resource -> Resource -> Bool

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

Data Resource

Defined in Network.AWS.APIGateway.Types.Product

Methods

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

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

toConstr :: Resource -> Constr

dataTypeOf :: Resource -> DataType

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

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

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

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

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

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

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

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

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

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

Read Resource

Defined in Network.AWS.APIGateway.Types.Product

Methods

readsPrec :: Int -> ReadS Resource

readList :: ReadS [Resource]

readPrec :: ReadPrec Resource

readListPrec :: ReadPrec [Resource]

Show Resource

Defined in Network.AWS.APIGateway.Types.Product

Methods

showsPrec :: Int -> Resource -> ShowS

show :: Resource -> String

showList :: [Resource] -> ShowS

Generic Resource

Defined in Network.AWS.APIGateway.Types.Product

Associated Types

type Rep Resource :: Type -> Type

Methods

from :: Resource -> Rep Resource x

to :: Rep Resource x -> Resource

Hashable Resource

Defined in Network.AWS.APIGateway.Types.Product

Methods

hashWithSalt :: Int -> Resource -> Int

hash :: Resource -> Int

FromJSON Resource

Defined in Network.AWS.APIGateway.Types.Product

Methods

parseJSON :: Value -> Parser Resource

parseJSONList :: Value -> Parser [Resource]

NFData Resource

Defined in Network.AWS.APIGateway.Types.Product

Methods

rnf :: Resource -> ()

type Rep Resource

Defined in Network.AWS.APIGateway.Types.Product

type Rep Resource = D1 (MetaData "Resource" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "Resource'" PrefixI True) ((S1 (MetaSel (Just "_rPathPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_rId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_rResourceMethods") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Method))) :*: S1 (MetaSel (Just "_rParentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

Response Lenses

rPathPart :: Lens' Resource (Maybe Text)

The last path segment for this resource.

rPath :: Lens' Resource (Maybe Text)

The full path for this resource.

rId :: Lens' Resource (Maybe Text)

The resource's identifier.

rResourceMethods :: Lens' Resource (HashMap Text Method)

Gets an API resource's method of a given HTTP verb. The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET restapis{restapi_id}resources{resource_id} or GET restapis{restapi_id}resources{resource_id}?embed=methods request. Example: Get the GET method of an API resource Request @GET restapisfugvjdxtriresources3kzxbg5sa2methodsGET HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}20170223us-east-1apigatewayaws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response { "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGET", "name": GET, "title": GET }, "integration:put": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "method:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGET" }, "method:integration": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "method:responses": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200", "name": "200", "title": "200" }, "method:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGET" }, "methodresponse:put": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses{status_code}", "templated": true } }, "apiKeyRequired": false, "authorizationType": NONE, "httpMethod": GET, "_embedded": { "method:integration": { "_links": { "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "integration:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "integration:responses": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200", "name": "200", "title": "200" }, "integration:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "integrationresponse:put": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:roleapigAwsProxyRole", "httpMethod": POST, "passthroughBehavior": WHEN_NO_MATCH, "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "applicationjson": "{n}" }, "type": AWS, "uri": "arn:aws:apigateway:us-east-1:kinesis:actionListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" }, "integrationresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" } }, "responseParameters": { "method.response.header.Content-Type": "'applicationxml'" }, "responseTemplates": { "applicationjson": "$util.urlDecode("%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3Cname%3E%3Cstream%3E#end%3CkinesisStreams%3E")n" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200" }, "methodresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200" } }, "responseModels": { "application/json": Empty }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } } If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS@ .

rParentId :: Lens' Resource (Maybe Text)

The parent resource's identifier.