Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ApplicationAutoScaling.DeregisterScalableTarget

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use DescribeScalableTargets.

Deregistering a scalable target deletes the scaling policies and the scheduled actions that are associated with it.

Creating a Request

data DeregisterScalableTarget Source #

See: newDeregisterScalableTarget smart constructor.

Constructors

DeregisterScalableTarget'

Fields

serviceNamespace :: ServiceNamespace
The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
resourceId :: Text
The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
- ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
- Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
- EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
- AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
- DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
- DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
- Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
- SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
- Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
- Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
- Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
- Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
- Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
- Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
- Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
- Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
scalableDimension :: ScalableDimension
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
- ecs:service:DesiredCount - The desired task count of an ECS service.
- elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
- ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
- appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
- dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
- dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
- dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
- dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
- rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
- sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.
- custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
- comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
- comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
- lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
- cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
- cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
- kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
- elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
- elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
- neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

Instances

Instances details

Eq DeregisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget Methods (==) :: DeregisterScalableTarget -> DeregisterScalableTarget -> Bool # (/=) :: DeregisterScalableTarget -> DeregisterScalableTarget -> Bool #
Read DeregisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget Methods readsPrec :: Int -> ReadS DeregisterScalableTarget # readList :: ReadS [DeregisterScalableTarget] # readPrec :: ReadPrec DeregisterScalableTarget # readListPrec :: ReadPrec [DeregisterScalableTarget] #
Show DeregisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget Methods showsPrec :: Int -> DeregisterScalableTarget -> ShowS # show :: DeregisterScalableTarget -> String # showList :: [DeregisterScalableTarget] -> ShowS #
Generic DeregisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget Associated Types type Rep DeregisterScalableTarget :: Type -> Type # Methods from :: DeregisterScalableTarget -> Rep DeregisterScalableTarget x # to :: Rep DeregisterScalableTarget x -> DeregisterScalableTarget #
NFData DeregisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget Methods rnf :: DeregisterScalableTarget -> () #
Hashable DeregisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget Methods hashWithSalt :: Int -> DeregisterScalableTarget -> Int # hash :: DeregisterScalableTarget -> Int #
ToJSON DeregisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget Methods toJSON :: DeregisterScalableTarget -> Value # toEncoding :: DeregisterScalableTarget -> Encoding # toJSONList :: [DeregisterScalableTarget] -> Value # toEncodingList :: [DeregisterScalableTarget] -> Encoding #
AWSRequest DeregisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget Associated Types type AWSResponse DeregisterScalableTarget # Methods request :: DeregisterScalableTarget -> Request DeregisterScalableTarget # response :: MonadResource m => Logger -> Service -> Proxy DeregisterScalableTarget -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeregisterScalableTarget))) #
ToHeaders DeregisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget Methods toHeaders :: DeregisterScalableTarget -> [Header] #
ToPath DeregisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget Methods toPath :: DeregisterScalableTarget -> ByteString #
ToQuery DeregisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget Methods toQuery :: DeregisterScalableTarget -> QueryString #
type Rep DeregisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget type Rep DeregisterScalableTarget = D1 ('MetaData "DeregisterScalableTarget" "Amazonka.ApplicationAutoScaling.DeregisterScalableTarget" "libZSservicesZSamazonka-application-autoscalingZSamazonka-application-autoscaling" 'False) (C1 ('MetaCons "DeregisterScalableTarget'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serviceNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ServiceNamespace) :: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "scalableDimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScalableDimension))))
type AWSResponse DeregisterScalableTarget Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget type AWSResponse DeregisterScalableTarget = DeregisterScalableTargetResponse

newDeregisterScalableTarget Source #

Arguments

:: ServiceNamespace	`$sel:serviceNamespace:DeregisterScalableTarget'`
-> Text	`$sel:resourceId:DeregisterScalableTarget'`
-> ScalableDimension	`$sel:scalableDimension:DeregisterScalableTarget'`
-> DeregisterScalableTarget

Create a value of DeregisterScalableTarget 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:serviceNamespace:DeregisterScalableTarget', deregisterScalableTarget_serviceNamespace - The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.

$sel:resourceId:DeregisterScalableTarget', deregisterScalableTarget_resourceId - The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

$sel:scalableDimension:DeregisterScalableTarget', deregisterScalableTarget_scalableDimension - The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

ecs:service:DesiredCount - The desired task count of an ECS service.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

Request Lenses

deregisterScalableTarget_serviceNamespace :: Lens' DeregisterScalableTarget ServiceNamespace Source #

The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.

deregisterScalableTarget_resourceId :: Lens' DeregisterScalableTarget Text Source #

The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.
Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.

deregisterScalableTarget_scalableDimension :: Lens' DeregisterScalableTarget ScalableDimension Source #

The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

ecs:service:DesiredCount - The desired task count of an ECS service.
elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.
dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an SageMaker model endpoint variant.
custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.

Destructuring the Response

data DeregisterScalableTargetResponse Source #

See: newDeregisterScalableTargetResponse smart constructor.

Constructors

DeregisterScalableTargetResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DeregisterScalableTargetResponse Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget Methods (==) :: DeregisterScalableTargetResponse -> DeregisterScalableTargetResponse -> Bool # (/=) :: DeregisterScalableTargetResponse -> DeregisterScalableTargetResponse -> Bool #
Read DeregisterScalableTargetResponse Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget Methods readsPrec :: Int -> ReadS DeregisterScalableTargetResponse # readList :: ReadS [DeregisterScalableTargetResponse] # readPrec :: ReadPrec DeregisterScalableTargetResponse # readListPrec :: ReadPrec [DeregisterScalableTargetResponse] #
Show DeregisterScalableTargetResponse Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget Methods showsPrec :: Int -> DeregisterScalableTargetResponse -> ShowS # show :: DeregisterScalableTargetResponse -> String # showList :: [DeregisterScalableTargetResponse] -> ShowS #
Generic DeregisterScalableTargetResponse Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget Associated Types type Rep DeregisterScalableTargetResponse :: Type -> Type # Methods from :: DeregisterScalableTargetResponse -> Rep DeregisterScalableTargetResponse x # to :: Rep DeregisterScalableTargetResponse x -> DeregisterScalableTargetResponse #
NFData DeregisterScalableTargetResponse Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget Methods rnf :: DeregisterScalableTargetResponse -> () #
type Rep DeregisterScalableTargetResponse Source #
Instance details Defined in Amazonka.ApplicationAutoScaling.DeregisterScalableTarget type Rep DeregisterScalableTargetResponse = D1 ('MetaData "DeregisterScalableTargetResponse" "Amazonka.ApplicationAutoScaling.DeregisterScalableTarget" "libZSservicesZSamazonka-application-autoscalingZSamazonka-application-autoscaling" 'False) (C1 ('MetaCons "DeregisterScalableTargetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeregisterScalableTargetResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeregisterScalableTargetResponse'`
-> DeregisterScalableTargetResponse

Create a value of DeregisterScalableTargetResponse 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:httpStatus:DeregisterScalableTargetResponse', deregisterScalableTargetResponse_httpStatus - The response's http status code.

Response Lenses

deregisterScalableTargetResponse_httpStatus :: Lens' DeregisterScalableTargetResponse Int Source #

The response's http status code.