Amazon Elasticsearch Service
    Amazon Elasticsearch Service
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}/accept
      PUT
    • /2015-01-01/tags
      POST
    • /2015-01-01/packages/associate/{PackageID}/{DomainName}
      POST
    • /2015-01-01/es/domain/{DomainName}/authorizeVpcEndpointAccess
      POST
    • /2015-01-01/es/serviceSoftwareUpdate/cancel
      POST
    • /2015-01-01/es/domain
      POST
    • /2015-01-01/es/ccs/outboundConnection
      POST
    • /2015-01-01/packages
      POST
    • /2015-01-01/es/vpcEndpoints
      POST
    • /2015-01-01/es/vpcEndpoints
      GET
    • /2015-01-01/es/domain/{DomainName}
      DELETE
    • /2015-01-01/es/domain/{DomainName}
      GET
    • /2015-01-01/es/role
      DELETE
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}
      DELETE
    • /2015-01-01/es/ccs/outboundConnection/{ConnectionId}
      DELETE
    • /2015-01-01/packages/{PackageID}
      DELETE
    • /2015-01-01/es/vpcEndpoints/{VpcEndpointId}
      DELETE
    • /2015-01-01/es/domain/{DomainName}/autoTunes
      GET
    • /2015-01-01/es/domain/{DomainName}/progress
      GET
    • /2015-01-01/es/domain/{DomainName}/config
      GET
    • /2015-01-01/es/domain/{DomainName}/config
      POST
    • /2015-01-01/es/domain-info
      POST
    • /2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}
      GET
    • /2015-01-01/es/ccs/inboundConnection/search
      POST
    • /2015-01-01/es/ccs/outboundConnection/search
      POST
    • /2015-01-01/packages/describe
      POST
    • /2015-01-01/es/reservedInstanceOfferings
      GET
    • /2015-01-01/es/reservedInstances
      GET
    • /2015-01-01/es/vpcEndpoints/describe
      POST
    • /2015-01-01/packages/dissociate/{PackageID}/{DomainName}
      POST
    • /2015-01-01/es/compatibleVersions
      GET
    • /2015-01-01/packages/{PackageID}/history
      GET
    • /2015-01-01/es/upgradeDomain/{DomainName}/history
      GET
    • /2015-01-01/es/upgradeDomain/{DomainName}/status
      GET
    • /2015-01-01/domain
      GET
    • /2015-01-01/packages/{PackageID}/domains
      GET
    • /2015-01-01/es/instanceTypes/{ElasticsearchVersion}
      GET
    • /2015-01-01/es/versions
      GET
    • /2015-01-01/domain/{DomainName}/packages
      GET
    • /2015-01-01/tags/
      GET
    • /2015-01-01/es/domain/{DomainName}/listVpcEndpointAccess
      GET
    • /2015-01-01/es/domain/{DomainName}/vpcEndpoints
      GET
    • /2015-01-01/es/purchaseReservedInstanceOffering
      POST
    • /2015-01-01/es/ccs/inboundConnection/{ConnectionId}/reject
      PUT
    • /2015-01-01/tags-removal
      POST
    • /2015-01-01/es/domain/{DomainName}/revokeVpcEndpointAccess
      POST
    • /2015-01-01/es/serviceSoftwareUpdate/start
      POST
    • /2015-01-01/packages/update
      POST
    • /2015-01-01/es/vpcEndpoints/update
      POST
    • /2015-01-01/es/upgradeDomain
      POST

      /2015-01-01/es/domain/{DomainName}/config

      The Amazon Elasticsearch Service multi-region endpoint
      http://es.{region}.amazonaws.com
      The Amazon Elasticsearch Service multi-region endpoint
      http://es.{region}.amazonaws.com
      POST
      /2015-01-01/es/domain/{DomainName}/config
      Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request POST 'http://es.{region}.amazonaws.com/2015-01-01/es/domain//config' \
      --header 'Content-Type: application/json' \
      --data-raw '{
          "ElasticsearchClusterConfig": {
              "InstanceType": "m3.medium.elasticsearch",
              "InstanceCount": 0,
              "DedicatedMasterEnabled": true,
              "ZoneAwarenessEnabled": true,
              "ZoneAwarenessConfig": {
                  "AvailabilityZoneCount": 0
              },
              "DedicatedMasterType": "m3.medium.elasticsearch",
              "DedicatedMasterCount": 0,
              "WarmEnabled": true,
              "WarmType": "ultrawarm1.medium.elasticsearch",
              "WarmCount": 0,
              "ColdStorageOptions": {
                  "Enabled": true
              }
          },
          "EBSOptions": {
              "EBSEnabled": true,
              "VolumeType": "standard",
              "VolumeSize": 0,
              "Iops": 0,
              "Throughput": 0
          },
          "SnapshotOptions": {
              "AutomatedSnapshotStartHour": 0
          },
          "VPCOptions": {
              "SubnetIds": [],
              "SecurityGroupIds": []
          },
          "CognitoOptions": {
              "Enabled": true,
              "UserPoolId": "string",
              "IdentityPoolId": "string",
              "RoleArn": "string"
          },
          "AdvancedOptions": {
              "property1": "string",
              "property2": "string"
          },
          "AccessPolicies": "string",
          "LogPublishingOptions": {
              "property1": {
                  "CloudWatchLogsLogGroupArn": "string",
                  "Enabled": true
              }
          },
          "DomainEndpointOptions": {
              "EnforceHTTPS": true,
              "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07",
              "CustomEndpointEnabled": true,
              "CustomEndpoint": "string",
              "CustomEndpointCertificateArn": "string"
          },
          "AdvancedSecurityOptions": {
              "Enabled": true,
              "InternalUserDatabaseEnabled": true,
              "MasterUserOptions": {
                  "MasterUserARN": "string",
                  "MasterUserName": "string",
                  "MasterUserPassword": "string"
              },
              "SAMLOptions": {
                  "Enabled": true,
                  "Idp": {
                      "MetadataContent": "string",
                      "EntityId": "string"
                  },
                  "MasterUserName": "string",
                  "MasterBackendRole": "string",
                  "SubjectKey": "string",
                  "RolesKey": "string",
                  "SessionTimeoutMinutes": 0
              },
              "AnonymousAuthEnabled": true
          },
          "NodeToNodeEncryptionOptions": {
              "Enabled": true
          },
          "EncryptionAtRestOptions": {
              "Enabled": true,
              "KmsKeyId": "string"
          },
          "AutoTuneOptions": {
              "DesiredState": "ENABLED",
              "RollbackOnDisable": "NO_ROLLBACK",
              "MaintenanceSchedules": []
          },
          "DryRun": true
      }'
      Response Response Example
      200 - Example 1
      {
          "DomainConfig": {
              "ElasticsearchVersion": {
                  "Options": "string",
                  "Status": {
                      "CreationDate": "string",
                      "UpdateDate": "string",
                      "UpdateVersion": 0,
                      "State": "RequiresIndexDocuments",
                      "PendingDeletion": true
                  }
              },
              "ElasticsearchClusterConfig": {
                  "Options": {
                      "InstanceType": "m3.medium.elasticsearch",
                      "InstanceCount": 0,
                      "DedicatedMasterEnabled": true,
                      "ZoneAwarenessEnabled": true,
                      "ZoneAwarenessConfig": {
                          "AvailabilityZoneCount": 0
                      },
                      "DedicatedMasterType": "m3.medium.elasticsearch",
                      "DedicatedMasterCount": 0,
                      "WarmEnabled": true,
                      "WarmType": "ultrawarm1.medium.elasticsearch",
                      "WarmCount": 0,
                      "ColdStorageOptions": {
                          "Enabled": true
                      }
                  },
                  "Status": {}
              },
              "EBSOptions": {
                  "Options": {
                      "EBSEnabled": true,
                      "VolumeType": "standard",
                      "VolumeSize": 0,
                      "Iops": 0,
                      "Throughput": 0
                  },
                  "Status": {}
              },
              "AccessPolicies": {
                  "Options": "string",
                  "Status": {}
              },
              "SnapshotOptions": {
                  "Options": {
                      "AutomatedSnapshotStartHour": 0
                  },
                  "Status": {}
              },
              "VPCOptions": {
                  "Options": {
                      "VPCId": "string",
                      "SubnetIds": [],
                      "AvailabilityZones": [],
                      "SecurityGroupIds": []
                  },
                  "Status": {}
              },
              "CognitoOptions": {
                  "Options": {
                      "Enabled": true,
                      "UserPoolId": "string",
                      "IdentityPoolId": "string",
                      "RoleArn": "string"
                  },
                  "Status": {}
              },
              "EncryptionAtRestOptions": {
                  "Options": {
                      "Enabled": true,
                      "KmsKeyId": "string"
                  },
                  "Status": {}
              },
              "NodeToNodeEncryptionOptions": {
                  "Options": {
                      "Enabled": true
                  },
                  "Status": {}
              },
              "AdvancedOptions": {},
              "LogPublishingOptions": {
                  "Options": {
                      "property1": {
                          "CloudWatchLogsLogGroupArn": "string",
                          "Enabled": true
                      }
                  },
                  "Status": {}
              },
              "DomainEndpointOptions": {
                  "Options": {
                      "EnforceHTTPS": true,
                      "TLSSecurityPolicy": "Policy-Min-TLS-1-0-2019-07",
                      "CustomEndpointEnabled": true,
                      "CustomEndpoint": "string",
                      "CustomEndpointCertificateArn": "string"
                  },
                  "Status": {}
              },
              "AdvancedSecurityOptions": {
                  "Options": {
                      "Enabled": true,
                      "InternalUserDatabaseEnabled": true,
                      "SAMLOptions": {
                          "Enabled": true,
                          "Idp": {
                              "MetadataContent": "string",
                              "EntityId": "string"
                          },
                          "SubjectKey": "string",
                          "RolesKey": "string",
                          "SessionTimeoutMinutes": 0
                      },
                      "AnonymousAuthDisableDate": "string",
                      "AnonymousAuthEnabled": true
                  },
                  "Status": {}
              },
              "AutoTuneOptions": {
                  "Options": {
                      "DesiredState": "ENABLED",
                      "RollbackOnDisable": "NO_ROLLBACK",
                      "MaintenanceSchedules": []
                  },
                  "Status": {
                      "CreationDate": "string",
                      "UpdateDate": "string",
                      "UpdateVersion": 0,
                      "State": "ENABLED",
                      "ErrorMessage": "string",
                      "PendingDeletion": true
                  }
              },
              "ChangeProgressDetails": {
                  "ChangeId": "string",
                  "Message": "string"
              }
          },
          "DryRunResults": {
              "DeploymentType": "string",
              "Message": "string"
          }
      }

      Request

      Path Params

      Body Params application/json

      Examples

      Responses

      🟢200Success
      application/json
      Body

      🟠480BaseException
      🟠481InternalException
      🟠482InvalidTypeException
      🟠483LimitExceededException
      🟠484ResourceNotFoundException
      🟠485ValidationException
      Modified at 2023-08-15 04:15:53
      Previous
      /2015-01-01/es/domain/{DomainName}/config
      Next
      /2015-01-01/es/domain-info
      Built with