Amazonka.APIGateway.UpdateResource

Changes information about a Resource resource.

Creating a Request

data UpdateResource

Request to change information about a Resource resource.

See: newUpdateResource smart constructor.

Constructors

UpdateResource'

Fields

• patchOperations :: Maybe [PatchOperation]

  For more information about supported patch operations, see Patch Operations.

• restApiId :: Text

  The string identifier of the associated RestApi.

• resourceId :: Text

  The identifier of the Resource resource.

Instances

ToJSON UpdateResource

Defined in Amazonka.APIGateway.UpdateResource

Methods

toJSON :: UpdateResource -> Value

toEncoding :: UpdateResource -> Encoding

toJSONList :: [UpdateResource] -> Value

toEncodingList :: [UpdateResource] -> Encoding

ToHeaders UpdateResource

Defined in Amazonka.APIGateway.UpdateResource

Methods

toHeaders :: UpdateResource -> [Header]

ToPath UpdateResource

Defined in Amazonka.APIGateway.UpdateResource

Methods

toPath :: UpdateResource -> ByteString

ToQuery UpdateResource

Defined in Amazonka.APIGateway.UpdateResource

Methods

toQuery :: UpdateResource -> QueryString

AWSRequest UpdateResource

Defined in Amazonka.APIGateway.UpdateResource

Associated Types

type AWSResponse UpdateResource

Methods

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

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

Generic UpdateResource

Defined in Amazonka.APIGateway.UpdateResource

Associated Types

type Rep UpdateResource :: Type -> Type

Methods

from :: UpdateResource -> Rep UpdateResource x

to :: Rep UpdateResource x -> UpdateResource

Read UpdateResource

Defined in Amazonka.APIGateway.UpdateResource

Methods

readsPrec :: Int -> ReadS UpdateResource

readList :: ReadS [UpdateResource]

readPrec :: ReadPrec UpdateResource

readListPrec :: ReadPrec [UpdateResource]

Show UpdateResource

Defined in Amazonka.APIGateway.UpdateResource

Methods

showsPrec :: Int -> UpdateResource -> ShowS

show :: UpdateResource -> String

showList :: [UpdateResource] -> ShowS

NFData UpdateResource

Defined in Amazonka.APIGateway.UpdateResource

Methods

rnf :: UpdateResource -> ()

Eq UpdateResource

Defined in Amazonka.APIGateway.UpdateResource

Methods

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

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

Hashable UpdateResource

Defined in Amazonka.APIGateway.UpdateResource

Methods

hashWithSalt :: Int -> UpdateResource -> Int

hash :: UpdateResource -> Int

type AWSResponse UpdateResource

Defined in Amazonka.APIGateway.UpdateResource

type AWSResponse UpdateResource = Resource

type Rep UpdateResource

Defined in Amazonka.APIGateway.UpdateResource

type Rep UpdateResource = D1 ('MetaData "UpdateResource" "Amazonka.APIGateway.UpdateResource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateResource

Arguments

:: Text

UpdateResource

-> Text

$sel:resourceId:UpdateResource'

-> UpdateResource

Create a value of UpdateResource 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:patchOperations:UpdateResource', updateResource_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateResource, updateResource_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:UpdateResource', updateResource_resourceId - The identifier of the Resource resource.

Request Lenses

updateResource_patchOperations :: Lens' UpdateResource (Maybe [PatchOperation])

For more information about supported patch operations, see Patch Operations.

updateResource_restApiId :: Lens' UpdateResource Text

The string identifier of the associated RestApi.

updateResource_resourceId :: Lens' UpdateResource Text

The identifier of the Resource resource.

Destructuring the Response

data Resource

Represents an API resource.

See: newResource smart constructor.

Constructors

Resource'

Fields

• id :: Maybe Text

  The resource's identifier.

• parentId :: Maybe Text

  The parent resource's identifier.

• path :: Maybe Text

  The full path for this resource.

• pathPart :: Maybe Text

  The last path segment for this resource.

• resourceMethods :: Maybe (HashMap Text Method)

  Gets an API resource's method of a given HTTP verb.

Instances

FromJSON Resource

Defined in Amazonka.APIGateway.Types.Resource

Methods

parseJSON :: Value -> Parser Resource

parseJSONList :: Value -> Parser [Resource]

Generic Resource

Defined in Amazonka.APIGateway.Types.Resource

Associated Types

type Rep Resource :: Type -> Type

Methods

from :: Resource -> Rep Resource x

to :: Rep Resource x -> Resource

Read Resource

Defined in Amazonka.APIGateway.Types.Resource

Methods

readsPrec :: Int -> ReadS Resource

readList :: ReadS [Resource]

readPrec :: ReadPrec Resource

readListPrec :: ReadPrec [Resource]

Show Resource

Defined in Amazonka.APIGateway.Types.Resource

Methods

showsPrec :: Int -> Resource -> ShowS

show :: Resource -> String

showList :: [Resource] -> ShowS

NFData Resource

Defined in Amazonka.APIGateway.Types.Resource

Methods

rnf :: Resource -> ()

Eq Resource

Defined in Amazonka.APIGateway.Types.Resource

Methods

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

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

Hashable Resource

Defined in Amazonka.APIGateway.Types.Resource

Methods

hashWithSalt :: Int -> Resource -> Int

hash :: Resource -> Int

type Rep Resource

Defined in Amazonka.APIGateway.Types.Resource

type Rep Resource = D1 ('MetaData "Resource" "Amazonka.APIGateway.Types.Resource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Resource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "parentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "pathPart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceMethods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Method)))))))

newResource :: Resource

Create a value of Resource 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:id:Resource', resource_id - The resource's identifier.

$sel:parentId:Resource', resource_parentId - The parent resource's identifier.

$sel:path:Resource', resource_path - The full path for this resource.

$sel:pathPart:Resource', resource_pathPart - The last path segment for this resource.

$sel:resourceMethods:Resource', resource_resourceMethods - Gets an API resource's method of a given HTTP verb.

Response Lenses

resource_id :: Lens' Resource (Maybe Text)

The resource's identifier.

resource_parentId :: Lens' Resource (Maybe Text)

The parent resource's identifier.

resource_path :: Lens' Resource (Maybe Text)

The full path for this resource.

resource_pathPart :: Lens' Resource (Maybe Text)

The last path segment for this resource.

resource_resourceMethods :: Lens' Resource (Maybe (HashMap Text Method))

Gets an API resource's method of a given HTTP verb.