Amazonka.APIGateway.DeleteDeployment

Deletes a Deployment resource. Deleting a deployment will only succeed if there are no Stage resources associated with it.

Creating a Request

data DeleteDeployment

Requests API Gateway to delete a Deployment resource.

See: newDeleteDeployment smart constructor.

Constructors

DeleteDeployment'

Fields

• restApiId :: Text

  The string identifier of the associated RestApi.

• deploymentId :: Text

  The identifier of the Deployment resource to delete.

Instances

ToHeaders DeleteDeployment

Defined in Amazonka.APIGateway.DeleteDeployment

Methods

toHeaders :: DeleteDeployment -> [Header]

ToPath DeleteDeployment

Defined in Amazonka.APIGateway.DeleteDeployment

Methods

toPath :: DeleteDeployment -> ByteString

ToQuery DeleteDeployment

Defined in Amazonka.APIGateway.DeleteDeployment

Methods

toQuery :: DeleteDeployment -> QueryString

AWSRequest DeleteDeployment

Defined in Amazonka.APIGateway.DeleteDeployment

Associated Types

type AWSResponse DeleteDeployment

Methods

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

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

Generic DeleteDeployment

Defined in Amazonka.APIGateway.DeleteDeployment

Associated Types

type Rep DeleteDeployment :: Type -> Type

Methods

from :: DeleteDeployment -> Rep DeleteDeployment x

to :: Rep DeleteDeployment x -> DeleteDeployment

Read DeleteDeployment

Defined in Amazonka.APIGateway.DeleteDeployment

Methods

readsPrec :: Int -> ReadS DeleteDeployment

readList :: ReadS [DeleteDeployment]

readPrec :: ReadPrec DeleteDeployment

readListPrec :: ReadPrec [DeleteDeployment]

Show DeleteDeployment

Defined in Amazonka.APIGateway.DeleteDeployment

Methods

showsPrec :: Int -> DeleteDeployment -> ShowS

show :: DeleteDeployment -> String

showList :: [DeleteDeployment] -> ShowS

NFData DeleteDeployment

Defined in Amazonka.APIGateway.DeleteDeployment

Methods

rnf :: DeleteDeployment -> ()

Eq DeleteDeployment

Defined in Amazonka.APIGateway.DeleteDeployment

Methods

(==) :: DeleteDeployment -> DeleteDeployment -> Bool

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

Hashable DeleteDeployment

Defined in Amazonka.APIGateway.DeleteDeployment

Methods

hashWithSalt :: Int -> DeleteDeployment -> Int

hash :: DeleteDeployment -> Int

type AWSResponse DeleteDeployment

Defined in Amazonka.APIGateway.DeleteDeployment

type AWSResponse DeleteDeployment = DeleteDeploymentResponse

type Rep DeleteDeployment

Defined in Amazonka.APIGateway.DeleteDeployment

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

newDeleteDeployment

Arguments

:: Text

DeleteDeployment

-> Text

DeleteDeployment

-> DeleteDeployment

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

DeleteDeployment, deleteDeployment_restApiId - The string identifier of the associated RestApi.

DeleteDeployment, deleteDeployment_deploymentId - The identifier of the Deployment resource to delete.

Request Lenses

deleteDeployment_restApiId :: Lens' DeleteDeployment Text

The string identifier of the associated RestApi.

deleteDeployment_deploymentId :: Lens' DeleteDeployment Text

The identifier of the Deployment resource to delete.

Destructuring the Response

data DeleteDeploymentResponse

See: newDeleteDeploymentResponse smart constructor.

Constructors

DeleteDeploymentResponse'

Instances

Generic DeleteDeploymentResponse

Defined in Amazonka.APIGateway.DeleteDeployment

Associated Types

type Rep DeleteDeploymentResponse :: Type -> Type

Methods

from :: DeleteDeploymentResponse -> Rep DeleteDeploymentResponse x

to :: Rep DeleteDeploymentResponse x -> DeleteDeploymentResponse

Read DeleteDeploymentResponse

Defined in Amazonka.APIGateway.DeleteDeployment

Methods

readsPrec :: Int -> ReadS DeleteDeploymentResponse

readList :: ReadS [DeleteDeploymentResponse]

readPrec :: ReadPrec DeleteDeploymentResponse

readListPrec :: ReadPrec [DeleteDeploymentResponse]

Show DeleteDeploymentResponse

Defined in Amazonka.APIGateway.DeleteDeployment

Methods

showsPrec :: Int -> DeleteDeploymentResponse -> ShowS

show :: DeleteDeploymentResponse -> String

showList :: [DeleteDeploymentResponse] -> ShowS

NFData DeleteDeploymentResponse

Defined in Amazonka.APIGateway.DeleteDeployment

Methods

rnf :: DeleteDeploymentResponse -> ()

Eq DeleteDeploymentResponse

Defined in Amazonka.APIGateway.DeleteDeployment

Methods

(==) :: DeleteDeploymentResponse -> DeleteDeploymentResponse -> Bool

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

type Rep DeleteDeploymentResponse

Defined in Amazonka.APIGateway.DeleteDeployment

type Rep DeleteDeploymentResponse = D1 ('MetaData "DeleteDeploymentResponse" "Amazonka.APIGateway.DeleteDeployment" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteDeploymentResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteDeploymentResponse :: DeleteDeploymentResponse

Create a value of DeleteDeploymentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.