libZSservicesZSamazonka-lightsailZSamazonka-lightsail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Lightsail.DeleteBucket

Description

Deletes a Amazon Lightsail bucket.

When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another AWS account.

Synopsis

Creating a Request

data DeleteBucket Source #

See: newDeleteBucket smart constructor.

Constructors

DeleteBucket' 

Fields

  • forceDelete :: Maybe Bool

    A Boolean value that indicates whether to force delete the bucket.

    You must force delete the bucket if it has one of the following conditions:

    • The bucket is the origin of a distribution.
    • The bucket has instances that were granted access to it using the SetResourceAccessForBucket action.
    • The bucket has objects.
    • The bucket has access keys.

    Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys.

  • bucketName :: Text

    The name of the bucket to delete.

    Use the GetBuckets action to get a list of bucket names that you can specify.

Instances

Instances details
Eq DeleteBucket Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

Methods

(==) :: DeleteBucket -> DeleteBucket -> Bool #

(/=) :: DeleteBucket -> DeleteBucket -> Bool #

Read DeleteBucket Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

Methods

readsPrec :: Int -> ReadS DeleteBucket #

readList :: ReadS [DeleteBucket] #

readPrec :: ReadPrec DeleteBucket #

readListPrec :: ReadPrec [DeleteBucket] #

Show DeleteBucket Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

Methods

showsPrec :: Int -> DeleteBucket -> ShowS #

show :: DeleteBucket -> String #

showList :: [DeleteBucket] -> ShowS #

Generic DeleteBucket Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

Associated Types

type Rep DeleteBucket :: Type -> Type #

Methods

from :: DeleteBucket -> Rep DeleteBucket x #

to :: Rep DeleteBucket x -> DeleteBucket #

NFData DeleteBucket Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

Methods

rnf :: DeleteBucket -> () #

Hashable DeleteBucket Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

Methods

hashWithSalt :: Int -> DeleteBucket -> Int #

hash :: DeleteBucket -> Int #

ToJSON DeleteBucket Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

Methods

toJSON :: DeleteBucket -> Value #

toEncoding :: DeleteBucket -> Encoding #

toJSONList :: [DeleteBucket] -> Value #

toEncodingList :: [DeleteBucket] -> Encoding #

AWSRequest DeleteBucket Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

Associated Types

type AWSResponse DeleteBucket #

Methods

request :: DeleteBucket -> Request DeleteBucket #

response :: MonadResource m => Logger -> Service -> Proxy DeleteBucket -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteBucket))) #

ToHeaders DeleteBucket Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

Methods

toHeaders :: DeleteBucket -> [Header] #

ToPath DeleteBucket Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

Methods

toPath :: DeleteBucket -> ByteString #

ToQuery DeleteBucket Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

Methods

toQuery :: DeleteBucket -> QueryString #

type Rep DeleteBucket Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

type Rep DeleteBucket = D1 ('MetaData "DeleteBucket" "Amazonka.Lightsail.DeleteBucket" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "DeleteBucket'" 'PrefixI 'True) (S1 ('MetaSel ('Just "forceDelete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "bucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeleteBucket Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

type AWSResponse DeleteBucket = DeleteBucketResponse

newDeleteBucket Source #

Arguments

:: Text

$sel:bucketName:DeleteBucket'

-> DeleteBucket 

Create a value of DeleteBucket 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:forceDelete:DeleteBucket', deleteBucket_forceDelete - A Boolean value that indicates whether to force delete the bucket.

You must force delete the bucket if it has one of the following conditions:

  • The bucket is the origin of a distribution.
  • The bucket has instances that were granted access to it using the SetResourceAccessForBucket action.
  • The bucket has objects.
  • The bucket has access keys.

Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys.

$sel:bucketName:DeleteBucket', deleteBucket_bucketName - The name of the bucket to delete.

Use the GetBuckets action to get a list of bucket names that you can specify.

Request Lenses

deleteBucket_forceDelete :: Lens' DeleteBucket (Maybe Bool) Source #

A Boolean value that indicates whether to force delete the bucket.

You must force delete the bucket if it has one of the following conditions:

  • The bucket is the origin of a distribution.
  • The bucket has instances that were granted access to it using the SetResourceAccessForBucket action.
  • The bucket has objects.
  • The bucket has access keys.

Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys.

deleteBucket_bucketName :: Lens' DeleteBucket Text Source #

The name of the bucket to delete.

Use the GetBuckets action to get a list of bucket names that you can specify.

Destructuring the Response

data DeleteBucketResponse Source #

See: newDeleteBucketResponse smart constructor.

Constructors

DeleteBucketResponse' 

Fields

  • operations :: Maybe [Operation]

    An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DeleteBucketResponse Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

Methods

(==) :: DeleteBucketResponse -> DeleteBucketResponse -> Bool #

(/=) :: DeleteBucketResponse -> DeleteBucketResponse -> Bool #

Read DeleteBucketResponse Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

Methods

readsPrec :: Int -> ReadS DeleteBucketResponse #

readList :: ReadS [DeleteBucketResponse] #

readPrec :: ReadPrec DeleteBucketResponse #

readListPrec :: ReadPrec [DeleteBucketResponse] #

Show DeleteBucketResponse Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

Methods

showsPrec :: Int -> DeleteBucketResponse -> ShowS #

show :: DeleteBucketResponse -> String #

showList :: [DeleteBucketResponse] -> ShowS #

Generic DeleteBucketResponse Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

Associated Types

type Rep DeleteBucketResponse :: Type -> Type #

Methods

from :: DeleteBucketResponse -> Rep DeleteBucketResponse x #

to :: Rep DeleteBucketResponse x -> DeleteBucketResponse #

NFData DeleteBucketResponse Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

Methods

rnf :: DeleteBucketResponse -> () #

type Rep DeleteBucketResponse Source # 
Instance details

Defined in Amazonka.Lightsail.DeleteBucket

type Rep DeleteBucketResponse = D1 ('MetaData "DeleteBucketResponse" "Amazonka.Lightsail.DeleteBucket" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "DeleteBucketResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Operation])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteBucketResponse Source #

Arguments

:: Int

$sel:httpStatus:DeleteBucketResponse'

-> DeleteBucketResponse 

Create a value of DeleteBucketResponse 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:operations:DeleteBucketResponse', deleteBucketResponse_operations - An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

$sel:httpStatus:DeleteBucketResponse', deleteBucketResponse_httpStatus - The response's http status code.

Response Lenses

deleteBucketResponse_operations :: Lens' DeleteBucketResponse (Maybe [Operation]) Source #

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

deleteBucketResponse_httpStatus :: Lens' DeleteBucketResponse Int Source #

The response's http status code.