Amazonka.APIGateway.CreateResource

Creates a Resource resource.

Creating a Request

data CreateResource

Requests API Gateway to create a Resource resource.

See: newCreateResource smart constructor.

Constructors

CreateResource'

Fields

• restApiId :: Text

  The string identifier of the associated RestApi.

• parentId :: Text

  The parent resource's identifier.

• pathPart :: Text

  The last path segment for this resource.

Instances

ToJSON CreateResource

Defined in Amazonka.APIGateway.CreateResource

Methods

toJSON :: CreateResource -> Value

toEncoding :: CreateResource -> Encoding

toJSONList :: [CreateResource] -> Value

toEncodingList :: [CreateResource] -> Encoding

ToHeaders CreateResource

Defined in Amazonka.APIGateway.CreateResource

Methods

toHeaders :: CreateResource -> [Header]

ToPath CreateResource

Defined in Amazonka.APIGateway.CreateResource

Methods

toPath :: CreateResource -> ByteString

ToQuery CreateResource

Defined in Amazonka.APIGateway.CreateResource

Methods

toQuery :: CreateResource -> QueryString

AWSRequest CreateResource

Defined in Amazonka.APIGateway.CreateResource

Associated Types

type AWSResponse CreateResource

Methods

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

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

Generic CreateResource

Defined in Amazonka.APIGateway.CreateResource

Associated Types

type Rep CreateResource :: Type -> Type

Methods

from :: CreateResource -> Rep CreateResource x

to :: Rep CreateResource x -> CreateResource

Read CreateResource

Defined in Amazonka.APIGateway.CreateResource

Methods

readsPrec :: Int -> ReadS CreateResource

readList :: ReadS [CreateResource]

readPrec :: ReadPrec CreateResource

readListPrec :: ReadPrec [CreateResource]

Show CreateResource

Defined in Amazonka.APIGateway.CreateResource

Methods

showsPrec :: Int -> CreateResource -> ShowS

show :: CreateResource -> String

showList :: [CreateResource] -> ShowS

NFData CreateResource

Defined in Amazonka.APIGateway.CreateResource

Methods

rnf :: CreateResource -> ()

Eq CreateResource

Defined in Amazonka.APIGateway.CreateResource

Methods

(==) :: CreateResource -> CreateResource -> Bool

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

Hashable CreateResource

Defined in Amazonka.APIGateway.CreateResource

Methods

hashWithSalt :: Int -> CreateResource -> Int

hash :: CreateResource -> Int

type AWSResponse CreateResource

Defined in Amazonka.APIGateway.CreateResource

type AWSResponse CreateResource = Resource

type Rep CreateResource

Defined in Amazonka.APIGateway.CreateResource

type Rep CreateResource = D1 ('MetaData "CreateResource" "Amazonka.APIGateway.CreateResource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "parentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "pathPart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateResource

Arguments

:: Text

CreateResource

-> Text

CreateResource

-> Text

CreateResource

-> CreateResource

Create a value of CreateResource 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:

CreateResource, createResource_restApiId - The string identifier of the associated RestApi.

CreateResource, createResource_parentId - The parent resource's identifier.

CreateResource, createResource_pathPart - The last path segment for this resource.

Request Lenses

createResource_restApiId :: Lens' CreateResource Text

The string identifier of the associated RestApi.

createResource_parentId :: Lens' CreateResource Text

The parent resource's identifier.

createResource_pathPart :: Lens' CreateResource Text

The last path segment for this 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.