Serialized Form

  • optionGroupName

    String optionGroupName

    The name of the option group for the new DB cluster.

  • port

    Integer port

    The port number on which the new DB cluster accepts connections.

    Constraints: Value must be 1150-65535

    Default: The same port as the original DB cluster.

  • restoreToTime

    Date restoreToTime

    The date and time to restore the DB cluster to.

    Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

    Constraints:

    • Must be before the latest restorable time for the DB instance
    • Cannot be specified if UseLatestRestorableTime parameter is true

    Example: 2015-03-07T23:45:00Z

  • sourceDBClusterIdentifier

    String sourceDBClusterIdentifier

    The identifier of the source DB cluster from which to restore.

    Constraints:

    • Must be the identifier of an existing database instance
    • Must contain from 1 to 63 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
  • tags

    com.amazonaws.internal.SdkInternalList<Tag> tags
  • useLatestRestorableTime

    Boolean useLatestRestorableTime

    A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

    Default: false

    Constraints: Cannot be specified if RestoreToTime parameter is provided.

  • vpcSecurityGroupIds

    com.amazonaws.internal.SdkInternalList<String> vpcSecurityGroupIds

    A lst of VPC security groups that the new DB cluster belongs to.

  • Class com.amazonaws.services.rds.model.RestoreDBInstanceFromDBSnapshotRequest extends AmazonWebServiceRequest implements Serializable

  • Class com.amazonaws.services.rds.model.RestoreDBInstanceToPointInTimeRequest extends AmazonWebServiceRequest implements Serializable

  • Class com.amazonaws.services.rds.model.RevokeDBSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable

  • Class com.amazonaws.services.rds.model.SharedSnapshotQuotaExceededException extends AmazonServiceException implements Serializable

    serialVersionUID:
    1L
  • Class com.amazonaws.services.rds.model.SnapshotQuotaExceededException extends AmazonServiceException implements Serializable

    serialVersionUID:
    1L
  • Class com.amazonaws.services.rds.model.SNSInvalidTopicException extends AmazonServiceException implements Serializable

    serialVersionUID:
    1L
  • Class com.amazonaws.services.rds.model.SNSNoAuthorizationException extends AmazonServiceException implements Serializable

    serialVersionUID:
    1L
  • Class com.amazonaws.services.rds.model.SNSTopicArnNotFoundException extends AmazonServiceException implements Serializable

    serialVersionUID:
    1L
  • Class com.amazonaws.services.rds.model.SourceNotFoundException extends AmazonServiceException implements Serializable

    serialVersionUID:
    1L
  • Class com.amazonaws.services.rds.model.StorageQuotaExceededException extends AmazonServiceException implements Serializable

    serialVersionUID:
    1L
  • Class com.amazonaws.services.rds.model.StorageTypeNotSupportedException extends AmazonServiceException implements Serializable

    serialVersionUID:
    1L
  • Class com.amazonaws.services.rds.model.Subnet extends Object implements Serializable

  • Class com.amazonaws.services.rds.model.SubnetAlreadyInUseException extends AmazonServiceException implements Serializable

    serialVersionUID:
    1L
  • Class com.amazonaws.services.rds.model.SubscriptionAlreadyExistException extends AmazonServiceException implements Serializable

    serialVersionUID:
    1L
  • Class com.amazonaws.services.rds.model.SubscriptionCategoryNotFoundException extends AmazonServiceException implements Serializable

    serialVersionUID:
    1L
  • Class com.amazonaws.services.rds.model.SubscriptionNotFoundException extends AmazonServiceException implements Serializable

    serialVersionUID:
    1L
  • Class com.amazonaws.services.rds.model.Tag extends Object implements Serializable

  • Class com.amazonaws.services.rds.model.UpgradeTarget extends Object implements Serializable

  • Class com.amazonaws.services.rds.model.VpcSecurityGroupMembership extends Object implements Serializable

  • Package com.amazonaws.services.redshift.model

    • Class com.amazonaws.services.redshift.model.AccessToSnapshotDeniedException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.AccountWithRestoreAccess extends Object implements Serializable

      • Serialized Fields

        • accountId

          String accountId

          The identifier of an AWS customer account authorized to restore a snapshot.

    • Class com.amazonaws.services.redshift.model.AuthorizationAlreadyExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.AuthorizationNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.AuthorizationQuotaExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.AuthorizeClusterSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • cIDRIP

          String cIDRIP

          The IP range to be added the Amazon Redshift security group.

        • clusterSecurityGroupName

          String clusterSecurityGroupName

          The name of the security group to which the ingress rule is added.

        • eC2SecurityGroupName

          String eC2SecurityGroupName

          The EC2 security group to be added the Amazon Redshift security group.

        • eC2SecurityGroupOwnerId

          String eC2SecurityGroupOwnerId

          The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.

          Example: 111122223333

    • Class com.amazonaws.services.redshift.model.AuthorizeSnapshotAccessRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • accountWithRestoreAccess

          String accountWithRestoreAccess

          The identifier of the AWS customer account authorized to restore the specified snapshot.

        • snapshotClusterIdentifier

          String snapshotClusterIdentifier

          The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

        • snapshotIdentifier

          String snapshotIdentifier

          The identifier of the snapshot the account is authorized to restore.

    • Class com.amazonaws.services.redshift.model.AvailabilityZone extends Object implements Serializable

      • Serialized Fields

        • name

          String name

          The name of the availability zone.

    • Class com.amazonaws.services.redshift.model.BucketNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.Cluster extends Object implements Serializable

      • Serialized Fields

        • allowVersionUpgrade

          Boolean allowVersionUpgrade

          If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

        • automatedSnapshotRetentionPeriod

          Integer automatedSnapshotRetentionPeriod

          The number of days that automatic cluster snapshots are retained.

        • availabilityZone

          String availabilityZone

          The name of the Availability Zone in which the cluster is located.

        • clusterCreateTime

          Date clusterCreateTime

          The date and time that the cluster was created.

        • clusterIdentifier

          String clusterIdentifier

          The unique identifier of the cluster.

        • clusterNodes

          com.amazonaws.internal.SdkInternalList<ClusterNode> clusterNodes

          The nodes in a cluster.

        • clusterParameterGroups

          com.amazonaws.internal.SdkInternalList<ClusterParameterGroupStatus> clusterParameterGroups

          The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

        • clusterPublicKey

          String clusterPublicKey

          The public key for the cluster.

        • clusterRevisionNumber

          String clusterRevisionNumber

          The specific revision number of the database in the cluster.

        • clusterSecurityGroups

          com.amazonaws.internal.SdkInternalList<ClusterSecurityGroupMembership> clusterSecurityGroups

          A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.

          Cluster security groups are used when the cluster is not created in a VPC. Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

        • clusterSnapshotCopyStatus

          ClusterSnapshotCopyStatus clusterSnapshotCopyStatus

          Returns the destination region and retention period that are configured for cross-region snapshot copy.

        • clusterStatus

          String clusterStatus

          The current state of the cluster. Possible values are:

          • available
          • creating
          • deleting
          • final-snapshot
          • hardware-failure
          • incompatible-hsm
          • incompatible-network
          • incompatible-parameters
          • incompatible-restore
          • modifying
          • rebooting
          • renaming
          • resizing
          • rotating-keys
          • storage-full
          • updating-hsm

        • clusterSubnetGroupName

          String clusterSubnetGroupName

          The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

        • clusterVersion

          String clusterVersion

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • dBName

          String dBName

          The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named "dev" was created by default.

        • elasticIpStatus

          ElasticIpStatus elasticIpStatus

          The status of the elastic IP (EIP) address.

        • encrypted

          Boolean encrypted

          If true, data in the cluster is encrypted at rest.

        • endpoint

          Endpoint endpoint

          The connection endpoint.

        • hsmStatus

          HsmStatus hsmStatus

          Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.

          Values: active, applying

        • iamRoles

          com.amazonaws.internal.SdkInternalList<ClusterIamRole> iamRoles

          A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

        • kmsKeyId

          String kmsKeyId

          The AWS Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.

        • masterUsername

          String masterUsername

          The master user name for the cluster. This name is used to connect to the database that is specified in DBName.

        • modifyStatus

          String modifyStatus

          The status of a modify operation, if any, initiated for the cluster.

        • nodeType

          String nodeType

          The node type for the nodes in the cluster.

        • numberOfNodes

          Integer numberOfNodes

          The number of compute nodes in the cluster.

        • pendingModifiedValues

          PendingModifiedValues pendingModifiedValues

          If present, changes to the cluster are pending. Specific pending changes are identified by subelements.

        • preferredMaintenanceWindow

          String preferredMaintenanceWindow

          The weekly time range (in UTC) during which system maintenance can occur.

        • publiclyAccessible

          Boolean publiclyAccessible

          If true, the cluster can be accessed from a public network.

        • restoreStatus

          RestoreStatus restoreStatus

          Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          The list of tags for the cluster.

        • vpcId

          String vpcId

          The identifier of the VPC the cluster is in, if the cluster is in a VPC.

        • vpcSecurityGroups

          com.amazonaws.internal.SdkInternalList<VpcSecurityGroupMembership> vpcSecurityGroups

          A list of Virtual Private Cloud (VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

    • Class com.amazonaws.services.redshift.model.ClusterAlreadyExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ClusterIamRole extends Object implements Serializable

      • Serialized Fields

        • applyStatus

          String applyStatus

          Describes the status of the IAM role's association with an Amazon Redshift cluster.

          The following are possible statuses and descriptions.

          • in-sync: The role is available for use by the cluster.
          • adding: The role is in the process of being associated with the cluster.
          • removing: The role is in the process of being disassociated with the cluster.

        • iamRoleArn

          String iamRoleArn

          The Amazon Resource Name (ARN) of the IAM role. For example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

    • Class com.amazonaws.services.redshift.model.ClusterNode extends Object implements Serializable

      • Serialized Fields

        • nodeRole

          String nodeRole

          Whether the node is a leader node or a compute node.

        • privateIPAddress

          String privateIPAddress

          The private IP address of a node within a cluster.

        • publicIPAddress

          String publicIPAddress

          The public IP address of a node within a cluster.

    • Class com.amazonaws.services.redshift.model.ClusterNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ClusterParameterGroup extends Object implements Serializable

      • Serialized Fields

        • description

          String description

          The description of the parameter group.

        • parameterGroupFamily

          String parameterGroupFamily

          The name of the cluster parameter group family that this cluster parameter group is compatible with.

        • parameterGroupName

          String parameterGroupName

          The name of the cluster parameter group.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          The list of tags for the cluster parameter group.

    • Class com.amazonaws.services.redshift.model.ClusterParameterGroupAlreadyExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ClusterParameterGroupNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ClusterParameterGroupQuotaExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ClusterParameterGroupStatus extends Object implements Serializable

      • Serialized Fields

        • clusterParameterStatusList

          com.amazonaws.internal.SdkInternalList<ClusterParameterStatus> clusterParameterStatusList

          The list of parameter statuses.

          For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

        • parameterApplyStatus

          String parameterApplyStatus

          The status of parameter updates.

        • parameterGroupName

          String parameterGroupName

          The name of the cluster parameter group.

    • Class com.amazonaws.services.redshift.model.ClusterParameterStatus extends Object implements Serializable

      • Serialized Fields

        • parameterApplyErrorDescription

          String parameterApplyErrorDescription

          The error that prevented the parameter from being applied to the database.

        • parameterApplyStatus

          String parameterApplyStatus

          The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.

          The following are possible statuses and descriptions.

          • in-sync: The parameter value is in sync with the database.
          • pending-reboot: The parameter value will be applied after the cluster reboots.
          • applying: The parameter value is being applied to the database.
          • invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.
          • apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.
          • apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.
          • unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.

        • parameterName

          String parameterName

          The name of the parameter.

    • Class com.amazonaws.services.redshift.model.ClusterQuotaExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ClusterSecurityGroup extends Object implements Serializable

      • Serialized Fields

        • clusterSecurityGroupName

          String clusterSecurityGroupName

          The name of the cluster security group to which the operation was applied.

        • description

          String description

          A description of the security group.

        • eC2SecurityGroups

          com.amazonaws.internal.SdkInternalList<EC2SecurityGroup> eC2SecurityGroups

          A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.

        • iPRanges

          com.amazonaws.internal.SdkInternalList<IPRange> iPRanges

          A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          The list of tags for the cluster security group.

    • Class com.amazonaws.services.redshift.model.ClusterSecurityGroupAlreadyExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ClusterSecurityGroupMembership extends Object implements Serializable

      • Serialized Fields

        • clusterSecurityGroupName

          String clusterSecurityGroupName

          The name of the cluster security group.

        • status

          String status

          The status of the cluster security group.

    • Class com.amazonaws.services.redshift.model.ClusterSecurityGroupNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ClusterSecurityGroupQuotaExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ClusterSnapshotAlreadyExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ClusterSnapshotCopyStatus extends Object implements Serializable

      • Serialized Fields

        • destinationRegion

          String destinationRegion

          The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

        • retentionPeriod

          Long retentionPeriod

          The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

        • snapshotCopyGrantName

          String snapshotCopyGrantName

          The name of the snapshot copy grant.

    • Class com.amazonaws.services.redshift.model.ClusterSnapshotNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ClusterSnapshotQuotaExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ClusterSubnetGroup extends Object implements Serializable

      • Serialized Fields

        • clusterSubnetGroupName

          String clusterSubnetGroupName

          The name of the cluster subnet group.

        • description

          String description

          The description of the cluster subnet group.

        • subnetGroupStatus

          String subnetGroupStatus

          The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid.

        • subnets

          com.amazonaws.internal.SdkInternalList<Subnet> subnets

          A list of the VPC Subnet elements.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          The list of tags for the cluster subnet group.

        • vpcId

          String vpcId

          The VPC ID of the cluster subnet group.

    • Class com.amazonaws.services.redshift.model.ClusterSubnetGroupAlreadyExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ClusterSubnetGroupNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ClusterSubnetGroupQuotaExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ClusterSubnetQuotaExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ClusterVersion extends Object implements Serializable

      • Serialized Fields

        • clusterParameterGroupFamily

          String clusterParameterGroupFamily

          The name of the cluster parameter group family for the cluster.

        • clusterVersion

          String clusterVersion

          The version number used by the cluster.

        • description

          String description

          The description of the cluster version.

    • Class com.amazonaws.services.redshift.model.CopyClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • sourceSnapshotClusterIdentifier

          String sourceSnapshotClusterIdentifier

          The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

          Constraints:

          • Must be the identifier for a valid cluster.
        • sourceSnapshotIdentifier

          String sourceSnapshotIdentifier

          The identifier for the source snapshot.

          Constraints:

          • Must be the identifier for a valid automated snapshot whose state is available.
        • targetSnapshotIdentifier

          String targetSnapshotIdentifier

          The identifier given to the new manual snapshot.

          Constraints:

          • Cannot be null, empty, or blank.
          • Must contain from 1 to 255 alphanumeric characters or hyphens.
          • First character must be a letter.
          • Cannot end with a hyphen or contain two consecutive hyphens.
          • Must be unique for the AWS account that is making the request.
    • Class com.amazonaws.services.redshift.model.CopyToRegionDisabledException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.CreateClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • description

          String description

          A description of the parameter group.

        • parameterGroupFamily

          String parameterGroupFamily

          The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.

          To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is "redshift-1.0".

        • parameterGroupName

          String parameterGroupName

          The name of the cluster parameter group.

          Constraints:

          • Must be 1 to 255 alphanumeric characters or hyphens
          • First character must be a letter.
          • Cannot end with a hyphen or contain two consecutive hyphens.
          • Must be unique withing your AWS account.
          This value is stored as a lower-case string.
        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          A list of tag instances.

    • Class com.amazonaws.services.redshift.model.CreateClusterRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • additionalInfo

          String additionalInfo

          Reserved.

        • allowVersionUpgrade

          Boolean allowVersionUpgrade

          If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

          When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

          Default: true

        • automatedSnapshotRetentionPeriod

          Integer automatedSnapshotRetentionPeriod

          The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

          Default: 1

          Constraints: Must be a value from 0 to 35.

        • availabilityZone

          String availabilityZone

          The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

          Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

          Example: us-east-1d

          Constraint: The specified Availability Zone must be in the same region as the current endpoint.

        • clusterIdentifier

          String clusterIdentifier

          A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

          Constraints:

          • Must contain from 1 to 63 alphanumeric characters or hyphens.
          • Alphabetic characters must be lowercase.
          • First character must be a letter.
          • Cannot end with a hyphen or contain two consecutive hyphens.
          • Must be unique for all clusters within an AWS account.

          Example: myexamplecluster

        • clusterParameterGroupName

          String clusterParameterGroupName

          The name of the parameter group to be associated with this cluster.

          Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

          Constraints:

          • Must be 1 to 255 alphanumeric characters or hyphens.
          • First character must be a letter.
          • Cannot end with a hyphen or contain two consecutive hyphens.
        • clusterSecurityGroups

          com.amazonaws.internal.SdkInternalList<String> clusterSecurityGroups

          A list of security groups to be associated with this cluster.

          Default: The default cluster security group for Amazon Redshift.

        • clusterSubnetGroupName

          String clusterSubnetGroupName

          The name of a cluster subnet group to be associated with this cluster.

          If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

        • clusterType

          String clusterType

          The type of the cluster. When cluster type is specified as

          • single-node, the NumberOfNodes parameter is not required.
          • multi-node, the NumberOfNodes parameter is required.

          Valid Values: multi-node | single-node

          Default: multi-node

        • clusterVersion

          String clusterVersion

          The version of the Amazon Redshift engine software that you want to deploy on the cluster.

          The version selected runs on all the nodes in the cluster.

          Constraints: Only version 1.0 is currently available.

          Example: 1.0

        • dBName

          String dBName

          The name of the first database to be created when the cluster is created.

          To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

          Default: dev

          Constraints:

          • Must contain 1 to 64 alphanumeric characters.
          • Must contain only lowercase letters.
          • Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
        • elasticIp

          String elasticIp

          The Elastic IP (EIP) address for the cluster.

          Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

        • encrypted

          Boolean encrypted

          If true, the data in the cluster is encrypted at rest.

          Default: false

        • hsmClientCertificateIdentifier

          String hsmClientCertificateIdentifier

          Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

        • hsmConfigurationIdentifier

          String hsmConfigurationIdentifier

          Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

        • iamRoles

          com.amazonaws.internal.SdkInternalList<String> iamRoles

          A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.

          A cluster can have up to 10 IAM roles associated at any time.

        • kmsKeyId

          String kmsKeyId

          The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

        • masterUsername

          String masterUsername

          The user name associated with the master user account for the cluster that is being created.

          Constraints:

          • Must be 1 - 128 alphanumeric characters.
          • First character must be a letter.
          • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
        • masterUserPassword

          String masterUserPassword

          The password associated with the master user account for the cluster that is being created.

          Constraints:

          • Must be between 8 and 64 characters in length.
          • Must contain at least one uppercase letter.
          • Must contain at least one lowercase letter.
          • Must contain one number.
          • Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
        • nodeType

          String nodeType

          The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

          Valid Values: ds1.xlarge | ds1.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge.

        • numberOfNodes

          Integer numberOfNodes

          The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

          For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

          If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

          Default: 1

          Constraints: Value must be at least 1 and no more than 100.

        • port

          Integer port

          The port number on which the cluster accepts incoming connections.

          The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

          Default: 5439

          Valid Values: 1150-65535

        • preferredMaintenanceWindow

          String preferredMaintenanceWindow

          The weekly time range (in UTC) during which automated cluster maintenance can occur.

          Format: ddd:hh24:mi-ddd:hh24:mi

          Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

          Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

          Constraints: Minimum 30-minute window.

        • publiclyAccessible

          Boolean publiclyAccessible

          If true, the cluster can be accessed from a public network.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          A list of tag instances.

        • vpcSecurityGroupIds

          com.amazonaws.internal.SdkInternalList<String> vpcSecurityGroupIds

          A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

          Default: The default VPC security group is associated with the cluster.

    • Class com.amazonaws.services.redshift.model.CreateClusterSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterSecurityGroupName

          String clusterSecurityGroupName

          The name for the security group. Amazon Redshift stores the value as a lowercase string.

          Constraints:

          • Must contain no more than 255 alphanumeric characters or hyphens.
          • Must not be "Default".
          • Must be unique for all security groups that are created by your AWS account.

          Example: examplesecuritygroup

        • description

          String description

          A description for the security group.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          A list of tag instances.

    • Class com.amazonaws.services.redshift.model.CreateClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterIdentifier

          String clusterIdentifier

          The cluster identifier for which you want a snapshot.

        • snapshotIdentifier

          String snapshotIdentifier

          A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.

          Constraints:

          • Cannot be null, empty, or blank
          • Must contain from 1 to 255 alphanumeric characters or hyphens
          • First character must be a letter
          • Cannot end with a hyphen or contain two consecutive hyphens

          Example: my-snapshot-id

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          A list of tag instances.

    • Class com.amazonaws.services.redshift.model.CreateClusterSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterSubnetGroupName

          String clusterSubnetGroupName

          The name for the subnet group. Amazon Redshift stores the value as a lowercase string.

          Constraints:

          • Must contain no more than 255 alphanumeric characters or hyphens.
          • Must not be "Default".
          • Must be unique for all subnet groups that are created by your AWS account.

          Example: examplesubnetgroup

        • description

          String description

          A description for the subnet group.

        • subnetIds

          com.amazonaws.internal.SdkInternalList<String> subnetIds

          An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          A list of tag instances.

    • Class com.amazonaws.services.redshift.model.CreateEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • enabled

          Boolean enabled

          A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

        • eventCategories

          com.amazonaws.internal.SdkInternalList<String> eventCategories

          Specifies the Amazon Redshift event categories to be published by the event notification subscription.

          Values: Configuration, Management, Monitoring, Security

        • severity

          String severity

          Specifies the Amazon Redshift event severity to be published by the event notification subscription.

          Values: ERROR, INFO

        • snsTopicArn

          String snsTopicArn

          The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

        • sourceIds

          com.amazonaws.internal.SdkInternalList<String> sourceIds

          A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

          Example: my-cluster-1, my-cluster-2

          Example: my-snapshot-20131010

        • sourceType

          String sourceType

          The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.

          Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

        • subscriptionName

          String subscriptionName

          The name of the event subscription to be created.

          Constraints:

          • Cannot be null, empty, or blank.
          • Must contain from 1 to 255 alphanumeric characters or hyphens.
          • First character must be a letter.
          • Cannot end with a hyphen or contain two consecutive hyphens.
        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          A list of tag instances.

    • Class com.amazonaws.services.redshift.model.CreateHsmClientCertificateRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • hsmClientCertificateIdentifier

          String hsmClientCertificateIdentifier

          The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          A list of tag instances.

    • Class com.amazonaws.services.redshift.model.CreateHsmConfigurationRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • description

          String description

          A text description of the HSM configuration to be created.

        • hsmConfigurationIdentifier

          String hsmConfigurationIdentifier

          The identifier to be assigned to the new Amazon Redshift HSM configuration.

        • hsmIpAddress

          String hsmIpAddress

          The IP address that the Amazon Redshift cluster must use to access the HSM.

        • hsmPartitionName

          String hsmPartitionName

          The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

        • hsmPartitionPassword

          String hsmPartitionPassword

          The password required to access the HSM partition.

        • hsmServerPublicCertificate

          String hsmServerPublicCertificate

          The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          A list of tag instances.

    • Class com.amazonaws.services.redshift.model.CreateSnapshotCopyGrantRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • kmsKeyId

          String kmsKeyId

          The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.

        • snapshotCopyGrantName

          String snapshotCopyGrantName

          The name of the snapshot copy grant. This name must be unique in the region for the AWS account.

          Constraints:

          • Must contain from 1 to 63 alphanumeric characters or hyphens.
          • Alphabetic characters must be lowercase.
          • First character must be a letter.
          • Cannot end with a hyphen or contain two consecutive hyphens.
          • Must be unique for all clusters within an AWS account.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          A list of tag instances.

    • Class com.amazonaws.services.redshift.model.CreateTagsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • resourceName

          String resourceName

          The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1 .

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags "Key"="owner","Value"="admin" "Key"="environment","Value"="test" "Key"="version","Value"="1.0" .

    • Class com.amazonaws.services.redshift.model.CreateTagsResult extends Object implements Serializable

    • Class com.amazonaws.services.redshift.model.DefaultClusterParameters extends Object implements Serializable

      • Serialized Fields

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

        • parameterGroupFamily

          String parameterGroupFamily

          The name of the cluster parameter group family to which the engine default parameters apply.

        • parameters

          com.amazonaws.internal.SdkInternalList<Parameter> parameters

          The list of cluster default parameters.

    • Class com.amazonaws.services.redshift.model.DeleteClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • parameterGroupName

          String parameterGroupName

          The name of the parameter group to be deleted.

          Constraints:

          • Must be the name of an existing cluster parameter group.
          • Cannot delete a default cluster parameter group.
    • Class com.amazonaws.services.redshift.model.DeleteClusterParameterGroupResult extends Object implements Serializable

    • Class com.amazonaws.services.redshift.model.DeleteClusterRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterIdentifier

          String clusterIdentifier

          The identifier of the cluster to be deleted.

          Constraints:

          • Must contain lowercase characters.
          • Must contain from 1 to 63 alphanumeric characters or hyphens.
          • First character must be a letter.
          • Cannot end with a hyphen or contain two consecutive hyphens.
        • finalClusterSnapshotIdentifier

          String finalClusterSnapshotIdentifier

          The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

          Constraints:

          • Must be 1 to 255 alphanumeric characters.
          • First character must be a letter.
          • Cannot end with a hyphen or contain two consecutive hyphens.
        • skipFinalClusterSnapshot

          Boolean skipFinalClusterSnapshot

          Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.

          The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false .

          Default: false

    • Class com.amazonaws.services.redshift.model.DeleteClusterSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterSecurityGroupName

          String clusterSecurityGroupName

          The name of the cluster security group to be deleted.

    • Class com.amazonaws.services.redshift.model.DeleteClusterSecurityGroupResult extends Object implements Serializable

    • Class com.amazonaws.services.redshift.model.DeleteClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • snapshotClusterIdentifier

          String snapshotClusterIdentifier

          The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

          Constraints: Must be the name of valid cluster.

        • snapshotIdentifier

          String snapshotIdentifier

          The unique identifier of the manual snapshot to be deleted.

          Constraints: Must be the name of an existing snapshot that is in the available state.

    • Class com.amazonaws.services.redshift.model.DeleteClusterSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterSubnetGroupName

          String clusterSubnetGroupName

          The name of the cluster subnet group name to be deleted.

    • Class com.amazonaws.services.redshift.model.DeleteClusterSubnetGroupResult extends Object implements Serializable

    • Class com.amazonaws.services.redshift.model.DeleteEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • subscriptionName

          String subscriptionName

          The name of the Amazon Redshift event notification subscription to be deleted.

    • Class com.amazonaws.services.redshift.model.DeleteEventSubscriptionResult extends Object implements Serializable

    • Class com.amazonaws.services.redshift.model.DeleteHsmClientCertificateRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • hsmClientCertificateIdentifier

          String hsmClientCertificateIdentifier

          The identifier of the HSM client certificate to be deleted.

    • Class com.amazonaws.services.redshift.model.DeleteHsmClientCertificateResult extends Object implements Serializable

    • Class com.amazonaws.services.redshift.model.DeleteHsmConfigurationRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • hsmConfigurationIdentifier

          String hsmConfigurationIdentifier

          The identifier of the Amazon Redshift HSM configuration to be deleted.

    • Class com.amazonaws.services.redshift.model.DeleteHsmConfigurationResult extends Object implements Serializable

    • Class com.amazonaws.services.redshift.model.DeleteSnapshotCopyGrantRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • snapshotCopyGrantName

          String snapshotCopyGrantName

          The name of the snapshot copy grant to delete.

    • Class com.amazonaws.services.redshift.model.DeleteSnapshotCopyGrantResult extends Object implements Serializable

    • Class com.amazonaws.services.redshift.model.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • resourceName

          String resourceName

          The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.

        • tagKeys

          com.amazonaws.internal.SdkInternalList<String> tagKeys

          The tag key that you want to delete.

    • Class com.amazonaws.services.redshift.model.DeleteTagsResult extends Object implements Serializable

    • Class com.amazonaws.services.redshift.model.DependentServiceRequestThrottlingException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.DescribeClusterParameterGroupsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

        • maxRecords

          Integer maxRecords

          The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

          Default: 100

          Constraints: minimum 20, maximum 100.

        • parameterGroupName

          String parameterGroupName

          The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.

        • tagKeys

          com.amazonaws.internal.SdkInternalList<String> tagKeys

          A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.

        • tagValues

          com.amazonaws.internal.SdkInternalList<String> tagValues

          A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

    • Class com.amazonaws.services.redshift.model.DescribeClusterParameterGroupsResult extends Object implements Serializable

      • Serialized Fields

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

        • parameterGroups

          com.amazonaws.internal.SdkInternalList<ClusterParameterGroup> parameterGroups

          A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.

    • Class com.amazonaws.services.redshift.model.DescribeClusterParametersRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

        • maxRecords

          Integer maxRecords

          The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

          Default: 100

          Constraints: minimum 20, maximum 100.

        • parameterGroupName

          String parameterGroupName

          The name of a cluster parameter group for which to return details.

        • source

          String source

          The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

          Default: All parameter types returned.

          Valid Values: user | engine-default

    • Class com.amazonaws.services.redshift.model.DescribeClusterParametersResult extends Object implements Serializable

      • Serialized Fields

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

        • parameters

          com.amazonaws.internal.SdkInternalList<Parameter> parameters

          A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.

    • Class com.amazonaws.services.redshift.model.DescribeClusterSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterSecurityGroupName

          String clusterSecurityGroupName

          The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.

          Example: securitygroup1

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

          Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.

        • maxRecords

          Integer maxRecords

          The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

          Default: 100

          Constraints: minimum 20, maximum 100.

        • tagKeys

          com.amazonaws.internal.SdkInternalList<String> tagKeys

          A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.

        • tagValues

          com.amazonaws.internal.SdkInternalList<String> tagValues

          A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.

    • Class com.amazonaws.services.redshift.model.DescribeClusterSecurityGroupsResult extends Object implements Serializable

      • Serialized Fields

        • clusterSecurityGroups

          com.amazonaws.internal.SdkInternalList<ClusterSecurityGroup> clusterSecurityGroups

          A list of ClusterSecurityGroup instances.

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    • Class com.amazonaws.services.redshift.model.DescribeClusterSnapshotsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterIdentifier

          String clusterIdentifier

          The identifier of the cluster for which information about snapshots is requested.

        • endTime

          Date endTime

          A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

          Example: 2012-07-16T18:00:00Z

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

        • maxRecords

          Integer maxRecords

          The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

          Default: 100

          Constraints: minimum 20, maximum 100.

        • ownerAccount

          String ownerAccount

          The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.

        • snapshotIdentifier

          String snapshotIdentifier

          The snapshot identifier of the snapshot about which to return information.

        • snapshotType

          String snapshotType

          The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

          Valid Values: automated | manual

        • startTime

          Date startTime

          A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

          Example: 2012-07-16T18:00:00Z

        • tagKeys

          com.amazonaws.internal.SdkInternalList<String> tagKeys

          A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

        • tagValues

          com.amazonaws.internal.SdkInternalList<String> tagValues

          A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

    • Class com.amazonaws.services.redshift.model.DescribeClusterSnapshotsResult extends Object implements Serializable

      • Serialized Fields

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

        • snapshots

          com.amazonaws.internal.SdkInternalList<Snapshot> snapshots

          A list of Snapshot instances.

    • Class com.amazonaws.services.redshift.model.DescribeClustersRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterIdentifier

          String clusterIdentifier

          The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

          The default is that all clusters defined for an account are returned.

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

          Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

        • maxRecords

          Integer maxRecords

          The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

          Default: 100

          Constraints: minimum 20, maximum 100.

        • tagKeys

          com.amazonaws.internal.SdkInternalList<String> tagKeys

          A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

        • tagValues

          com.amazonaws.internal.SdkInternalList<String> tagValues

          A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

    • Class com.amazonaws.services.redshift.model.DescribeClustersResult extends Object implements Serializable

      • Serialized Fields

        • clusters

          com.amazonaws.internal.SdkInternalList<Cluster> clusters

          A list of Cluster objects, where each object describes one cluster.

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    • Class com.amazonaws.services.redshift.model.DescribeClusterSubnetGroupsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterSubnetGroupName

          String clusterSubnetGroupName

          The name of the cluster subnet group for which information is requested.

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

        • maxRecords

          Integer maxRecords

          The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

          Default: 100

          Constraints: minimum 20, maximum 100.

        • tagKeys

          com.amazonaws.internal.SdkInternalList<String> tagKeys

          A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.

        • tagValues

          com.amazonaws.internal.SdkInternalList<String> tagValues

          A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.

    • Class com.amazonaws.services.redshift.model.DescribeClusterSubnetGroupsResult extends Object implements Serializable

      • Serialized Fields

        • clusterSubnetGroups

          com.amazonaws.internal.SdkInternalList<ClusterSubnetGroup> clusterSubnetGroups

          A list of ClusterSubnetGroup instances.

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    • Class com.amazonaws.services.redshift.model.DescribeClusterVersionsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterParameterGroupFamily

          String clusterParameterGroupFamily

          The name of a specific cluster parameter group family to return details for.

          Constraints:

          • Must be 1 to 255 alphanumeric characters
          • First character must be a letter
          • Cannot end with a hyphen or contain two consecutive hyphens
        • clusterVersion

          String clusterVersion

          The specific cluster version to return.

          Example: 1.0

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

        • maxRecords

          Integer maxRecords

          The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

          Default: 100

          Constraints: minimum 20, maximum 100.

    • Class com.amazonaws.services.redshift.model.DescribeClusterVersionsResult extends Object implements Serializable

      • Serialized Fields

        • clusterVersions

          com.amazonaws.internal.SdkInternalList<ClusterVersion> clusterVersions

          A list of Version elements.

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    • Class com.amazonaws.services.redshift.model.DescribeDefaultClusterParametersRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

        • maxRecords

          Integer maxRecords

          The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

          Default: 100

          Constraints: minimum 20, maximum 100.

        • parameterGroupFamily

          String parameterGroupFamily

          The name of the cluster parameter group family.

    • Class com.amazonaws.services.redshift.model.DescribeEventCategoriesRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • sourceType

          String sourceType

          The source type, such as cluster or parameter group, to which the described event categories apply.

          Valid values: cluster, cluster-snapshot, cluster-parameter-group, and cluster-security-group.

    • Class com.amazonaws.services.redshift.model.DescribeEventCategoriesResult extends Object implements Serializable

      • Serialized Fields

        • eventCategoriesMapList

          com.amazonaws.internal.SdkInternalList<EventCategoriesMap> eventCategoriesMapList

          A list of event categories descriptions.

    • Class com.amazonaws.services.redshift.model.DescribeEventsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • duration

          Integer duration

          The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

          Default: 60

        • endTime

          Date endTime

          The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

          Example: 2009-07-08T18:00Z

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

        • maxRecords

          Integer maxRecords

          The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

          Default: 100

          Constraints: minimum 20, maximum 100.

        • sourceIdentifier

          String sourceIdentifier

          The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

          Constraints:

          If SourceIdentifier is supplied, SourceType must also be provided.

          • Specify a cluster identifier when SourceType is cluster.
          • Specify a cluster security group name when SourceType is cluster-security-group.
          • Specify a cluster parameter group name when SourceType is cluster-parameter-group.
          • Specify a cluster snapshot identifier when SourceType is cluster-snapshot.
        • sourceType

          String sourceType

          The event source to retrieve events for. If no value is specified, all events are returned.

          Constraints:

          If SourceType is supplied, SourceIdentifier must also be provided.

          • Specify cluster when SourceIdentifier is a cluster identifier.
          • Specify cluster-security-group when SourceIdentifier is a cluster security group name.
          • Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.
          • Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.
        • startTime

          Date startTime

          The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

          Example: 2009-07-08T18:00Z

    • Class com.amazonaws.services.redshift.model.DescribeEventsResult extends Object implements Serializable

      • Serialized Fields

        • events

          com.amazonaws.internal.SdkInternalList<Event> events

          A list of Event instances.

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    • Class com.amazonaws.services.redshift.model.DescribeEventSubscriptionsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

        • maxRecords

          Integer maxRecords

          The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

          Default: 100

          Constraints: minimum 20, maximum 100.

        • subscriptionName

          String subscriptionName

          The name of the Amazon Redshift event notification subscription to be described.

    • Class com.amazonaws.services.redshift.model.DescribeEventSubscriptionsResult extends Object implements Serializable

      • Serialized Fields

        • eventSubscriptionsList

          com.amazonaws.internal.SdkInternalList<EventSubscription> eventSubscriptionsList

          A list of event subscriptions.

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    • Class com.amazonaws.services.redshift.model.DescribeHsmClientCertificatesRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • hsmClientCertificateIdentifier

          String hsmClientCertificateIdentifier

          The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

        • maxRecords

          Integer maxRecords

          The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

          Default: 100

          Constraints: minimum 20, maximum 100.

        • tagKeys

          com.amazonaws.internal.SdkInternalList<String> tagKeys

          A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them.

        • tagValues

          com.amazonaws.internal.SdkInternalList<String> tagValues

          A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.

    • Class com.amazonaws.services.redshift.model.DescribeHsmClientCertificatesResult extends Object implements Serializable

      • Serialized Fields

        • hsmClientCertificates

          com.amazonaws.internal.SdkInternalList<HsmClientCertificate> hsmClientCertificates

          A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM.

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    • Class com.amazonaws.services.redshift.model.DescribeHsmConfigurationsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • hsmConfigurationIdentifier

          String hsmConfigurationIdentifier

          The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

        • maxRecords

          Integer maxRecords

          The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

          Default: 100

          Constraints: minimum 20, maximum 100.

        • tagKeys

          com.amazonaws.internal.SdkInternalList<String> tagKeys

          A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them.

        • tagValues

          com.amazonaws.internal.SdkInternalList<String> tagValues

          A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them.

    • Class com.amazonaws.services.redshift.model.DescribeHsmConfigurationsResult extends Object implements Serializable

      • Serialized Fields

        • hsmConfigurations

          com.amazonaws.internal.SdkInternalList<HsmConfiguration> hsmConfigurations

          A list of HsmConfiguration objects.

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    • Class com.amazonaws.services.redshift.model.DescribeLoggingStatusRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterIdentifier

          String clusterIdentifier

          The identifier of the cluster from which to get the logging status.

          Example: examplecluster

    • Class com.amazonaws.services.redshift.model.DescribeLoggingStatusResult extends Object implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName

          The name of the S3 bucket where the log files are stored.

        • lastFailureMessage

          String lastFailureMessage

          The message indicating that logs failed to be delivered.

        • lastFailureTime

          Date lastFailureTime

          The last time when logs failed to be delivered.

        • lastSuccessfulDeliveryTime

          Date lastSuccessfulDeliveryTime

          The last time that logs were delivered.

        • loggingEnabled

          Boolean loggingEnabled

          true if logging is on, false if logging is off.

        • s3KeyPrefix

          String s3KeyPrefix

          The prefix applied to the log file names.

    • Class com.amazonaws.services.redshift.model.DescribeOrderableClusterOptionsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterVersion

          String clusterVersion

          The version filter value. Specify this parameter to show only the available offerings matching the specified version.

          Default: All versions.

          Constraints: Must be one of the version returned from DescribeClusterVersions.

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

        • maxRecords

          Integer maxRecords

          The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

          Default: 100

          Constraints: minimum 20, maximum 100.

        • nodeType

          String nodeType

          The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

    • Class com.amazonaws.services.redshift.model.DescribeOrderableClusterOptionsResult extends Object implements Serializable

      • Serialized Fields

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

        • orderableClusterOptions

          com.amazonaws.internal.SdkInternalList<OrderableClusterOption> orderableClusterOptions

          An OrderableClusterOption structure containing information about orderable options for the cluster.

    • Class com.amazonaws.services.redshift.model.DescribeReservedNodeOfferingsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

        • maxRecords

          Integer maxRecords

          The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

          Default: 100

          Constraints: minimum 20, maximum 100.

        • reservedNodeOfferingId

          String reservedNodeOfferingId

          The unique identifier for the offering.

    • Class com.amazonaws.services.redshift.model.DescribeReservedNodeOfferingsResult extends Object implements Serializable

      • Serialized Fields

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

        • reservedNodeOfferings

          com.amazonaws.internal.SdkInternalList<ReservedNodeOffering> reservedNodeOfferings

          A list of ReservedNodeOffering objects.

    • Class com.amazonaws.services.redshift.model.DescribeReservedNodesRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

        • maxRecords

          Integer maxRecords

          The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

          Default: 100

          Constraints: minimum 20, maximum 100.

        • reservedNodeId

          String reservedNodeId

          Identifier for the node reservation.

    • Class com.amazonaws.services.redshift.model.DescribeReservedNodesResult extends Object implements Serializable

      • Serialized Fields

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

        • reservedNodes

          com.amazonaws.internal.SdkInternalList<ReservedNode> reservedNodes

          The list of ReservedNode objects.

    • Class com.amazonaws.services.redshift.model.DescribeResizeRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterIdentifier

          String clusterIdentifier

          The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.

          By default, resize operations for all clusters defined for an AWS account are returned.

    • Class com.amazonaws.services.redshift.model.DescribeResizeResult extends Object implements Serializable

      • Serialized Fields

        • avgResizeRateInMegaBytesPerSecond

          Double avgResizeRateInMegaBytesPerSecond

          The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.

        • elapsedTimeInSeconds

          Long elapsedTimeInSeconds

          The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.

        • estimatedTimeToCompletionInSeconds

          Long estimatedTimeToCompletionInSeconds

          The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.

        • importTablesCompleted

          com.amazonaws.internal.SdkInternalList<String> importTablesCompleted

          The names of tables that have been completely imported .

          Valid Values: List of table names.

        • importTablesInProgress

          com.amazonaws.internal.SdkInternalList<String> importTablesInProgress

          The names of tables that are being currently imported.

          Valid Values: List of table names.

        • importTablesNotStarted

          com.amazonaws.internal.SdkInternalList<String> importTablesNotStarted

          The names of tables that have not been yet imported.

          Valid Values: List of table names

        • progressInMegaBytes

          Long progressInMegaBytes

          While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).

        • status

          String status

          The status of the resize operation.

          Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED

        • targetClusterType

          String targetClusterType

          The cluster type after the resize operation is complete.

          Valid Values: multi-node | single-node

        • targetNodeType

          String targetNodeType

          The node type that the cluster will have after the resize operation is complete.

        • targetNumberOfNodes

          Integer targetNumberOfNodes

          The number of nodes that the cluster will have after the resize operation is complete.

        • totalResizeDataInMegaBytes

          Long totalResizeDataInMegaBytes

          The estimated total amount of data, in megabytes, on the cluster before the resize operation began.

    • Class com.amazonaws.services.redshift.model.DescribeSnapshotCopyGrantsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

          Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

        • maxRecords

          Integer maxRecords

          The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

          Default: 100

          Constraints: minimum 20, maximum 100.

        • snapshotCopyGrantName

          String snapshotCopyGrantName

          The name of the snapshot copy grant.

        • tagKeys

          com.amazonaws.internal.SdkInternalList<String> tagKeys

          A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

        • tagValues

          com.amazonaws.internal.SdkInternalList<String> tagValues

          A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

    • Class com.amazonaws.services.redshift.model.DescribeSnapshotCopyGrantsResult extends Object implements Serializable

      • Serialized Fields

        • marker

          String marker

          An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

          Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

        • snapshotCopyGrants

          com.amazonaws.internal.SdkInternalList<SnapshotCopyGrant> snapshotCopyGrants

          The list of SnapshotCopyGrant objects.

    • Class com.amazonaws.services.redshift.model.DescribeTableRestoreStatusRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterIdentifier

          String clusterIdentifier

          The Amazon Redshift cluster that the table is being restored to.

        • marker

          String marker

          An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

        • maxRecords

          Integer maxRecords

          The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

        • tableRestoreRequestId

          String tableRestoreRequestId

          The identifier of the table restore request to return status for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.

    • Class com.amazonaws.services.redshift.model.DescribeTableRestoreStatusResult extends Object implements Serializable

      • Serialized Fields

        • marker

          String marker

          A pagination token that can be used in a subsequent DescribeTableRestoreStatus request.

        • tableRestoreStatusDetails

          com.amazonaws.internal.SdkInternalList<TableRestoreStatus> tableRestoreStatusDetails

          A list of status details for one or more table restore requests.

    • Class com.amazonaws.services.redshift.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

        • maxRecords

          Integer maxRecords

          The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

        • resourceName

          String resourceName

          The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.

        • resourceType

          String resourceType

          The type of resource with which you want to view tags. Valid resource types are:

          • Cluster
          • CIDR/IP
          • EC2 security group
          • Snapshot
          • Cluster security group
          • Subnet group
          • HSM connection
          • HSM certificate
          • Parameter group
          • Snapshot copy grant

          For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.

        • tagKeys

          com.amazonaws.internal.SdkInternalList<String> tagKeys

          A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

        • tagValues

          com.amazonaws.internal.SdkInternalList<String> tagValues

          A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

    • Class com.amazonaws.services.redshift.model.DescribeTagsResult extends Object implements Serializable

      • Serialized Fields

        • marker

          String marker

          A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

        • taggedResources

          com.amazonaws.internal.SdkInternalList<TaggedResource> taggedResources

          A list of tags with their associated resources.

    • Class com.amazonaws.services.redshift.model.DisableLoggingRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterIdentifier

          String clusterIdentifier

          The identifier of the cluster on which logging is to be stopped.

          Example: examplecluster

    • Class com.amazonaws.services.redshift.model.DisableLoggingResult extends Object implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName

          The name of the S3 bucket where the log files are stored.

        • lastFailureMessage

          String lastFailureMessage

          The message indicating that logs failed to be delivered.

        • lastFailureTime

          Date lastFailureTime

          The last time when logs failed to be delivered.

        • lastSuccessfulDeliveryTime

          Date lastSuccessfulDeliveryTime

          The last time that logs were delivered.

        • loggingEnabled

          Boolean loggingEnabled

          true if logging is on, false if logging is off.

        • s3KeyPrefix

          String s3KeyPrefix

          The prefix applied to the log file names.

    • Class com.amazonaws.services.redshift.model.DisableSnapshotCopyRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterIdentifier

          String clusterIdentifier

          The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.

          Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

    • Class com.amazonaws.services.redshift.model.EC2SecurityGroup extends Object implements Serializable

      • Serialized Fields

        • eC2SecurityGroupName

          String eC2SecurityGroupName

          The name of the EC2 Security Group.

        • eC2SecurityGroupOwnerId

          String eC2SecurityGroupOwnerId

          The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

        • status

          String status

          The status of the EC2 security group.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          The list of tags for the EC2 security group.

    • Class com.amazonaws.services.redshift.model.ElasticIpStatus extends Object implements Serializable

      • Serialized Fields

        • elasticIp

          String elasticIp

          The elastic IP (EIP) address for the cluster.

        • status

          String status

          The status of the elastic IP (EIP) address.

    • Class com.amazonaws.services.redshift.model.EnableLoggingRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName

          The name of an existing S3 bucket where the log files are to be stored.

          Constraints:

          • Must be in the same region as the cluster
          • The cluster must have read bucket and put object permissions
        • clusterIdentifier

          String clusterIdentifier

          The identifier of the cluster on which logging is to be started.

          Example: examplecluster

        • s3KeyPrefix

          String s3KeyPrefix

          The prefix applied to the log file names.

          Constraints:

          • Cannot exceed 512 characters
          • Cannot contain spaces( ), double quotes ("), single quotes ('), a backslash (\), or control characters. The hexadecimal codes for invalid characters are:
            • x00 to x20
            • x22
            • x27
            • x5c
            • x7f or larger
    • Class com.amazonaws.services.redshift.model.EnableLoggingResult extends Object implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName

          The name of the S3 bucket where the log files are stored.

        • lastFailureMessage

          String lastFailureMessage

          The message indicating that logs failed to be delivered.

        • lastFailureTime

          Date lastFailureTime

          The last time when logs failed to be delivered.

        • lastSuccessfulDeliveryTime

          Date lastSuccessfulDeliveryTime

          The last time that logs were delivered.

        • loggingEnabled

          Boolean loggingEnabled

          true if logging is on, false if logging is off.

        • s3KeyPrefix

          String s3KeyPrefix

          The prefix applied to the log file names.

    • Class com.amazonaws.services.redshift.model.EnableSnapshotCopyRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterIdentifier

          String clusterIdentifier

          The unique identifier of the source cluster to copy snapshots from.

          Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

        • destinationRegion

          String destinationRegion

          The destination region that you want to copy snapshots to.

          Constraints: Must be the name of a valid region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

        • retentionPeriod

          Integer retentionPeriod

          The number of days to retain automated snapshots in the destination region after they are copied from the source region.

          Default: 7.

          Constraints: Must be at least 1 and no more than 35.

        • snapshotCopyGrantName

          String snapshotCopyGrantName

          The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

    • Class com.amazonaws.services.redshift.model.Endpoint extends Object implements Serializable

      • Serialized Fields

        • address

          String address

          The DNS address of the Cluster.

        • port

          Integer port

          The port that the database engine is listening on.

    • Class com.amazonaws.services.redshift.model.Event extends Object implements Serializable

      • Serialized Fields

        • dateValue

          Date dateValue

          The date and time of the event.

        • eventCategories

          com.amazonaws.internal.SdkInternalList<String> eventCategories

          A list of the event categories.

          Values: Configuration, Management, Monitoring, Security

        • eventId

          String eventId

          The identifier of the event.

        • message

          String message

          The text of this event.

        • severity

          String severity

          The severity of the event.

          Values: ERROR, INFO

        • sourceIdentifier

          String sourceIdentifier

          The identifier for the source of the event.

        • sourceType

          String sourceType

          The source type for this event.

    • Class com.amazonaws.services.redshift.model.EventCategoriesMap extends Object implements Serializable

      • Serialized Fields

        • events

          com.amazonaws.internal.SdkInternalList<EventInfoMap> events

          The events in the event category.

        • sourceType

          String sourceType

          The source type, such as cluster or cluster-snapshot, that the returned categories belong to.

    • Class com.amazonaws.services.redshift.model.EventInfoMap extends Object implements Serializable

      • Serialized Fields

        • eventCategories

          com.amazonaws.internal.SdkInternalList<String> eventCategories

          The category of an Amazon Redshift event.

        • eventDescription

          String eventDescription

          The description of an Amazon Redshift event.

        • eventId

          String eventId

          The identifier of an Amazon Redshift event.

        • severity

          String severity

          The severity of the event.

          Values: ERROR, INFO

    • Class com.amazonaws.services.redshift.model.EventSubscription extends Object implements Serializable

      • Serialized Fields

        • customerAwsId

          String customerAwsId

          The AWS customer account associated with the Amazon Redshift event notification subscription.

        • custSubscriptionId

          String custSubscriptionId

          The name of the Amazon Redshift event notification subscription.

        • enabled

          Boolean enabled

          A Boolean value indicating whether the subscription is enabled. true indicates the subscription is enabled.

        • eventCategoriesList

          com.amazonaws.internal.SdkInternalList<String> eventCategoriesList

          The list of Amazon Redshift event categories specified in the event notification subscription.

          Values: Configuration, Management, Monitoring, Security

        • severity

          String severity

          The event severity specified in the Amazon Redshift event notification subscription.

          Values: ERROR, INFO

        • snsTopicArn

          String snsTopicArn

          The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.

        • sourceIdsList

          com.amazonaws.internal.SdkInternalList<String> sourceIdsList

          A list of the sources that publish events to the Amazon Redshift event notification subscription.

        • sourceType

          String sourceType

          The source type of the events returned the Amazon Redshift event notification, such as cluster, or cluster-snapshot.

        • status

          String status

          The status of the Amazon Redshift event notification subscription.

          Constraints:

          • Can be one of the following: active | no-permission | topic-not-exist
          • The status "no-permission" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.
        • subscriptionCreationTime

          Date subscriptionCreationTime

          The date and time the Amazon Redshift event notification subscription was created.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          The list of tags for the event subscription.

    • Class com.amazonaws.services.redshift.model.EventSubscriptionQuotaExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.HsmClientCertificate extends Object implements Serializable

      • Serialized Fields

        • hsmClientCertificateIdentifier

          String hsmClientCertificateIdentifier

          The identifier of the HSM client certificate.

        • hsmClientCertificatePublicKey

          String hsmClientCertificatePublicKey

          The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          The list of tags for the HSM client certificate.

    • Class com.amazonaws.services.redshift.model.HsmClientCertificateAlreadyExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.HsmClientCertificateNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.HsmClientCertificateQuotaExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.HsmConfiguration extends Object implements Serializable

      • Serialized Fields

        • description

          String description

          A text description of the HSM configuration.

        • hsmConfigurationIdentifier

          String hsmConfigurationIdentifier

          The name of the Amazon Redshift HSM configuration.

        • hsmIpAddress

          String hsmIpAddress

          The IP address that the Amazon Redshift cluster must use to access the HSM.

        • hsmPartitionName

          String hsmPartitionName

          The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          The list of tags for the HSM configuration.

    • Class com.amazonaws.services.redshift.model.HsmConfigurationAlreadyExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.HsmConfigurationNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.HsmConfigurationQuotaExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.HsmStatus extends Object implements Serializable

      • Serialized Fields

        • hsmClientCertificateIdentifier

          String hsmClientCertificateIdentifier

          Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

        • hsmConfigurationIdentifier

          String hsmConfigurationIdentifier

          Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

        • status

          String status

          Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.

          Values: active, applying

    • Class com.amazonaws.services.redshift.model.IncompatibleOrderableOptionsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InProgressTableRestoreQuotaExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InsufficientClusterCapacityException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InsufficientS3BucketPolicyException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidClusterParameterGroupStateException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidClusterSecurityGroupStateException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidClusterSnapshotStateException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidClusterStateException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidClusterSubnetGroupStateException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidClusterSubnetStateException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidElasticIpException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidHsmClientCertificateStateException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidHsmConfigurationStateException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidRestoreException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidS3BucketNameException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidS3KeyPrefixException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidSnapshotCopyGrantStateException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidSubnetException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidSubscriptionStateException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidTableRestoreArgumentException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidTagException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.InvalidVPCNetworkStateException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.IPRange extends Object implements Serializable

      • Serialized Fields

        • cIDRIP

          String cIDRIP

          The IP range in Classless Inter-Domain Routing (CIDR) notation.

        • status

          String status

          The status of the IP range, for example, "authorized".

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          The list of tags for the IP range.

    • Class com.amazonaws.services.redshift.model.LimitExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ModifyClusterIamRolesRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • addIamRoles

          com.amazonaws.internal.SdkInternalList<String> addIamRoles

          Zero or more IAM roles (in their ARN format) to associate with the cluster. You can associate up to 10 IAM roles with a single cluster in a single request.

        • clusterIdentifier

          String clusterIdentifier

          The unique identifier of the cluster for which you want to associate or disassociate IAM roles.

        • removeIamRoles

          com.amazonaws.internal.SdkInternalList<String> removeIamRoles

          Zero or more IAM roles (in their ARN format) to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.

    • Class com.amazonaws.services.redshift.model.ModifyClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • parameterGroupName

          String parameterGroupName

          The name of the parameter group to be modified.

        • parameters

          com.amazonaws.internal.SdkInternalList<Parameter> parameters

          An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.

          For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.

          For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.

    • Class com.amazonaws.services.redshift.model.ModifyClusterParameterGroupResult extends Object implements Serializable

      • Serialized Fields

        • parameterGroupName

          String parameterGroupName

          The name of the cluster parameter group.

        • parameterGroupStatus

          String parameterGroupStatus

          The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.

    • Class com.amazonaws.services.redshift.model.ModifyClusterRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • allowVersionUpgrade

          Boolean allowVersionUpgrade

          If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

          Default: false

        • automatedSnapshotRetentionPeriod

          Integer automatedSnapshotRetentionPeriod

          The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

          If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.

          Default: Uses existing setting.

          Constraints: Must be a value from 0 to 35.

        • clusterIdentifier

          String clusterIdentifier

          The unique identifier of the cluster to be modified.

          Example: examplecluster

        • clusterParameterGroupName

          String clusterParameterGroupName

          The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.

          Default: Uses existing setting.

          Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.

        • clusterSecurityGroups

          com.amazonaws.internal.SdkInternalList<String> clusterSecurityGroups

          A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.

          Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.

          Constraints:

          • Must be 1 to 255 alphanumeric characters or hyphens
          • First character must be a letter
          • Cannot end with a hyphen or contain two consecutive hyphens
        • clusterType

          String clusterType

          The new cluster type.

          When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.

          Valid Values: multi-node | single-node

        • clusterVersion

          String clusterVersion

          The new version number of the Amazon Redshift engine to upgrade to.

          For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

          Example: 1.0

        • elasticIp

          String elasticIp

          The Elastic IP (EIP) address for the cluster.

          Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

        • hsmClientCertificateIdentifier

          String hsmClientCertificateIdentifier

          Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

        • hsmConfigurationIdentifier

          String hsmConfigurationIdentifier

          Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

        • masterUserPassword

          String masterUserPassword

          The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response. Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost.

          Default: Uses existing setting.

          Constraints:

          • Must be between 8 and 64 characters in length.
          • Must contain at least one uppercase letter.
          • Must contain at least one lowercase letter.
          • Must contain one number.
          • Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.
        • newClusterIdentifier

          String newClusterIdentifier

          The new identifier for the cluster.

          Constraints:

          • Must contain from 1 to 63 alphanumeric characters or hyphens.
          • Alphabetic characters must be lowercase.
          • First character must be a letter.
          • Cannot end with a hyphen or contain two consecutive hyphens.
          • Must be unique for all clusters within an AWS account.

          Example: examplecluster

        • nodeType

          String nodeType

          The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.

          When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.

          Valid Values: ds1.xlarge | ds1.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge.

        • numberOfNodes

          Integer numberOfNodes

          The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.

          When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.

          Valid Values: Integer greater than 0.

        • preferredMaintenanceWindow

          String preferredMaintenanceWindow

          The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.

          This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.

          Default: Uses existing setting.

          Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.

          Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

          Constraints: Must be at least 30 minutes.

        • publiclyAccessible

          Boolean publiclyAccessible

          If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.

        • vpcSecurityGroupIds

          com.amazonaws.internal.SdkInternalList<String> vpcSecurityGroupIds

          A list of virtual private cloud (VPC) security groups to be associated with the cluster.

    • Class com.amazonaws.services.redshift.model.ModifyClusterSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterSubnetGroupName

          String clusterSubnetGroupName

          The name of the subnet group to be modified.

        • description

          String description

          A text description of the subnet group to be modified.

        • subnetIds

          com.amazonaws.internal.SdkInternalList<String> subnetIds

          An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

    • Class com.amazonaws.services.redshift.model.ModifyEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • enabled

          Boolean enabled

          A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled

        • eventCategories

          com.amazonaws.internal.SdkInternalList<String> eventCategories

          Specifies the Amazon Redshift event categories to be published by the event notification subscription.

          Values: Configuration, Management, Monitoring, Security

        • severity

          String severity

          Specifies the Amazon Redshift event severity to be published by the event notification subscription.

          Values: ERROR, INFO

        • snsTopicArn

          String snsTopicArn

          The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.

        • sourceIds

          com.amazonaws.internal.SdkInternalList<String> sourceIds

          A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

          Example: my-cluster-1, my-cluster-2

          Example: my-snapshot-20131010

        • sourceType

          String sourceType

          The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.

          Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

        • subscriptionName

          String subscriptionName

          The name of the modified Amazon Redshift event notification subscription.

    • Class com.amazonaws.services.redshift.model.ModifySnapshotCopyRetentionPeriodRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterIdentifier

          String clusterIdentifier

          The unique identifier of the cluster for which you want to change the retention period for automated snapshots that are copied to a destination region.

          Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

        • retentionPeriod

          Integer retentionPeriod

          The number of days to retain automated snapshots in the destination region after they are copied from the source region.

          If you decrease the retention period for automated snapshots that are copied to a destination region, Amazon Redshift will delete any existing automated snapshots that were copied to the destination region and that fall outside of the new retention period.

          Constraints: Must be at least 1 and no more than 35.

    • Class com.amazonaws.services.redshift.model.NumberOfNodesPerClusterLimitExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.NumberOfNodesQuotaExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.OrderableClusterOption extends Object implements Serializable

      • Serialized Fields

        • availabilityZones

          com.amazonaws.internal.SdkInternalList<AvailabilityZone> availabilityZones

          A list of availability zones for the orderable cluster.

        • clusterType

          String clusterType

          The cluster type, for example multi-node.

        • clusterVersion

          String clusterVersion

          The version of the orderable cluster.

        • nodeType

          String nodeType

          The node type for the orderable cluster.

    • Class com.amazonaws.services.redshift.model.Parameter extends Object implements Serializable

      • Serialized Fields

        • allowedValues

          String allowedValues

          The valid range of values for the parameter.

        • applyType

          String applyType

          Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

        • dataType

          String dataType

          The data type of the parameter.

        • description

          String description

          A description of the parameter.

        • isModifiable

          Boolean isModifiable

          If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

        • minimumEngineVersion

          String minimumEngineVersion

          The earliest engine version to which the parameter can apply.

        • parameterName

          String parameterName

          The name of the parameter.

        • parameterValue

          String parameterValue

          The value of the parameter.

        • source

          String source

          The source of the parameter value, such as "engine-default" or "user".

    • Class com.amazonaws.services.redshift.model.PendingModifiedValues extends Object implements Serializable

      • Serialized Fields

        • automatedSnapshotRetentionPeriod

          Integer automatedSnapshotRetentionPeriod

          The pending or in-progress change of the automated snapshot retention period.

        • clusterIdentifier

          String clusterIdentifier

          The pending or in-progress change of the new identifier for the cluster.

        • clusterType

          String clusterType

          The pending or in-progress change of the cluster type.

        • clusterVersion

          String clusterVersion

          The pending or in-progress change of the service version.

        • masterUserPassword

          String masterUserPassword

          The pending or in-progress change of the master user password for the cluster.

        • nodeType

          String nodeType

          The pending or in-progress change of the cluster's node type.

        • numberOfNodes

          Integer numberOfNodes

          The pending or in-progress change of the number of nodes in the cluster.

        • publiclyAccessible

          Boolean publiclyAccessible

          The pending or in-progress change of the ability to connect to the cluster from the public network.

    • Class com.amazonaws.services.redshift.model.PurchaseReservedNodeOfferingRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • nodeCount

          Integer nodeCount

          The number of reserved nodes that you want to purchase.

          Default: 1

        • reservedNodeOfferingId

          String reservedNodeOfferingId

          The unique identifier of the reserved node offering you want to purchase.

    • Class com.amazonaws.services.redshift.model.RebootClusterRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterIdentifier

          String clusterIdentifier

          The cluster identifier.

    • Class com.amazonaws.services.redshift.model.RecurringCharge extends Object implements Serializable

      • Serialized Fields

        • recurringChargeAmount

          Double recurringChargeAmount

          The amount charged per the period of time specified by the recurring charge frequency.

        • recurringChargeFrequency

          String recurringChargeFrequency

          The frequency at which the recurring charge amount is applied.

    • Class com.amazonaws.services.redshift.model.ReservedNode extends Object implements Serializable

      • Serialized Fields

        • currencyCode

          String currencyCode

          The currency code for the reserved cluster.

        • duration

          Integer duration

          The duration of the node reservation in seconds.

        • fixedPrice

          Double fixedPrice

          The fixed cost Amazon Redshift charges you for this reserved node.

        • nodeCount

          Integer nodeCount

          The number of reserved compute nodes.

        • nodeType

          String nodeType

          The node type of the reserved node.

        • offeringType

          String offeringType

          The anticipated utilization of the reserved node, as defined in the reserved node offering.

        • recurringCharges

          com.amazonaws.internal.SdkInternalList<RecurringCharge> recurringCharges

          The recurring charges for the reserved node.

        • reservedNodeId

          String reservedNodeId

          The unique identifier for the reservation.

        • reservedNodeOfferingId

          String reservedNodeOfferingId

          The identifier for the reserved node offering.

        • startTime

          Date startTime

          The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.

        • state

          String state

          The state of the reserved compute node.

          Possible Values:

          • pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.
          • active-This reserved node is owned by the caller and is available for use.
          • payment-failed-Payment failed for the purchase attempt.
        • usagePrice

          Double usagePrice

          The hourly rate Amazon Redshift charges you for this reserved node.

    • Class com.amazonaws.services.redshift.model.ReservedNodeAlreadyExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ReservedNodeNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ReservedNodeOffering extends Object implements Serializable

      • Serialized Fields

        • currencyCode

          String currencyCode

          The currency code for the compute nodes offering.

        • duration

          Integer duration

          The duration, in seconds, for which the offering will reserve the node.

        • fixedPrice

          Double fixedPrice

          The upfront fixed charge you will pay to purchase the specific reserved node offering.

        • nodeType

          String nodeType

          The node type offered by the reserved node offering.

        • offeringType

          String offeringType

          The anticipated utilization of the reserved node, as defined in the reserved node offering.

        • recurringCharges

          com.amazonaws.internal.SdkInternalList<RecurringCharge> recurringCharges

          The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes.

        • reservedNodeOfferingId

          String reservedNodeOfferingId

          The offering identifier.

        • usagePrice

          Double usagePrice

          The rate you are charged for each hour the cluster that is using the offering is running.

    • Class com.amazonaws.services.redshift.model.ReservedNodeOfferingNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ReservedNodeQuotaExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ResetClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • parameterGroupName

          String parameterGroupName

          The name of the cluster parameter group to be reset.

        • parameters

          com.amazonaws.internal.SdkInternalList<Parameter> parameters

          An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.

          Constraints: A maximum of 20 parameters can be reset in a single request.

        • resetAllParameters

          Boolean resetAllParameters

          If true, all parameters in the specified parameter group will be reset to their default values.

          Default: true

    • Class com.amazonaws.services.redshift.model.ResetClusterParameterGroupResult extends Object implements Serializable

      • Serialized Fields

        • parameterGroupName

          String parameterGroupName

          The name of the cluster parameter group.

        • parameterGroupStatus

          String parameterGroupStatus

          The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.

    • Class com.amazonaws.services.redshift.model.ResizeNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.RestoreFromClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • additionalInfo

          String additionalInfo

          Reserved.

        • allowVersionUpgrade

          Boolean allowVersionUpgrade

          If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

          Default: true

        • automatedSnapshotRetentionPeriod

          Integer automatedSnapshotRetentionPeriod

          The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

          Default: The value selected for the cluster from which the snapshot was taken.

          Constraints: Must be a value from 0 to 35.

        • availabilityZone

          String availabilityZone

          The Amazon EC2 Availability Zone in which to restore the cluster.

          Default: A random, system-chosen Availability Zone.

          Example: us-east-1a

        • clusterIdentifier

          String clusterIdentifier

          The identifier of the cluster that will be created from restoring the snapshot.

          Constraints:

          • Must contain from 1 to 63 alphanumeric characters or hyphens.
          • Alphabetic characters must be lowercase.
          • First character must be a letter.
          • Cannot end with a hyphen or contain two consecutive hyphens.
          • Must be unique for all clusters within an AWS account.

        • clusterParameterGroupName

          String clusterParameterGroupName

          The name of the parameter group to be associated with this cluster.

          Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.

          Constraints:

          • Must be 1 to 255 alphanumeric characters or hyphens.
          • First character must be a letter.
          • Cannot end with a hyphen or contain two consecutive hyphens.
        • clusterSecurityGroups

          com.amazonaws.internal.SdkInternalList<String> clusterSecurityGroups

          A list of security groups to be associated with this cluster.

          Default: The default cluster security group for Amazon Redshift.

          Cluster security groups only apply to clusters outside of VPCs.

        • clusterSubnetGroupName

          String clusterSubnetGroupName

          The name of the subnet group where you want to cluster restored.

          A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.

        • elasticIp

          String elasticIp

          The elastic IP (EIP) address for the cluster.

        • hsmClientCertificateIdentifier

          String hsmClientCertificateIdentifier

          Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

        • hsmConfigurationIdentifier

          String hsmConfigurationIdentifier

          Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

        • iamRoles

          com.amazonaws.internal.SdkInternalList<String> iamRoles

          A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.

          A cluster can have up to 10 IAM roles associated at any time.

        • kmsKeyId

          String kmsKeyId

          The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.

        • nodeType

          String nodeType

          The node type that the restored cluster will be provisioned with.

          Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds2.xlarge into ds1.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide

        • ownerAccount

          String ownerAccount

          The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

        • port

          Integer port

          The port number on which the cluster accepts connections.

          Default: The same port as the original cluster.

          Constraints: Must be between 1115 and 65535.

        • preferredMaintenanceWindow

          String preferredMaintenanceWindow

          The weekly time range (in UTC) during which automated cluster maintenance can occur.

          Format: ddd:hh24:mi-ddd:hh24:mi

          Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

          Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

          Constraints: Minimum 30-minute window.

        • publiclyAccessible

          Boolean publiclyAccessible

          If true, the cluster can be accessed from a public network.

        • snapshotClusterIdentifier

          String snapshotClusterIdentifier

          The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

        • snapshotIdentifier

          String snapshotIdentifier

          The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

          Example: my-snapshot-id

        • vpcSecurityGroupIds

          com.amazonaws.internal.SdkInternalList<String> vpcSecurityGroupIds

          A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

          Default: The default VPC security group is associated with the cluster.

          VPC security groups only apply to clusters in VPCs.

    • Class com.amazonaws.services.redshift.model.RestoreStatus extends Object implements Serializable

      • Serialized Fields

        • currentRestoreRateInMegaBytesPerSecond

          Double currentRestoreRateInMegaBytesPerSecond

          The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.

        • elapsedTimeInSeconds

          Long elapsedTimeInSeconds

          The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.

        • estimatedTimeToCompletionInSeconds

          Long estimatedTimeToCompletionInSeconds

          The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.

        • progressInMegaBytes

          Long progressInMegaBytes

          The number of megabytes that have been transferred from snapshot storage.

        • snapshotSizeInMegaBytes

          Long snapshotSizeInMegaBytes

          The size of the set of snapshot data used to restore the cluster.

        • status

          String status

          The status of the restore action. Returns starting, restoring, completed, or failed.

    • Class com.amazonaws.services.redshift.model.RestoreTableFromClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterIdentifier

          String clusterIdentifier

          The identifier of the Amazon Redshift cluster to restore the table to.

        • newTableName

          String newTableName

          The name of the table to create as a result of the current request.

        • snapshotIdentifier

          String snapshotIdentifier

          The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.

        • sourceDatabaseName

          String sourceDatabaseName

          The name of the source database that contains the table to restore from.

        • sourceSchemaName

          String sourceSchemaName

          The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.

        • sourceTableName

          String sourceTableName

          The name of the source table to restore from.

        • targetDatabaseName

          String targetDatabaseName

          The name of the database to restore the table to.

        • targetSchemaName

          String targetSchemaName

          The name of the schema to restore the table to.

    • Class com.amazonaws.services.redshift.model.RevokeClusterSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • cIDRIP

          String cIDRIP

          The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.

        • clusterSecurityGroupName

          String clusterSecurityGroupName

          The name of the security Group from which to revoke the ingress rule.

        • eC2SecurityGroupName

          String eC2SecurityGroupName

          The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided.

        • eC2SecurityGroupOwnerId

          String eC2SecurityGroupOwnerId

          The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.

          Example: 111122223333

    • Class com.amazonaws.services.redshift.model.RevokeSnapshotAccessRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • accountWithRestoreAccess

          String accountWithRestoreAccess

          The identifier of the AWS customer account that can no longer restore the specified snapshot.

        • snapshotClusterIdentifier

          String snapshotClusterIdentifier

          The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

        • snapshotIdentifier

          String snapshotIdentifier

          The identifier of the snapshot that the account can no longer access.

    • Class com.amazonaws.services.redshift.model.RotateEncryptionKeyRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • clusterIdentifier

          String clusterIdentifier

          The unique identifier of the cluster that you want to rotate the encryption keys for.

          Constraints: Must be the name of valid cluster that has encryption enabled.

    • Class com.amazonaws.services.redshift.model.Snapshot extends Object implements Serializable

      • Serialized Fields

        • accountsWithRestoreAccess

          com.amazonaws.internal.SdkInternalList<AccountWithRestoreAccess> accountsWithRestoreAccess

          A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

        • actualIncrementalBackupSizeInMegaBytes

          Double actualIncrementalBackupSizeInMegaBytes

          The size of the incremental backup.

        • availabilityZone

          String availabilityZone

          The Availability Zone in which the cluster was created.

        • backupProgressInMegaBytes

          Double backupProgressInMegaBytes

          The number of megabytes that have been transferred to the snapshot backup.

        • clusterCreateTime

          Date clusterCreateTime

          The time (UTC) when the cluster was originally created.

        • clusterIdentifier

          String clusterIdentifier

          The identifier of the cluster for which the snapshot was taken.

        • clusterVersion

          String clusterVersion

          The version ID of the Amazon Redshift engine that is running on the cluster.

        • currentBackupRateInMegaBytesPerSecond

          Double currentBackupRateInMegaBytesPerSecond

          The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

        • dBName

          String dBName

          The name of the database that was created when the cluster was created.

        • elapsedTimeInSeconds

          Long elapsedTimeInSeconds

          The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

        • encrypted

          Boolean encrypted

          If true, the data in the snapshot is encrypted at rest.

        • encryptedWithHSM

          Boolean encryptedWithHSM

          A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

        • estimatedSecondsToCompletion

          Long estimatedSecondsToCompletion

          The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

        • kmsKeyId

          String kmsKeyId

          The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

        • masterUsername

          String masterUsername

          The master user name for the cluster.

        • nodeType

          String nodeType

          The node type of the nodes in the cluster.

        • numberOfNodes

          Integer numberOfNodes

          The number of nodes in the cluster.

        • ownerAccount

          String ownerAccount

          For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

        • port

          Integer port

          The port that the cluster is listening on.

        • restorableNodeTypes

          com.amazonaws.internal.SdkInternalList<String> restorableNodeTypes

          The list of node types that this cluster snapshot is able to restore into.

        • snapshotCreateTime

          Date snapshotCreateTime

          The time (UTC) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

        • snapshotIdentifier

          String snapshotIdentifier

          The snapshot identifier that is provided in the request.

        • snapshotType

          String snapshotType

          The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot will be of type "manual".

        • sourceRegion

          String sourceRegion

          The source region from which the snapshot was copied.

        • status

          String status

          The snapshot status. The value of the status depends on the API operation used.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          The list of tags for the cluster snapshot.

        • totalBackupSizeInMegaBytes

          Double totalBackupSizeInMegaBytes

          The size of the complete set of backup data that would be used to restore the cluster.

        • vpcId

          String vpcId

          The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

    • Class com.amazonaws.services.redshift.model.SnapshotCopyAlreadyDisabledException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.SnapshotCopyAlreadyEnabledException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.SnapshotCopyDisabledException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.SnapshotCopyGrant extends Object implements Serializable

      • Serialized Fields

        • kmsKeyId

          String kmsKeyId

          The unique identifier of the customer master key (CMK) in AWS KMS to which Amazon Redshift is granted permission.

        • snapshotCopyGrantName

          String snapshotCopyGrantName

          The name of the snapshot copy grant.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          A list of tag instances.

    • Class com.amazonaws.services.redshift.model.SnapshotCopyGrantAlreadyExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.SnapshotCopyGrantNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.SnapshotCopyGrantQuotaExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.SNSInvalidTopicException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.SNSNoAuthorizationException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.SNSTopicArnNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.SourceNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.Subnet extends Object implements Serializable

      • Serialized Fields

        • subnetAvailabilityZone

          AvailabilityZone subnetAvailabilityZone
        • subnetIdentifier

          String subnetIdentifier

          The identifier of the subnet.

        • subnetStatus

          String subnetStatus

          The status of the subnet.

    • Class com.amazonaws.services.redshift.model.SubnetAlreadyInUseException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.SubscriptionAlreadyExistException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.SubscriptionCategoryNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.SubscriptionEventIdNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.SubscriptionNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.SubscriptionSeverityNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.TableRestoreNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.TableRestoreStatus extends Object implements Serializable

      • Serialized Fields

        • clusterIdentifier

          String clusterIdentifier

          The identifier of the Amazon Redshift cluster that the table is being restored to.

        • message

          String message

          A description of the status of the table restore request. Status values include SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS.

        • newTableName

          String newTableName

          The name of the table to create as a result of the table restore request.

        • progressInMegaBytes

          Long progressInMegaBytes

          The amount of data restored to the new table so far, in megabytes (MB).

        • requestTime

          Date requestTime

          The time that the table restore request was made, in Universal Coordinated Time (UTC).

        • snapshotIdentifier

          String snapshotIdentifier

          The identifier of the snapshot that the table is being restored from.

        • sourceDatabaseName

          String sourceDatabaseName

          The name of the source database that contains the table being restored.

        • sourceSchemaName

          String sourceSchemaName

          The name of the source schema that contains the table being restored.

        • sourceTableName

          String sourceTableName

          The name of the source table being restored.

        • status

          String status

          A value that describes the current state of the table restore request.

          Valid Values: SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS

        • tableRestoreRequestId

          String tableRestoreRequestId

          The unique identifier for the table restore request.

        • targetDatabaseName

          String targetDatabaseName

          The name of the database to restore the table to.

        • targetSchemaName

          String targetSchemaName

          The name of the schema to restore the table to.

        • totalDataInMegaBytes

          Long totalDataInMegaBytes

          The total amount of data to restore to the new table, in megabytes (MB).

    • Class com.amazonaws.services.redshift.model.Tag extends Object implements Serializable

      • Serialized Fields

        • key

          String key

          The key, or name, for the resource tag.

        • value

          String value

          The value for the resource tag.

    • Class com.amazonaws.services.redshift.model.TaggedResource extends Object implements Serializable

      • Serialized Fields

        • resourceName

          String resourceName

          The Amazon Resource Name (ARN) with which the tag is associated. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.

        • resourceType

          String resourceType

          The type of resource with which the tag is associated. Valid resource types are:

          • Cluster
          • CIDR/IP
          • EC2 security group
          • Snapshot
          • Cluster security group
          • Subnet group
          • HSM connection
          • HSM certificate
          • Parameter group

          For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.

        • tag

          Tag tag

          The tag for the resource.

    • Class com.amazonaws.services.redshift.model.TagLimitExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.UnauthorizedOperationException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.UnknownSnapshotCopyRegionException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.UnsupportedOperationException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.UnsupportedOptionException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.redshift.model.VpcSecurityGroupMembership extends Object implements Serializable

      • Serialized Fields

        • status

          String status

          The status of the VPC security group.

        • vpcSecurityGroupId

          String vpcSecurityGroupId

          The identifier of the VPC security group.

  • Package com.amazonaws.services.route53.model

    • Class com.amazonaws.services.route53.model.AlarmIdentifier extends Object implements Serializable

      • Serialized Fields

        • name

          String name

          The name of the CloudWatch alarm.

        • region

          String region

          The CloudWatchRegion that the CloudWatch alarm was created in.

    • Class com.amazonaws.services.route53.model.AliasTarget extends Object implements Serializable

      • Serialized Fields

        • dNSName

          String dNSName

          Alias resource record sets only: The external DNS name associated with the AWS Resource. The value that you specify depends on where you want to route queries:

          • A CloudFront distribution: Specify the domain name that CloudFront assigned when you created your distribution. Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.
          • An ELB load balancer: Specify the DNS name associated with the load balancer. You can get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for HostedZoneId and DNSName. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail.
          • An Elastic Beanstalk environment: Specify the CNAME attribute for the environment. (The environment must have a regionalized domain name.)
          • An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon S3 website endpoint in which you created the bucket; for example, s3-website-us-east-1.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference. For more information about using Amazon S3 buckets for websites, see Hosting a Static Website on Amazon S3 in the Amazon Simple Storage Service Developer Guide.
          • Another Amazon Route 53 resource record set: Specify the value of the Name element for a resource record set in the current hosted zone.

          For more information and an example, see Example: Creating Alias Resource Record Sets in the Amazon Route 53 API Reference.

        • evaluateTargetHealth

          Boolean evaluateTargetHealth

          Alias resource record sets only: If you set the value of EvaluateTargetHealth to true for the resource record set or sets in an alias, weighted alias, latency alias, or failover alias resource record set, and if you specify a value for HealthCheckId for every resource record set that is referenced by these alias resource record sets, the alias resource record sets inherit the health of the referenced resource record sets.

          In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:

          1. Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.
          2. Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)
          3. Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.
          4. Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.

          Note the following:

          • You cannot set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.
          • If the AWS resource that you specify in AliasTarget is a resource record set or a group of resource record sets (for example, a group of weighted resource record sets), but it is not another alias resource record set, we recommend that you associate a health check with all of the resource record sets in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
          • If you specify an ELB load balancer in AliasTarget, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If no Amazon EC2 instances are healthy or if the load balancer itself is unhealthy, and if EvaluateTargetHealth is true for the corresponding alias resource record set, Amazon Route 53 routes queries to other resources.
          • When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Amazon Route 53 health checks, but they perform a similar function. Do not create Amazon Route 53 health checks for the Amazon EC2 instances that you register with an ELB load balancer. For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developer Guide.

          We recommend that you set EvaluateTargetHealth to true only when you have enough idle capacity to handle the failure of one or more endpoints.

          For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

        • hostedZoneId

          String hostedZoneId

          Alias resource record sets only: The value you use depends on where you want to route queries:

          • A CloudFront distribution: Specify Z2FDTNDATAQYW2 .
          • An ELB load balancer: Specify the value of the hosted zone ID for the load balancer. You can get the hosted zone ID by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for HostedZoneId and DNSName. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail.
          • An Amazon S3 bucket that is configured as a static website: Specify the hosted zone ID for the Amazon S3 website endpoint in which you created the bucket. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference.
          • Another Amazon Route 53 resource record set in your hosted zone: Specify the hosted zone ID of your hosted zone. (An alias resource record set cannot reference a resource record set in a different hosted zone.)

          For more information and an example, see Example: Creating Alias Resource Record Sets in the Amazon Route 53 API Reference.

    • Class com.amazonaws.services.route53.model.AssociateVPCWithHostedZoneRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • comment

          String comment

          Optional: Any comments you want to include about a AssociateVPCWithHostedZoneRequest.

        • hostedZoneId

          String hostedZoneId

          The ID of the hosted zone you want to associate your VPC with.

          Note that you cannot associate a VPC with a hosted zone that doesn't have an existing VPC association.

        • vPC

          VPC vPC

          The VPC that you want your hosted zone to be associated with.

    • Class com.amazonaws.services.route53.model.AssociateVPCWithHostedZoneResult extends Object implements Serializable

      • Serialized Fields

        • changeInfo

          ChangeInfo changeInfo

          A complex type that contains the ID, the status, and the date and time of your AssociateVPCWithHostedZoneRequest.

    • Class com.amazonaws.services.route53.model.Change extends Object implements Serializable

      • Serialized Fields

        • action

          String action

          The action to perform:

          • CREATE: Creates a resource record set that has the specified values.
          • DELETE: Deletes a existing resource record set that has the specified values for Name, Type, SetIdentifier (for latency, weighted, geolocation, and failover resource record sets), and TTL (except alias resource record sets, for which the TTL is determined by the AWS resource that you're routing DNS queries to).
          • UPSERT: If a resource record set does not already exist, Amazon Route 53 creates it. If a resource record set does exist, Amazon Route 53 updates it with the values in the request. Amazon Route 53 can update an existing resource record set only when all of the following values match: Name, Type, and SetIdentifier (for weighted, latency, geolocation, and failover resource record sets).
        • resourceRecordSet

          ResourceRecordSet resourceRecordSet

          Information about the resource record set to create or delete.

    • Class com.amazonaws.services.route53.model.ChangeBatch extends Object implements Serializable

      • Serialized Fields

        • changes

          com.amazonaws.internal.SdkInternalList<Change> changes

          A complex type that contains one Change element for each resource record set that you want to create or delete.

        • comment

          String comment

          Optional: Any comments you want to include about a change batch request.

    • Class com.amazonaws.services.route53.model.ChangeBatchRecord extends Object implements Serializable

      • Serialized Fields

        • changes

          com.amazonaws.internal.SdkInternalList<Change> changes
          Deprecated.

          A list of changes made in the ChangeBatch.

        • comment

          String comment
          Deprecated.

          A complex type that describes change information about changes made to your hosted zone.

          This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

        • id

          String id
          Deprecated.

          The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.

        • status

          String status
          Deprecated.

          The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

          Valid Values: PENDING | INSYNC

        • submittedAt

          Date submittedAt
          Deprecated.

          The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC).

        • submitter

          String submitter
          Deprecated.

          The AWS account ID attached to the changes.

    • Class com.amazonaws.services.route53.model.ChangeInfo extends Object implements Serializable

      • Serialized Fields

        • comment

          String comment

          A complex type that describes change information about changes made to your hosted zone.

          This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

        • id

          String id

          The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.

        • status

          String status

          The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

          Valid Values: PENDING | INSYNC

        • submittedAt

          Date submittedAt

          The date and time the change was submitted, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC).

    • Class com.amazonaws.services.route53.model.ChangeResourceRecordSetsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • changeBatch

          ChangeBatch changeBatch

          A complex type that contains an optional comment and the Changes element.

        • hostedZoneId

          String hostedZoneId

          The ID of the hosted zone that contains the resource record sets that you want to change.

    • Class com.amazonaws.services.route53.model.ChangeResourceRecordSetsResult extends Object implements Serializable

      • Serialized Fields

        • changeInfo

          ChangeInfo changeInfo

          A complex type that contains information about changes made to your hosted zone.

          This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

    • Class com.amazonaws.services.route53.model.ChangeTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • addTags

          com.amazonaws.internal.SdkInternalList<Tag> addTags

          A complex type that contains a list of Tag elements. Each Tag element identifies a tag that you want to add or update for the specified resource.

        • removeTagKeys

          com.amazonaws.internal.SdkInternalList<String> removeTagKeys

          A list of Tag keys that you want to remove from the specified resource.

        • resourceId

          String resourceId

          The ID of the resource for which you want to add, change, or delete tags.

        • resourceType

          String resourceType

          The type of the resource.

          - The resource type for health checks is healthcheck.

          - The resource type for hosted zones is hostedzone.

    • Class com.amazonaws.services.route53.model.ChangeTagsForResourceResult extends Object implements Serializable

    • Class com.amazonaws.services.route53.model.CloudWatchAlarmConfiguration extends Object implements Serializable

      • Serialized Fields

        • comparisonOperator

          String comparisonOperator

          The arithmetic operation to use when comparing the specified Statistic and Threshold.

          Valid Values are GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold and LessThanOrEqualToThreshold

        • dimensions

          com.amazonaws.internal.SdkInternalList<Dimension> dimensions

          A list of Dimension elements for the CloudWatch metric that is associated with the CloudWatch alarm. For information about the metrics and dimensions that CloudWatch supports, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference.

        • evaluationPeriods

          Integer evaluationPeriods

          The number of periods over which data is compared to the specified threshold.

        • metricName

          String metricName

          The name of the CloudWatch metric that is associated with the CloudWatch alarm.

        • namespace

          String namespace

          The namespace of the CloudWatch metric that is associated with the CloudWatch alarm.

        • period

          Integer period

          An integer that represents the period in seconds over which the statistic is applied.

        • statistic

          String statistic

          The statistic to apply to the CloudWatch metric that is associated with the CloudWatch alarm.

          Valid Values are SampleCount, Average, Sum, Minimum and Maximum

        • threshold

          Double threshold

          The value that the metric is compared with to determine the state of the alarm. For example, if you want the health check to fail if the average TCP connection time is greater than 500 milliseconds for more than 60 seconds, the threshold is 500.

    • Class com.amazonaws.services.route53.model.ConcurrentModificationException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.ConflictingDomainExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.ConflictingTypesException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.CreateHealthCheckRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • callerReference

          String callerReference

          A unique string that identifies the request and that allows failed CreateHealthCheck requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a health check. CallerReference can be any unique string; you might choose to use a string that identifies your project.

          Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.

        • healthCheckConfig

          HealthCheckConfig healthCheckConfig

          A complex type that contains health check configuration.

    • Class com.amazonaws.services.route53.model.CreateHealthCheckResult extends Object implements Serializable

      • Serialized Fields

        • healthCheck

          HealthCheck healthCheck

          A complex type that contains identifying information about the health check.

        • location

          String location

          The unique URL representing the new health check.

    • Class com.amazonaws.services.route53.model.CreateHostedZoneRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • callerReference

          String callerReference

          A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a hosted zone. CallerReference can be any unique string; you might choose to use a string that identifies your project, such as DNSMigration_01.

          Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.

        • delegationSetId

          String delegationSetId

          The delegation set id of the reusable delgation set whose NS records you want to assign to the new hosted zone.

        • hostedZoneConfig

          HostedZoneConfig hostedZoneConfig

          A complex type that contains an optional comment about your hosted zone.

        • name

          String name

          The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

          This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.

        • vPC

          VPC vPC

          The VPC that you want your hosted zone to be associated with. By providing this parameter, your newly created hosted cannot be resolved anywhere other than the given VPC.

    • Class com.amazonaws.services.route53.model.CreateHostedZoneResult extends Object implements Serializable

      • Serialized Fields

        • changeInfo

          ChangeInfo changeInfo

          A complex type that contains information about the request to create a hosted zone. This includes an ID that you use when you call the GetChange action to get the current status of the change request.

        • delegationSet

          DelegationSet delegationSet

          A complex type that contains name server information.

        • hostedZone

          HostedZone hostedZone

          A complex type that contains identifying information about the hosted zone.

        • location

          String location

          The unique URL representing the new hosted zone.

        • vPC

          VPC vPC
    • Class com.amazonaws.services.route53.model.CreateReusableDelegationSetRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • callerReference

          String callerReference

          A unique string that identifies the request and that allows failed CreateReusableDelegationSet requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you create a reusable delegation set. CallerReference can be any unique string; you might choose to use a string that identifies your project, such as DNSMigration_01.

          Valid characters are any Unicode code points that are legal in an XML 1.0 document. The UTF-8 encoding of the value must be less than 128 bytes.

        • hostedZoneId

          String hostedZoneId

          The ID of the hosted zone whose delegation set you want to mark as reusable. It is an optional parameter.

    • Class com.amazonaws.services.route53.model.CreateReusableDelegationSetResult extends Object implements Serializable

      • Serialized Fields

        • delegationSet

          DelegationSet delegationSet

          A complex type that contains name server information.

        • location

          String location

          The unique URL representing the new reusbale delegation set.

    • Class com.amazonaws.services.route53.model.CreateTrafficPolicyInstanceRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • hostedZoneId

          String hostedZoneId

          The ID of the hosted zone in which you want Amazon Route 53 to create resource record sets by using the configuration in a traffic policy.

        • name

          String name

          The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Amazon Route 53 creates for this traffic policy instance.

        • trafficPolicyId

          String trafficPolicyId

          The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.

        • trafficPolicyVersion

          Integer trafficPolicyVersion

          The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone.

        • tTL

          Long tTL

          The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone.

    • Class com.amazonaws.services.route53.model.CreateTrafficPolicyInstanceResult extends Object implements Serializable

      • Serialized Fields

        • location

          String location

          A unique URL that represents a new traffic policy instance.

        • trafficPolicyInstance

          TrafficPolicyInstance trafficPolicyInstance

          A complex type that contains settings for the new traffic policy instance.

    • Class com.amazonaws.services.route53.model.CreateTrafficPolicyRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • comment

          String comment

          Any comments that you want to include about the traffic policy.

        • document

          String document

          The definition of this traffic policy in JSON format.

        • name

          String name

          The name of the traffic policy.

    • Class com.amazonaws.services.route53.model.CreateTrafficPolicyResult extends Object implements Serializable

      • Serialized Fields

        • location

          String location
        • trafficPolicy

          TrafficPolicy trafficPolicy

          A complex type that contains settings for the new traffic policy.

    • Class com.amazonaws.services.route53.model.CreateTrafficPolicyVersionRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • comment

          String comment

          Any comments that you want to include about the new traffic policy version.

        • document

          String document

          The definition of a new traffic policy version, in JSON format. You must specify the full definition of the new traffic policy. You cannot specify just the differences between the new version and a previous version.

        • id

          String id

          The ID of the traffic policy for which you want to create a new version.

    • Class com.amazonaws.services.route53.model.CreateTrafficPolicyVersionResult extends Object implements Serializable

      • Serialized Fields

        • location

          String location
        • trafficPolicy

          TrafficPolicy trafficPolicy

          A complex type that contains settings for the new version of the traffic policy.

    • Class com.amazonaws.services.route53.model.DelegationSet extends Object implements Serializable

      • Serialized Fields

        • callerReference

          String callerReference
        • id

          String id
        • nameServers

          com.amazonaws.internal.SdkInternalList<String> nameServers

          A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.

    • Class com.amazonaws.services.route53.model.DelegationSetAlreadyCreatedException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.DelegationSetAlreadyReusableException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.DelegationSetInUseException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.DelegationSetNotAvailableException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.DelegationSetNotReusableException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.DeleteHealthCheckRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • healthCheckId

          String healthCheckId

          The ID of the health check to delete.

    • Class com.amazonaws.services.route53.model.DeleteHealthCheckResult extends Object implements Serializable

    • Class com.amazonaws.services.route53.model.DeleteHostedZoneRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • id

          String id

          The ID of the hosted zone you want to delete.

    • Class com.amazonaws.services.route53.model.DeleteHostedZoneResult extends Object implements Serializable

      • Serialized Fields

        • changeInfo

          ChangeInfo changeInfo

          A complex type that contains the ID, the status, and the date and time of your delete request.

    • Class com.amazonaws.services.route53.model.DeleteReusableDelegationSetRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • id

          String id

          The ID of the reusable delegation set you want to delete.

    • Class com.amazonaws.services.route53.model.DeleteReusableDelegationSetResult extends Object implements Serializable

    • Class com.amazonaws.services.route53.model.DeleteTrafficPolicyInstanceRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • id

          String id

          The ID of the traffic policy instance that you want to delete.

          When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created the traffic policy instance.
    • Class com.amazonaws.services.route53.model.DeleteTrafficPolicyInstanceResult extends Object implements Serializable

    • Class com.amazonaws.services.route53.model.DeleteTrafficPolicyRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • id

          String id

          The ID of the traffic policy that you want to delete.

        • version

          Integer version

          The version number of the traffic policy that you want to delete.

    • Class com.amazonaws.services.route53.model.DeleteTrafficPolicyResult extends Object implements Serializable

    • Class com.amazonaws.services.route53.model.Dimension extends Object implements Serializable

      • Serialized Fields

        • name

          String name

          The name of the dimension.

        • value

          String value

          The value of the dimension.

    • Class com.amazonaws.services.route53.model.DisassociateVPCFromHostedZoneRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • comment

          String comment

          Optional: Any comments you want to include about a DisassociateVPCFromHostedZoneRequest.

        • hostedZoneId

          String hostedZoneId

          The ID of the hosted zone you want to disassociate your VPC from.

          Note that you cannot disassociate the last VPC from a hosted zone.

        • vPC

          VPC vPC

          The VPC that you want your hosted zone to be disassociated from.

    • Class com.amazonaws.services.route53.model.DisassociateVPCFromHostedZoneResult extends Object implements Serializable

      • Serialized Fields

        • changeInfo

          ChangeInfo changeInfo

          A complex type that contains the ID, the status, and the date and time of your DisassociateVPCFromHostedZoneRequest.

    • Class com.amazonaws.services.route53.model.GeoLocation extends Object implements Serializable

      • Serialized Fields

        • continentCode

          String continentCode

          The code for a continent geo location. Note: only continent locations have a continent code.

          Valid values: AF | AN | AS | EU | OC | NA | SA

          Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

        • countryCode

          String countryCode

          The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

          The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

        • subdivisionCode

          String subdivisionCode

          The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

          Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

    • Class com.amazonaws.services.route53.model.GeoLocationDetails extends Object implements Serializable

      • Serialized Fields

        • continentCode

          String continentCode

          The code for a continent geo location. Note: only continent locations have a continent code.

        • continentName

          String continentName

          The name of the continent. This element is only present if ContinentCode is also present.

        • countryCode

          String countryCode

          The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

          The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

        • countryName

          String countryName

          The name of the country. This element is only present if CountryCode is also present.

        • subdivisionCode

          String subdivisionCode

          The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

        • subdivisionName

          String subdivisionName

          The name of the subdivision. This element is only present if SubdivisionCode is also present.

    • Class com.amazonaws.services.route53.model.GetChangeDetailsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • id

          String id

          The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request.

    • Class com.amazonaws.services.route53.model.GetChangeDetailsResult extends Object implements Serializable

      • Serialized Fields

        • changeBatchRecord

          ChangeBatchRecord changeBatchRecord
          Deprecated.

          A complex type that contains information about the specified change batch, including the change batch ID, the status of the change, and the contained changes.

    • Class com.amazonaws.services.route53.model.GetChangeRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • id

          String id

          The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request.

    • Class com.amazonaws.services.route53.model.GetChangeResult extends Object implements Serializable

      • Serialized Fields

        • changeInfo

          ChangeInfo changeInfo

          A complex type that contains information about the specified change batch, including the change batch ID, the status of the change, and the date and time of the request.

    • Class com.amazonaws.services.route53.model.GetCheckerIpRangesRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.route53.model.GetCheckerIpRangesResult extends Object implements Serializable

      • Serialized Fields

        • checkerIpRanges

          com.amazonaws.internal.SdkInternalList<String> checkerIpRanges

          A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.

    • Class com.amazonaws.services.route53.model.GetGeoLocationRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • continentCode

          String continentCode

          The code for a continent geo location. Note: only continent locations have a continent code.

          Valid values: AF | AN | AS | EU | OC | NA | SA

          Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

        • countryCode

          String countryCode

          The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

          The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

        • subdivisionCode

          String subdivisionCode

          The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

          Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

    • Class com.amazonaws.services.route53.model.GetGeoLocationResult extends Object implements Serializable

      • Serialized Fields

        • geoLocationDetails

          GeoLocationDetails geoLocationDetails

          A complex type that contains the information about the specified geo location.

    • Class com.amazonaws.services.route53.model.GetHealthCheckCountRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.route53.model.GetHealthCheckCountResult extends Object implements Serializable

      • Serialized Fields

        • healthCheckCount

          Long healthCheckCount

          The number of health checks associated with the current AWS account.

    • Class com.amazonaws.services.route53.model.GetHealthCheckLastFailureReasonRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • healthCheckId

          String healthCheckId

          The ID of the health check for which you want to retrieve the reason for the most recent failure.

    • Class com.amazonaws.services.route53.model.GetHealthCheckLastFailureReasonResult extends Object implements Serializable

      • Serialized Fields

        • healthCheckObservations

          com.amazonaws.internal.SdkInternalList<HealthCheckObservation> healthCheckObservations

          A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker.

    • Class com.amazonaws.services.route53.model.GetHealthCheckRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • healthCheckId

          String healthCheckId

          The ID of the health check to retrieve.

    • Class com.amazonaws.services.route53.model.GetHealthCheckResult extends Object implements Serializable

      • Serialized Fields

        • healthCheck

          HealthCheck healthCheck

          A complex type that contains the information about the specified health check.

    • Class com.amazonaws.services.route53.model.GetHealthCheckStatusRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • healthCheckId

          String healthCheckId

          If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include the HealthCheckId element and specify the ID of the applicable health check.

          Amazon Route 53 determines whether a resource record set is healthy by periodically sending a request to the endpoint that is specified in the health check. If that endpoint returns an HTTP status code of 2xx or 3xx, the endpoint is healthy. If the endpoint returns an HTTP status code of 400 or greater, or if the endpoint doesn't respond for a certain amount of time, Amazon Route 53 considers the endpoint unhealthy and also considers the resource record set unhealthy.

          The HealthCheckId element is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations:

          • You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set.
          • You set EvaluateTargetHealth to true for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets. For more information about this configuration, see EvaluateTargetHealth.

            Amazon Route 53 doesn't check the health of the endpoint specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Amazon Route 53 checks the health of the endpoint that you specified in the health check.

          For geolocation resource record sets, if an endpoint is unhealthy, Amazon Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value of CountryCode is *), in that order, until it finds a resource record set for which the endpoint is healthy.

          If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-1-www.example.com), not the name of the resource record sets (example.com).

          In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and then associate the health check with those resource record sets, health check results will be unpredictable.
    • Class com.amazonaws.services.route53.model.GetHealthCheckStatusResult extends Object implements Serializable

      • Serialized Fields

        • healthCheckObservations

          com.amazonaws.internal.SdkInternalList<HealthCheckObservation> healthCheckObservations

          A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker.

    • Class com.amazonaws.services.route53.model.GetHostedZoneCountRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.route53.model.GetHostedZoneCountResult extends Object implements Serializable

      • Serialized Fields

        • hostedZoneCount

          Long hostedZoneCount

          The number of hosted zones associated with the current AWS account.

    • Class com.amazonaws.services.route53.model.GetHostedZoneRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • id

          String id

          The ID of the hosted zone for which you want to get a list of the name servers in the delegation set.

    • Class com.amazonaws.services.route53.model.GetHostedZoneResult extends Object implements Serializable

      • Serialized Fields

        • delegationSet

          DelegationSet delegationSet

          A complex type that contains information about the name servers for the specified hosted zone.

        • hostedZone

          HostedZone hostedZone

          A complex type that contains the information about the specified hosted zone.

        • vPCs

          com.amazonaws.internal.SdkInternalList<VPC> vPCs

          A complex type that contains information about VPCs associated with the specified hosted zone.

    • Class com.amazonaws.services.route53.model.GetReusableDelegationSetRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • id

          String id

          The ID of the reusable delegation set for which you want to get a list of the name server.

    • Class com.amazonaws.services.route53.model.GetReusableDelegationSetResult extends Object implements Serializable

      • Serialized Fields

        • delegationSet

          DelegationSet delegationSet

          A complex type that contains the information about the nameservers for the specified delegation set ID.

    • Class com.amazonaws.services.route53.model.GetTrafficPolicyInstanceCountRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.route53.model.GetTrafficPolicyInstanceCountResult extends Object implements Serializable

      • Serialized Fields

        • trafficPolicyInstanceCount

          Integer trafficPolicyInstanceCount

          The number of traffic policy instances that are associated with the current AWS account.

    • Class com.amazonaws.services.route53.model.GetTrafficPolicyInstanceRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • id

          String id

          The ID of the traffic policy instance that you want to get information about.

    • Class com.amazonaws.services.route53.model.GetTrafficPolicyInstanceResult extends Object implements Serializable

      • Serialized Fields

        • trafficPolicyInstance

          TrafficPolicyInstance trafficPolicyInstance

          A complex type that contains settings for the traffic policy instance.

    • Class com.amazonaws.services.route53.model.GetTrafficPolicyRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • id

          String id

          The ID of the traffic policy that you want to get information about.

        • version

          Integer version

          The version number of the traffic policy that you want to get information about.

    • Class com.amazonaws.services.route53.model.GetTrafficPolicyResult extends Object implements Serializable

      • Serialized Fields

        • trafficPolicy

          TrafficPolicy trafficPolicy

          A complex type that contains settings for the specified traffic policy.

    • Class com.amazonaws.services.route53.model.HealthCheck extends Object implements Serializable

      • Serialized Fields

        • callerReference

          String callerReference

          A unique string that identifies the request to create the health check.

        • cloudWatchAlarmConfiguration

          CloudWatchAlarmConfiguration cloudWatchAlarmConfiguration

          For CLOUDWATCH_METRIC health checks, a complex type that contains information about the CloudWatch alarm that you're associating with the health check.

        • healthCheckConfig

          HealthCheckConfig healthCheckConfig

          A complex type that contains the health check configuration.

        • healthCheckVersion

          Long healthCheckVersion

          The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.

        • id

          String id

          The ID of the specified health check.

    • Class com.amazonaws.services.route53.model.HealthCheckAlreadyExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.HealthCheckConfig extends Object implements Serializable

      • Serialized Fields

        • alarmIdentifier

          AlarmIdentifier alarmIdentifier

          A complex type that contains information to uniquely identify the CloudWatch alarm that you're associating with a Route 53 health check.

        • childHealthChecks

          com.amazonaws.internal.SdkInternalList<String> childHealthChecks

          For a specified parent health check, a list of HealthCheckId values for the associated child health checks.

        • enableSNI

          Boolean enableSNI

          Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. If you don't specify a value for EnableSNI, Amazon Route 53 defaults to true when Type is HTTPS or HTTPS_STR_MATCH and defaults to false when Type is any other value.

        • failureThreshold

          Integer failureThreshold

          The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.

          Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.

        • fullyQualifiedDomainName

          String fullyQualifiedDomainName

          Fully qualified domain name of the instance to be health checked.

        • healthThreshold

          Integer healthThreshold

          The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.

        • insufficientDataHealthStatus

          String insufficientDataHealthStatus

          The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy, Unhealthy and LastKnownStatus.

        • inverted

          Boolean inverted

          A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True, then Amazon Route 53 considers the health check to be unhealthy.

        • iPAddress

          String iPAddress

          IP Address of the instance being checked.

        • measureLatency

          Boolean measureLatency

          A Boolean value that indicates whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Amazon Route 53 console.

        • port

          Integer port

          Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.

        • regions

          com.amazonaws.internal.SdkInternalList<String> regions

          A list of HealthCheckRegion values that you want Amazon Route 53 to use to perform health checks for the specified endpoint. You must specify at least three regions.

        • requestInterval

          Integer requestInterval

          The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.

          Each Amazon Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.

        • resourcePath

          String resourcePath

          Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks. The HTTP request is issued to the instance on the given port and path.

        • searchString

          String searchString

          A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks. Amazon Route 53 considers case when searching for SearchString in the response body.

        • type

          String type

          The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, CALCULATED and CLOUDWATCH_METRIC.

    • Class com.amazonaws.services.route53.model.HealthCheckInUseException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.HealthCheckObservation extends Object implements Serializable

      • Serialized Fields

        • iPAddress

          String iPAddress

          The IP address of the Amazon Route 53 health checker that performed this health check.

        • region

          String region

          The HealthCheckRegion of the Amazon Route 53 health checker that performed this health check.

        • statusReport

          StatusReport statusReport

          A complex type that contains information about the health check status for the current observation.

    • Class com.amazonaws.services.route53.model.HealthCheckVersionMismatchException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.HostedZone extends Object implements Serializable

      • Serialized Fields

        • callerReference

          String callerReference

          A unique string that identifies the request to create the hosted zone.

        • config

          HostedZoneConfig config

          A complex type that contains the Comment element.

        • id

          String id

          The ID of the specified hosted zone.

        • name

          String name

          The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

          This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.

        • resourceRecordSetCount

          Long resourceRecordSetCount

          Total number of resource record sets in the hosted zone.

    • Class com.amazonaws.services.route53.model.HostedZoneAlreadyExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.HostedZoneConfig extends Object implements Serializable

      • Serialized Fields

        • comment

          String comment

          An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.

        • privateZone

          Boolean privateZone
    • Class com.amazonaws.services.route53.model.HostedZoneNotEmptyException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.HostedZoneNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.IncompatibleVersionException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.InvalidArgumentException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.InvalidChangeBatchException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
      • Serialized Fields

        • messages

          com.amazonaws.internal.SdkInternalList<String> messages

          Descriptive message for the error response.

    • Class com.amazonaws.services.route53.model.InvalidDomainNameException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.InvalidInputException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.InvalidTrafficPolicyDocumentException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.InvalidVPCIdException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.LastVPCAssociationException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.LimitsExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.ListChangeBatchesByHostedZoneRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • endDate

          String endDate

          The end of the time period you want to see changes for.

        • hostedZoneId

          String hostedZoneId

          The ID of the hosted zone that you want to see changes for.

        • marker

          String marker

          The page marker.

        • maxItems

          String maxItems

          The maximum number of items on a page.

        • startDate

          String startDate

          The start of the time period you want to see changes for.

    • Class com.amazonaws.services.route53.model.ListChangeBatchesByHostedZoneResult extends Object implements Serializable

      • Serialized Fields

        • changeBatchRecords

          com.amazonaws.internal.SdkInternalList<ChangeBatchRecord> changeBatchRecords
          Deprecated.

          The change batches within the given hosted zone and time period.

        • isTruncated

          Boolean isTruncated
          Deprecated.

          A flag that indicates if there are more change batches to list.

        • marker

          String marker
          Deprecated.

          The page marker.

        • maxItems

          String maxItems
          Deprecated.

          The maximum number of items on a page.

        • nextMarker

          String nextMarker
          Deprecated.

          The next page marker.

    • Class com.amazonaws.services.route53.model.ListChangeBatchesByRRSetRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • endDate

          String endDate

          The end of the time period you want to see changes for.

        • hostedZoneId

          String hostedZoneId

          The ID of the hosted zone that you want to see changes for.

        • marker

          String marker

          The page marker.

        • maxItems

          String maxItems

          The maximum number of items on a page.

        • name

          String name

          The name of the RRSet that you want to see changes for.

        • setIdentifier

          String setIdentifier

          The identifier of the RRSet that you want to see changes for.

        • startDate

          String startDate

          The start of the time period you want to see changes for.

        • type

          String type

          The type of the RRSet that you want to see changes for.

    • Class com.amazonaws.services.route53.model.ListChangeBatchesByRRSetResult extends Object implements Serializable

      • Serialized Fields

        • changeBatchRecords

          com.amazonaws.internal.SdkInternalList<ChangeBatchRecord> changeBatchRecords
          Deprecated.

          The change batches within the given hosted zone and time period.

        • isTruncated

          Boolean isTruncated
          Deprecated.

          A flag that indicates if there are more change batches to list.

        • marker

          String marker
          Deprecated.

          The page marker.

        • maxItems

          String maxItems
          Deprecated.

          The maximum number of items on a page.

        • nextMarker

          String nextMarker
          Deprecated.

          The next page marker.

    • Class com.amazonaws.services.route53.model.ListGeoLocationsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • maxItems

          String maxItems

          The maximum number of geo locations you want in the response body.

        • startContinentCode

          String startContinentCode

          The first continent code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list. For non-continent geo locations, this should be null.

          Valid values: AF | AN | AS | EU | OC | NA | SA

          Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

        • startCountryCode

          String startCountryCode

          The first country code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

          The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

        • startSubdivisionCode

          String startSubdivisionCode

          The first subdivision code in the lexicographic ordering of geo locations that you want the ListGeoLocations request to list.

          Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

    • Class com.amazonaws.services.route53.model.ListGeoLocationsResult extends Object implements Serializable

      • Serialized Fields

        • geoLocationDetailsList

          com.amazonaws.internal.SdkInternalList<GeoLocationDetails> geoLocationDetailsList

          A complex type that contains information about the geo locations that are returned by the request.

        • isTruncated

          Boolean isTruncated

          A flag that indicates whether there are more geo locations to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the values included in the ListGeoLocationsResponse$NextContinentCode, ListGeoLocationsResponse$NextCountryCode and ListGeoLocationsResponse$NextSubdivisionCode elements.

          Valid Values: true | false

        • maxItems

          String maxItems

          The maximum number of records you requested. The maximum value of MaxItems is 100.

        • nextContinentCode

          String nextContinentCode

          If the results were truncated, the continent code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location to list is a continent location.

        • nextCountryCode

          String nextCountryCode

          If the results were truncated, the country code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location to list is not a continent location.

        • nextSubdivisionCode

          String nextSubdivisionCode

          If the results were truncated, the subdivision code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location has a subdivision.

    • Class com.amazonaws.services.route53.model.ListHealthChecksRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • marker

          String marker

          If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

        • maxItems

          String maxItems

          Specify the maximum number of health checks to return per page of results.

    • Class com.amazonaws.services.route53.model.ListHealthChecksResult extends Object implements Serializable

      • Serialized Fields

        • healthChecks

          com.amazonaws.internal.SdkInternalList<HealthCheck> healthChecks

          A complex type that contains information about the health checks associated with the current AWS account.

        • isTruncated

          Boolean isTruncated

          A flag indicating whether there are more health checks to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.

          Valid Values: true | false

        • marker

          String marker

          If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

        • maxItems

          String maxItems

          The maximum number of health checks to be included in the response body. If the number of health checks associated with this AWS account exceeds MaxItems, the value of ListHealthChecksResponse$IsTruncated in the response is true. Call ListHealthChecks again and specify the value of ListHealthChecksResponse$NextMarker in the ListHostedZonesRequest$Marker element to get the next page of results.

        • nextMarker

          String nextMarker

          Indicates where to continue listing health checks. If ListHealthChecksResponse$IsTruncated is true, make another request to ListHealthChecks and include the value of the NextMarker element in the Marker element to get the next page of results.

    • Class com.amazonaws.services.route53.model.ListHostedZonesByNameRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • dNSName

          String dNSName

          The first name in the lexicographic ordering of domain names that you want the ListHostedZonesByNameRequest request to list.

          If the request returned more than one page of results, submit another request and specify the value of NextDNSName and NextHostedZoneId from the last response in the DNSName and HostedZoneId parameters to get the next page of results.

        • hostedZoneId

          String hostedZoneId

          If the request returned more than one page of results, submit another request and specify the value of NextDNSName and NextHostedZoneId from the last response in the DNSName and HostedZoneId parameters to get the next page of results.

        • maxItems

          String maxItems

          Specify the maximum number of hosted zones to return per page of results.

    • Class com.amazonaws.services.route53.model.ListHostedZonesByNameResult extends Object implements Serializable

    • Class com.amazonaws.services.route53.model.ListHostedZonesRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • delegationSetId

          String delegationSetId
        • marker

          String marker

          If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

        • maxItems

          String maxItems

          Specify the maximum number of hosted zones to return per page of results.

    • Class com.amazonaws.services.route53.model.ListHostedZonesResult extends Object implements Serializable

      • Serialized Fields

        • hostedZones

          com.amazonaws.internal.SdkInternalList<HostedZone> hostedZones

          A complex type that contains information about the hosted zones associated with the current AWS account.

        • isTruncated

          Boolean isTruncated

          A flag indicating whether there are more hosted zones to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.

          Valid Values: true | false

        • marker

          String marker

          If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

        • maxItems

          String maxItems

          The maximum number of hosted zones to be included in the response body. If the number of hosted zones associated with this AWS account exceeds MaxItems, the value of ListHostedZonesResponse$IsTruncated in the response is true. Call ListHostedZones again and specify the value of ListHostedZonesResponse$NextMarker in the ListHostedZonesRequest$Marker element to get the next page of results.

        • nextMarker

          String nextMarker

          Indicates where to continue listing hosted zones. If ListHostedZonesResponse$IsTruncated is true, make another request to ListHostedZones and include the value of the NextMarker element in the Marker element to get the next page of results.

    • Class com.amazonaws.services.route53.model.ListResourceRecordSetsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • hostedZoneId

          String hostedZoneId

          The ID of the hosted zone that contains the resource record sets that you want to get.

        • maxItems

          String maxItems

          The maximum number of records you want in the response body.

        • startRecordIdentifier

          String startRecordIdentifier

          Weighted resource record sets only: If results were truncated for a given DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

        • startRecordName

          String startRecordName

          The first name in the lexicographic ordering of domain names that you want the ListResourceRecordSets request to list.

        • startRecordType

          String startRecordType

          The DNS type at which to begin the listing of resource record sets.

          Valid values: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT

          Values for Weighted Resource Record Sets: A | AAAA | CNAME | TXT

          Values for Regional Resource Record Sets: A | AAAA | CNAME | TXT

          Values for Alias Resource Record Sets: A | AAAA

          Constraint: Specifying type without specifying name returns an InvalidInput error.

    • Class com.amazonaws.services.route53.model.ListResourceRecordSetsResult extends Object implements Serializable

      • Serialized Fields

        • isTruncated

          Boolean isTruncated

          A flag that indicates whether there are more resource record sets to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the ListResourceRecordSetsResponse$NextRecordName element.

          Valid Values: true | false

        • maxItems

          String maxItems

          The maximum number of records you requested. The maximum value of MaxItems is 100.

        • nextRecordIdentifier

          String nextRecordIdentifier

          Weighted resource record sets only: If results were truncated for a given DNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.

        • nextRecordName

          String nextRecordName

          If the results were truncated, the name of the next record in the list. This element is present only if ListResourceRecordSetsResponse$IsTruncated is true.

        • nextRecordType

          String nextRecordType

          If the results were truncated, the type of the next record in the list. This element is present only if ListResourceRecordSetsResponse$IsTruncated is true.

        • resourceRecordSets

          com.amazonaws.internal.SdkInternalList<ResourceRecordSet> resourceRecordSets

          A complex type that contains information about the resource record sets that are returned by the request.

    • Class com.amazonaws.services.route53.model.ListReusableDelegationSetsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • marker

          String marker

          If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

        • maxItems

          String maxItems

          Specify the maximum number of reusable delegation sets to return per page of results.

    • Class com.amazonaws.services.route53.model.ListReusableDelegationSetsResult extends Object implements Serializable

      • Serialized Fields

        • delegationSets

          com.amazonaws.internal.SdkInternalList<DelegationSet> delegationSets

          A complex type that contains information about the reusable delegation sets associated with the current AWS account.

        • isTruncated

          Boolean isTruncated

          A flag indicating whether there are more reusable delegation sets to be listed. If your results were truncated, you can make a follow-up request for the next page of results by using the Marker element.

          Valid Values: true | false

        • marker

          String marker

          If the request returned more than one page of results, submit another request and specify the value of NextMarker from the last response in the marker parameter to get the next page of results.

        • maxItems

          String maxItems

          The maximum number of reusable delegation sets to be included in the response body. If the number of reusable delegation sets associated with this AWS account exceeds MaxItems, the value of ListReusablDelegationSetsResponse$IsTruncated in the response is true. Call ListReusableDelegationSets again and specify the value of ListReusableDelegationSetsResponse$NextMarker in the ListReusableDelegationSetsRequest$Marker element to get the next page of results.

        • nextMarker

          String nextMarker

          Indicates where to continue listing reusable delegation sets. If ListReusableDelegationSetsResponse$IsTruncated is true, make another request to ListReusableDelegationSets and include the value of the NextMarker element in the Marker element to get the next page of results.

    • Class com.amazonaws.services.route53.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • resourceId

          String resourceId

          The ID of the resource for which you want to retrieve tags.

        • resourceType

          String resourceType

          The type of the resource.

          - The resource type for health checks is healthcheck.

          - The resource type for hosted zones is hostedzone.

    • Class com.amazonaws.services.route53.model.ListTagsForResourceResult extends Object implements Serializable

      • Serialized Fields

        • resourceTagSet

          ResourceTagSet resourceTagSet

          A ResourceTagSet containing tags associated with the specified resource.

    • Class com.amazonaws.services.route53.model.ListTagsForResourcesRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • resourceIds

          com.amazonaws.internal.SdkInternalList<String> resourceIds

          A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.

        • resourceType

          String resourceType

          The type of the resources.

          - The resource type for health checks is healthcheck.

          - The resource type for hosted zones is hostedzone.

    • Class com.amazonaws.services.route53.model.ListTagsForResourcesResult extends Object implements Serializable

      • Serialized Fields

        • resourceTagSets

          com.amazonaws.internal.SdkInternalList<ResourceTagSet> resourceTagSets

          A list of ResourceTagSets containing tags associated with the specified resources.

    • Class com.amazonaws.services.route53.model.ListTrafficPoliciesRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • maxItems

          String maxItems

          The maximum number of traffic policies to be included in the response body for this request. If you have more than MaxItems traffic policies, the value of the IsTruncated element in the response is true, and the value of the TrafficPolicyIdMarker element is the ID of the first traffic policy in the next group of MaxItems traffic policies.

        • trafficPolicyIdMarker

          String trafficPolicyIdMarker

          For your first request to ListTrafficPolicies, do not include the TrafficPolicyIdMarker parameter.

          If you have more traffic policies than the value of MaxItems, ListTrafficPolicies returns only the first MaxItems traffic policies. To get the next group of MaxItems policies, submit another request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value of the TrafficPolicyIdMarker element that was returned in the previous response.

          Policies are listed in the order in which they were created.

    • Class com.amazonaws.services.route53.model.ListTrafficPoliciesResult extends Object implements Serializable

      • Serialized Fields

        • isTruncated

          Boolean isTruncated

          A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of MaxItems traffic policies by calling ListTrafficPolicies again and specifying the value of the TrafficPolicyIdMarker element in the TrafficPolicyIdMarker request parameter.

          Valid Values: true | false

        • maxItems

          String maxItems

          The value that you specified for the MaxItems parameter in the call to ListTrafficPolicies that produced the current response.

        • trafficPolicyIdMarker

          String trafficPolicyIdMarker

          If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies.

        • trafficPolicySummaries

          com.amazonaws.internal.SdkInternalList<TrafficPolicySummary> trafficPolicySummaries

          A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current AWS account.

    • Class com.amazonaws.services.route53.model.ListTrafficPolicyInstancesByHostedZoneRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • hostedZoneId

          String hostedZoneId

          The ID of the hosted zone for which you want to list traffic policy instances.

        • maxItems

          String maxItems

          The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

        • trafficPolicyInstanceNameMarker

          String trafficPolicyInstanceNameMarker

          For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

          If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

          If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

          If the value of IsTruncated in the previous response was false, omit this value.

        • trafficPolicyInstanceTypeMarker

          String trafficPolicyInstanceTypeMarker

          For the first request to ListTrafficPolicyInstancesByHostedZone, omit this value.

          If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

          If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

    • Class com.amazonaws.services.route53.model.ListTrafficPolicyInstancesByHostedZoneResult extends Object implements Serializable

      • Serialized Fields

        • isTruncated

          Boolean isTruncated

          A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of MaxItems traffic policy instances by calling ListTrafficPolicyInstancesByHostedZone again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

          Valid Values: true | false

        • maxItems

          String maxItems

          The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByHostedZone that produced the current response.

        • trafficPolicyInstanceNameMarker

          String trafficPolicyInstanceNameMarker

          If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

        • trafficPolicyInstances

          com.amazonaws.internal.SdkInternalList<TrafficPolicyInstance> trafficPolicyInstances

          A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

        • trafficPolicyInstanceTypeMarker

          String trafficPolicyInstanceTypeMarker

          If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.

    • Class com.amazonaws.services.route53.model.ListTrafficPolicyInstancesByPolicyRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • hostedZoneIdMarker

          String hostedZoneIdMarker

          For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.

          If the value of IsTruncated in the previous response was true, HostedZoneIdMarker is the ID of the hosted zone for the first traffic policy instance in the next group of MaxItems traffic policy instances.

          If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

          If the value of IsTruncated in the previous response was false, omit this value.

        • maxItems

          String maxItems

          The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

        • trafficPolicyId

          String trafficPolicyId

          The ID of the traffic policy for which you want to list traffic policy instances.

        • trafficPolicyInstanceNameMarker

          String trafficPolicyInstanceNameMarker

          For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.

          If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

          If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

          If the value of IsTruncated in the previous response was false, omit this value.

        • trafficPolicyInstanceTypeMarker

          String trafficPolicyInstanceTypeMarker

          For the first request to ListTrafficPolicyInstancesByPolicy, omit this value.

          If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

          If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get for this hosted zone.

        • trafficPolicyVersion

          Integer trafficPolicyVersion

          The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.

    • Class com.amazonaws.services.route53.model.ListTrafficPolicyInstancesByPolicyResult extends Object implements Serializable

      • Serialized Fields

        • hostedZoneIdMarker

          String hostedZoneIdMarker

          If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of MaxItems traffic policy instances.

        • isTruncated

          Boolean isTruncated

          A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of MaxItems traffic policy instances by calling ListTrafficPolicyInstancesByPolicy again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

          Valid Values: true | false

        • maxItems

          String maxItems

          The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByPolicy that produced the current response.

        • trafficPolicyInstanceNameMarker

          String trafficPolicyInstanceNameMarker

          If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

        • trafficPolicyInstances

          com.amazonaws.internal.SdkInternalList<TrafficPolicyInstance> trafficPolicyInstances

          A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

        • trafficPolicyInstanceTypeMarker

          String trafficPolicyInstanceTypeMarker

          If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.

    • Class com.amazonaws.services.route53.model.ListTrafficPolicyInstancesRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • hostedZoneIdMarker

          String hostedZoneIdMarker

          For the first request to ListTrafficPolicyInstances, omit this value.

          If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get the next group of MaxItems traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneIdMarker, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of MaxItems traffic policy instances.

          If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

        • maxItems

          String maxItems

          The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

        • trafficPolicyInstanceNameMarker

          String trafficPolicyInstanceNameMarker

          For the first request to ListTrafficPolicyInstances, omit this value.

          If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

          If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

        • trafficPolicyInstanceTypeMarker

          String trafficPolicyInstanceTypeMarker

          For the first request to ListTrafficPolicyInstances, omit this value.

          If the value of IsTruncated in the previous response was true, TrafficPolicyInstanceTypeMarker is the DNS type of the first traffic policy instance in the next group of MaxItems traffic policy instances.

          If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    • Class com.amazonaws.services.route53.model.ListTrafficPolicyInstancesResult extends Object implements Serializable

      • Serialized Fields

        • hostedZoneIdMarker

          String hostedZoneIdMarker

          If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of MaxItems traffic policy instances.

        • isTruncated

          Boolean isTruncated

          A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of MaxItems traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

          Valid Values: true | false

        • maxItems

          String maxItems

          The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that produced the current response.

        • trafficPolicyInstanceNameMarker

          String trafficPolicyInstanceNameMarker

          If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

        • trafficPolicyInstances

          com.amazonaws.internal.SdkInternalList<TrafficPolicyInstance> trafficPolicyInstances

          A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

        • trafficPolicyInstanceTypeMarker

          String trafficPolicyInstanceTypeMarker

          If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.

    • Class com.amazonaws.services.route53.model.ListTrafficPolicyVersionsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • id

          String id

          Specify the value of Id of the traffic policy for which you want to list all versions.

        • maxItems

          String maxItems

          The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than MaxItems versions, the value of the IsTruncated element in the response is true , and the value of the TrafficPolicyVersionMarker element is the ID of the first version in the next group of MaxItems traffic policy versions.

        • trafficPolicyVersionMarker

          String trafficPolicyVersionMarker

          For your first request to ListTrafficPolicyVersions, do not include the TrafficPolicyVersionMarker parameter.

          If you have more traffic policy versions than the value of MaxItems, ListTrafficPolicyVersions returns only the first group of MaxItems versions. To get the next group of MaxItems traffic policy versions, submit another request to ListTrafficPolicyVersions. For the value of TrafficPolicyVersionMarker, specify the value of the TrafficPolicyVersionMarker element that was returned in the previous response.

          Traffic policy versions are listed in sequential order.

    • Class com.amazonaws.services.route53.model.ListTrafficPolicyVersionsResult extends Object implements Serializable

      • Serialized Fields

        • isTruncated

          Boolean isTruncated

          A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of maxitems traffic policies by calling ListTrafficPolicyVersions again and specifying the value of the NextMarker element in the marker parameter.

          Valid Values: true | false

        • maxItems

          String maxItems

          The value that you specified for the maxitems parameter in the call to ListTrafficPolicyVersions that produced the current response.

        • trafficPolicies

          com.amazonaws.internal.SdkInternalList<TrafficPolicy> trafficPolicies

          A list that contains one TrafficPolicy element for each traffic policy version that is associated with the specified traffic policy.

        • trafficPolicyVersionMarker

          String trafficPolicyVersionMarker

          If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the first traffic policy in the next group of MaxItems traffic policies. Call ListTrafficPolicyVersions again and specify the value of TrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter.

          This element is present only if IsTruncated is true.

    • Class com.amazonaws.services.route53.model.NoSuchChangeException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.NoSuchDelegationSetException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.NoSuchGeoLocationException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.NoSuchHealthCheckException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.NoSuchHostedZoneException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.NoSuchTrafficPolicyException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.NoSuchTrafficPolicyInstanceException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.PriorRequestNotCompleteException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.PublicZoneVPCAssociationException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.ResourceRecord extends Object implements Serializable

      • Serialized Fields

        • value

          String value

          The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action, if the current value does not match the actual value, an error is returned. For descriptions about how to format Value for different record types, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

          You can specify more than one value for all record types except CNAME and SOA.

    • Class com.amazonaws.services.route53.model.ResourceRecordSet extends Object implements Serializable

      • Serialized Fields

        • aliasTarget

          AliasTarget aliasTarget

          Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.

        • failover

          String failover

          Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.

          You can create failover and failover alias resource record sets only in public hosted zones.

          Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:

          • When the primary resource record set is healthy, Amazon Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.
          • When the primary resource record set is unhealthy and the secondary resource record set is healthy, Amazon Route 53 responds to DNS queries with the applicable value from the secondary resource record set.
          • When the secondary resource record set is unhealthy, Amazon Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.
          • If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Amazon Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.

          You cannot create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.

          For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.

          For more information about configuring failover for Amazon Route 53, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

          Valid values: PRIMARY | SECONDARY

        • geoLocation

          GeoLocation geoLocation

          Geo location resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF.

          You can create geolocation and geolocation alias resource record sets only in public hosted zones.

          If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.

          You cannot create two geolocation resource record sets that specify the same geographic location.

          The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.

          Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Amazon Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *, which handles both queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Amazon Route 53 returns a "no answer" response for queries from those locations.

          You cannot create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.

        • healthCheckId

          String healthCheckId

          Health Check resource record sets only, not required for alias resource record sets: An identifier that is used to identify health check associated with the resource record set.

        • name

          String name

          The name of the domain you want to perform the action on.

          Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 still assumes that the domain name that you specify is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

          For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

          You can use an asterisk (*) character in the name. DNS treats the * character either as a wildcard or as the * character (ASCII 42), depending on where it appears in the name. For more information, see Using an Asterisk (*) in the Names of Hosted Zones and Resource Record Sets in the Amazon Route 53 Developer Guide

          You can't use the * wildcard for resource records sets that have a type of NS.
        • region

          String region

          Latency-based resource record sets only: The Amazon EC2 region where the resource that is specified in this resource record set resides. The resource typically is an AWS resource, such as an Amazon EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.

          You can create latency and latency alias resource record sets only in public hosted zones.

          When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Amazon Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 region. Amazon Route 53 then returns the value that is associated with the selected resource record set.

          Note the following:

          • You can only specify one ResourceRecord per latency resource record set.
          • You can only create one latency resource record set for each Amazon EC2 region.
          • You are not required to create latency resource record sets for all Amazon EC2 regions. Amazon Route 53 will choose the region with the best latency from among the regions for which you create latency resource record sets.
          • You cannot create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.
        • resourceRecords

          com.amazonaws.internal.SdkInternalList<ResourceRecord> resourceRecords

          A complex type that contains the resource records for the current resource record set.

        • setIdentifier

          String setIdentifier

          Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type. The value of SetIdentifier must be unique for each resource record set that has the same combination of DNS name and type.

        • trafficPolicyInstanceId

          String trafficPolicyInstanceId
        • tTL

          Long tTL

          The cache time to live for the current resource record set. Note the following:

          • If you're creating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL for the alias target.
          • If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.
          • All of the resource record sets in a group of weighted, latency, geolocation, or failover resource record sets must have the same value for TTL.
          • If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for Weight.
        • type

          String type

          The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

          Valid values for basic resource record sets: A | AAAA | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT

          Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CNAME | MX | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.

          SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated to say, "...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it." In RFC 7208, see section 14.1, The SPF DNS Record Type.

          Values for alias resource record sets:

          • CloudFront distributions: A
          • ELB load balancers: A | AAAA
          • Amazon S3 buckets: A
          • Another resource record set in this hosted zone: Specify the type of the resource record set for which you're creating the alias. Specify any value except NS or SOA.
        • weight

          Long weight

          Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Amazon Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Amazon Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:

          • You must specify a value for the Weight element for every weighted resource record set.
          • You can only specify one ResourceRecord per weighted resource record set.
          • You cannot create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets.
          • You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements.
          • For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Amazon Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.

            The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Amazon Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.

    • Class com.amazonaws.services.route53.model.ResourceTagSet extends Object implements Serializable

      • Serialized Fields

        • resourceId

          String resourceId

          The ID for the specified resource.

        • resourceType

          String resourceType

          The type of the resource.

          - The resource type for health checks is healthcheck.

          - The resource type for hosted zones is hostedzone.

        • tags

          com.amazonaws.internal.SdkInternalList<Tag> tags

          The tags associated with the specified resource.

    • Class com.amazonaws.services.route53.model.StatusReport extends Object implements Serializable

      • Serialized Fields

        • checkedTime

          Date checkedTime

          The date and time the health check status was observed, in the format YYYY-MM-DDThh:mm:ssZ, as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC).

        • status

          String status

          The observed health check status.

    • Class com.amazonaws.services.route53.model.Tag extends Object implements Serializable

      • Serialized Fields

        • key

          String key

          The key for a Tag.

        • value

          String value

          The value for a Tag.

    • Class com.amazonaws.services.route53.model.ThrottlingException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.TooManyHealthChecksException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.TooManyHostedZonesException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.TooManyTrafficPoliciesException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.TooManyTrafficPolicyInstancesException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.TrafficPolicy extends Object implements Serializable

    • Class com.amazonaws.services.route53.model.TrafficPolicyAlreadyExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.TrafficPolicyInstance extends Object implements Serializable

      • Serialized Fields

    • Class com.amazonaws.services.route53.model.TrafficPolicyInstanceAlreadyExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.TrafficPolicyInUseException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53.model.TrafficPolicySummary extends Object implements Serializable

    • Class com.amazonaws.services.route53.model.UpdateHealthCheckRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • alarmIdentifier

          AlarmIdentifier alarmIdentifier
        • childHealthChecks

          com.amazonaws.internal.SdkInternalList<String> childHealthChecks

          For a specified parent health check, a list of HealthCheckId values for the associated child health checks.

          Specify this value only if you want to change it.

        • enableSNI

          Boolean enableSNI

          Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. If you don't specify a value for EnableSNI, Amazon Route 53 defaults to true when Type is HTTPS or HTTPS_STR_MATCH and defaults to false when Type is any other value.

          Specify this value only if you want to change it.

        • failureThreshold

          Integer failureThreshold

          The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.

          Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.

          Specify this value only if you want to change it.

        • fullyQualifiedDomainName

          String fullyQualifiedDomainName

          Fully qualified domain name of the instance to be health checked.

          Specify this value only if you want to change it.

        • healthCheckId

          String healthCheckId

          The ID of the health check to update.

        • healthCheckVersion

          Long healthCheckVersion

          Optional. When you specify a health check version, Amazon Route 53 compares this value with the current value in the health check, which prevents you from updating the health check when the versions don't match. Using HealthCheckVersion lets you prevent overwriting another change to the health check.

        • healthThreshold

          Integer healthThreshold

          The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.

          Specify this value only if you want to change it.

        • insufficientDataHealthStatus

          String insufficientDataHealthStatus
        • inverted

          Boolean inverted

          A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True, then Amazon Route 53 considers the health check to be unhealthy.

          Specify this value only if you want to change it.

        • iPAddress

          String iPAddress

          The IP address of the resource that you want to check.

          Specify this value only if you want to change it.

        • port

          Integer port

          The port on which you want Amazon Route 53 to open a connection to perform health checks.

          Specify this value only if you want to change it.

        • regions

          com.amazonaws.internal.SdkInternalList<String> regions

          A list of HealthCheckRegion values that specify the Amazon EC2 regions that you want Amazon Route 53 to use to perform health checks. You must specify at least three regions.

          When you remove a region from the list, Amazon Route 53 will briefly continue to check your endpoint from that region.

          Specify this value only if you want to change it.

        • resourcePath

          String resourcePath

          The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.

          Specify this value only if you want to change it.

        • searchString

          String searchString

          If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Amazon Route 53 considers the resource healthy. Amazon Route 53 considers case when searching for SearchString in the response body.

          Specify this value only if you want to change it.

    • Class com.amazonaws.services.route53.model.UpdateHealthCheckResult extends Object implements Serializable

      • Serialized Fields

    • Class com.amazonaws.services.route53.model.UpdateHostedZoneCommentRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • comment

          String comment

          A comment about your hosted zone.

        • id

          String id

          The ID of the hosted zone you want to update.

    • Class com.amazonaws.services.route53.model.UpdateHostedZoneCommentResult extends Object implements Serializable

      • Serialized Fields

    • Class com.amazonaws.services.route53.model.UpdateTrafficPolicyCommentRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • comment

          String comment

          The new comment for the specified traffic policy and version.

        • id

          String id

          The value of Id for the traffic policy for which you want to update the comment.

        • version

          Integer version

          The value of Version for the traffic policy for which you want to update the comment.

    • Class com.amazonaws.services.route53.model.UpdateTrafficPolicyCommentResult extends Object implements Serializable

      • Serialized Fields

        • trafficPolicy

          TrafficPolicy trafficPolicy

          A complex type that contains settings for the specified traffic policy.

    • Class com.amazonaws.services.route53.model.UpdateTrafficPolicyInstanceRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • id

          String id

          The ID of the traffic policy instance that you want to update.

        • trafficPolicyId

          String trafficPolicyId

          The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.

        • trafficPolicyVersion

          Integer trafficPolicyVersion

          The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.

        • tTL

          Long tTL

          The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets.

    • Class com.amazonaws.services.route53.model.UpdateTrafficPolicyInstanceResult extends Object implements Serializable

      • Serialized Fields

        • trafficPolicyInstance

          TrafficPolicyInstance trafficPolicyInstance

          A complex type that contains settings for the updated traffic policy instance.

    • Class com.amazonaws.services.route53.model.VPC extends Object implements Serializable

      • Serialized Fields

    • Class com.amazonaws.services.route53.model.VPCAssociationNotFoundException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
  • Package com.amazonaws.services.route53domains.model

    • Class com.amazonaws.services.route53domains.model.CheckDomainAvailabilityRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domainName

          String domainName

          The name of a domain.

          Type: String

          Default: None

          Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

          Required: Yes

        • idnLangCode

          String idnLangCode

          Reserved for future use.

    • Class com.amazonaws.services.route53domains.model.CheckDomainAvailabilityResult extends Object implements Serializable

      • Serialized Fields

        • availability

          String availability

          Whether the domain name is available for registering.

          You can only register domains designated as AVAILABLE.

          Type: String

          Valid values:

          • AVAILABLE – The domain name is available.
          • AVAILABLE_RESERVED – The domain name is reserved under specific conditions.
          • AVAILABLE_PREORDER – The domain name is available and can be preordered.
          • UNAVAILABLE – The domain name is not available.
          • UNAVAILABLE_PREMIUM – The domain name is not available.
          • UNAVAILABLE_RESTRICTED – The domain name is forbidden.
          • RESERVED – The domain name has been reserved for another person or organization.
          • DONT_KNOW – The TLD registry didn't reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.
    • Class com.amazonaws.services.route53domains.model.ContactDetail extends Object implements Serializable

      • Serialized Fields

        • addressLine1

          String addressLine1

          First line of the contact's address.

          Type: String

          Default: None

          Constraints: Maximum 255 characters.

          Parents: RegistrantContact, AdminContact, TechContact

          Required: Yes

        • addressLine2

          String addressLine2

          Second line of contact's address, if any.

          Type: String

          Default: None

          Constraints: Maximum 255 characters.

          Parents: RegistrantContact, AdminContact, TechContact

          Required: No

        • city

          String city

          The city of the contact's address.

          Type: String

          Default: None

          Constraints: Maximum 255 characters.

          Parents: RegistrantContact, AdminContact, TechContact

          Required: Yes

        • contactType

          String contactType

          Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

          Type: String

          Default: None

          Constraints: Maximum 255 characters.

          Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY

          Parents: RegistrantContact, AdminContact, TechContact

          Required: Yes

        • countryCode

          String countryCode

          Code for the country of the contact's address.

          Type: String

          Default: None

          Constraints: Maximum 255 characters.

          Parents: RegistrantContact, AdminContact, TechContact

          Required: Yes

        • email

          String email

          Email address of the contact.

          Type: String

          Default: None

          Constraints: Maximum 254 characters.

          Parents: RegistrantContact, AdminContact, TechContact

          Required: Yes

        • extraParams

          com.amazonaws.internal.SdkInternalList<ExtraParam> extraParams

          A list of name-value pairs for parameters required by certain top-level domains.

          Type: Complex

          Default: None

          Parents: RegistrantContact, AdminContact, TechContact

          Children: Name, Value

          Required: No

        • fax

          String fax

          Fax number of the contact.

          Type: String

          Default: None

          Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890".

          Parents: RegistrantContact, AdminContact, TechContact

          Required: No

        • firstName

          String firstName

          First name of contact.

          Type: String

          Default: None

          Constraints: Maximum 255 characters.

          Parents: RegistrantContact, AdminContact, TechContact

          Required: Yes

        • lastName

          String lastName

          Last name of contact.

          Type: String

          Default: None

          Constraints: Maximum 255 characters.

          Parents: RegistrantContact, AdminContact, TechContact

          Required: Yes

        • organizationName

          String organizationName

          Name of the organization for contact types other than PERSON .

          Type: String

          Default: None

          Constraints: Maximum 255 characters. Contact type must not be PERSON.

          Parents: RegistrantContact, AdminContact, TechContact

          Required: No

        • phoneNumber

          String phoneNumber

          The phone number of the contact.

          Type: String

          Default: None

          Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as "+1.1234567890".

          Parents: RegistrantContact, AdminContact, TechContact

          Required: Yes

        • state

          String state

          The state or province of the contact's city.

          Type: String

          Default: None

          Constraints: Maximum 255 characters.

          Parents: RegistrantContact, AdminContact, TechContact

          Required: No

        • zipCode

          String zipCode

          The zip or postal code of the contact's address.

          Type: String

          Default: None

          Constraints: Maximum 255 characters.

          Parents: RegistrantContact, AdminContact, TechContact

          Required: No

    • Class com.amazonaws.services.route53domains.model.DeleteTagsForDomainRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domainName

          String domainName

          The domain for which you want to delete one or more tags.

          The name of a domain.

          Type: String

          Default: None

          Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when they're surrounded by letters, numbers, or other hyphens. You can't specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.

          Required: Yes

        • tagsToDelete

          com.amazonaws.internal.SdkInternalList<String> tagsToDelete

          A list of tag keys to delete.

          Type: A list that contains the keys of the tags that you want to delete.

          Default: None

          Required: No

          '>
    • Class com.amazonaws.services.route53domains.model.DeleteTagsForDomainResult extends Object implements Serializable

    • Class com.amazonaws.services.route53domains.model.DisableDomainAutoRenewRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domainName

          String domainName
    • Class com.amazonaws.services.route53domains.model.DisableDomainAutoRenewResult extends Object implements Serializable

    • Class com.amazonaws.services.route53domains.model.DisableDomainTransferLockRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domainName

          String domainName

          The name of a domain.

          Type: String

          Default: None

          Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

          Required: Yes

    • Class com.amazonaws.services.route53domains.model.DisableDomainTransferLockResult extends Object implements Serializable

      • Serialized Fields

        • operationId

          String operationId

          Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

          Type: String

          Default: None

          Constraints: Maximum 255 characters.

    • Class com.amazonaws.services.route53domains.model.DomainLimitExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53domains.model.DomainSummary extends Object implements Serializable

      • Serialized Fields

        • autoRenew

          Boolean autoRenew

          Indicates whether the domain is automatically renewed upon expiration.

          Type: Boolean

          Valid values: True | False

        • domainName

          String domainName

          The name of a domain.

          Type: String

        • expiry

          Date expiry

          Expiration date of the domain in Coordinated Universal Time (UTC).

          Type: Long

        • transferLock

          Boolean transferLock

          Indicates whether a domain is locked from unauthorized transfer to another party.

          Type: Boolean

          Valid values: True | False

    • Class com.amazonaws.services.route53domains.model.DuplicateRequestException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53domains.model.EnableDomainAutoRenewRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domainName

          String domainName
    • Class com.amazonaws.services.route53domains.model.EnableDomainAutoRenewResult extends Object implements Serializable

    • Class com.amazonaws.services.route53domains.model.EnableDomainTransferLockRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domainName

          String domainName

          The name of a domain.

          Type: String

          Default: None

          Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

          Required: Yes

    • Class com.amazonaws.services.route53domains.model.EnableDomainTransferLockResult extends Object implements Serializable

      • Serialized Fields

        • operationId

          String operationId

          Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

          Type: String

          Default: None

          Constraints: Maximum 255 characters.

    • Class com.amazonaws.services.route53domains.model.ExtraParam extends Object implements Serializable

      • Serialized Fields

        • name

          String name

          Name of the additional parameter required by the top-level domain.

          Type: String

          Default: None

          Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | CA_BUSINESS_ENTITY_TYPE |ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER

          Parent: ExtraParams

          Required: Yes

        • value

          String value

          Values corresponding to the additional parameter names required by some top-level domains.

          Type: String

          Default: None

          Constraints: Maximum 2048 characters.

          Parent: ExtraParams

          Required: Yes

    • Class com.amazonaws.services.route53domains.model.GetContactReachabilityStatusRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domainName

          String domainName

          The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid.

          Type: String

          Default: None

          Required: Yes

    • Class com.amazonaws.services.route53domains.model.GetContactReachabilityStatusResult extends Object implements Serializable

      • Serialized Fields

        • domainName

          String domainName

          The domain name for which you requested the reachability status.

        • status

          String status

          Whether the registrant contact has responded. PENDING indicates that we sent the confirmation email and haven't received a response yet, DONE indicates that we sent the email and got confirmation from the registrant contact, and EXPIRED indicates that the time limit expired before the registrant contact responded.

          Type: String

          Valid values: PENDING, DONE, EXPIRED

    • Class com.amazonaws.services.route53domains.model.GetDomainDetailRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domainName

          String domainName

          The name of a domain.

          Type: String

          Default: None

          Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

          Required: Yes

    • Class com.amazonaws.services.route53domains.model.GetDomainDetailResult extends Object implements Serializable

      • Serialized Fields

        • abuseContactEmail

          String abuseContactEmail

          Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.

          Type: String

        • abuseContactPhone

          String abuseContactPhone

          Phone number for reporting abuse.

          Type: String

        • adminContact

          ContactDetail adminContact

          Provides details about the domain administrative contact.

          Type: Complex

          Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

        • adminPrivacy

          Boolean adminPrivacy

          Specifies whether contact information for the admin contact is concealed from WHOIS queries. If the value is true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

          Type: Boolean

        • autoRenew

          Boolean autoRenew

          Specifies whether the domain registration is set to renew automatically.

          Type: Boolean

        • creationDate

          Date creationDate

          The date when the domain was created as found in the response to a WHOIS query. The date format is Unix time.

        • dnsSec

          String dnsSec

          Reserved for future use.

        • domainName

          String domainName

          The name of a domain.

          Type: String

        • expirationDate

          Date expirationDate

          The date when the registration for the domain is set to expire. The date format is Unix time.

        • nameservers

          com.amazonaws.internal.SdkInternalList<Nameserver> nameservers

          The name of the domain.

          Type: String

        • registrantContact

          ContactDetail registrantContact

          Provides details about the domain registrant.

          Type: Complex

          Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

        • registrantPrivacy

          Boolean registrantPrivacy

          Specifies whether contact information for the registrant contact is concealed from WHOIS queries. If the value is true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

          Type: Boolean

        • registrarName

          String registrarName

          Name of the registrar of the domain as identified in the registry. Amazon Route 53 domains are registered by registrar Gandi. The value is "GANDI SAS".

          Type: String

        • registrarUrl

          String registrarUrl

          Web address of the registrar.

          Type: String

        • registryDomainId

          String registryDomainId

          Reserved for future use.

        • reseller

          String reseller

          Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have "Amazon" as the reseller.

          Type: String

        • statusList

          com.amazonaws.internal.SdkInternalList<String> statusList

          An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.

          ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.

          For a current list of domain name status codes and an explanation of what each code means, go to the ICANN website and search for epp status codes. (Search on the ICANN website; web searches sometimes return an old version of the document.)

          Type: Array of String

        • techContact

          ContactDetail techContact

          Provides details about the domain technical contact.

          Type: Complex

          Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

        • techPrivacy

          Boolean techPrivacy

          Specifies whether contact information for the tech contact is concealed from WHOIS queries. If the value is true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

          Type: Boolean

        • updatedDate

          Date updatedDate

          The last updated date of the domain as found in the response to a WHOIS query. The date format is Unix time.

        • whoIsServer

          String whoIsServer

          The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.

          Type: String

    • Class com.amazonaws.services.route53domains.model.GetOperationDetailRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • operationId

          String operationId

          The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request.

          Type: String

          Default: None

          Required: Yes

    • Class com.amazonaws.services.route53domains.model.GetOperationDetailResult extends Object implements Serializable

      • Serialized Fields

        • domainName

          String domainName

          The name of a domain.

          Type: String

        • message

          String message

          Detailed information on the status including possible errors.

          Type: String

        • operationId

          String operationId

          The identifier for the operation.

          Type: String

        • status

          String status

          The current status of the requested operation in the system.

          Type: String

        • submittedDate

          Date submittedDate

          The date when the request was submitted.

        • type

          String type

          The type of operation that was requested.

          Type: String

    • Class com.amazonaws.services.route53domains.model.InvalidInputException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53domains.model.ListDomainsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • marker

          String marker

          For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

          Type: String

          Default: None

          Constraints: The marker must match the value specified in the previous request.

          Required: No

        • maxItems

          Integer maxItems

          Number of domains to be returned.

          Type: Integer

          Default: 20

          Constraints: A numeral between 1 and 100.

          Required: No

    • Class com.amazonaws.services.route53domains.model.ListDomainsResult extends Object implements Serializable

      • Serialized Fields

        • domains

          com.amazonaws.internal.SdkInternalList<DomainSummary> domains

          A summary of domains.

          Type: Complex type containing a list of domain summaries.

          Children: AutoRenew, DomainName, Expiry, TransferLock

        • nextPageMarker

          String nextPageMarker

          If there are more domains than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

          Type: String

          Parent: Operations

    • Class com.amazonaws.services.route53domains.model.ListOperationsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • marker

          String marker

          For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for MaxItems, you can use Marker to return additional operations. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

          Type: String

          Default: None

          Required: No

        • maxItems

          Integer maxItems

          Number of domains to be returned.

          Type: Integer

          Default: 20

          Constraints: A value between 1 and 100.

          Required: No

    • Class com.amazonaws.services.route53domains.model.ListOperationsResult extends Object implements Serializable

      • Serialized Fields

        • nextPageMarker

          String nextPageMarker

          If there are more operations than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

          Type: String

          Parent: Operations

        • operations

          com.amazonaws.internal.SdkInternalList<OperationSummary> operations

          Lists summaries of the operations.

          Type: Complex type containing a list of operation summaries

          Children: OperationId, Status, SubmittedDate, Type

    • Class com.amazonaws.services.route53domains.model.ListTagsForDomainRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domainName

          String domainName

          The domain for which you want to get a list of tags.

    • Class com.amazonaws.services.route53domains.model.ListTagsForDomainResult extends Object implements Serializable

      • Serialized Fields

        • tagList

          com.amazonaws.internal.SdkInternalList<Tag> tagList

          A list of the tags that are associated with the specified domain.

          Type: A complex type containing a list of tags

          Each tag includes the following elements.

          • Key

            The key (name) of a tag.

            Type: String

          • Value

            The value of a tag.

            Type: String

    • Class com.amazonaws.services.route53domains.model.Nameserver extends Object implements Serializable

      • Serialized Fields

        • glueIps

          com.amazonaws.internal.SdkInternalList<String> glueIps

          Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.

          Type: List of IP addresses.

          Constraints: The list can contain only one IPv4 and one IPv6 address.

          Parent: Nameservers

        • name

          String name

          The fully qualified host name of the name server.

          Type: String

          Constraint: Maximum 255 characterss

          Parent: Nameservers

    • Class com.amazonaws.services.route53domains.model.OperationLimitExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53domains.model.OperationSummary extends Object implements Serializable

      • Serialized Fields

        • operationId

          String operationId

          Identifier returned to track the requested action.

          Type: String

        • status

          String status

          The current status of the requested operation in the system.

          Type: String

        • submittedDate

          Date submittedDate

          The date when the request was submitted.

        • type

          String type

          Type of the action requested.

          Type: String

          Valid values: REGISTER_DOMAIN | DELETE_DOMAIN | TRANSFER_IN_DOMAIN | UPDATE_DOMAIN_CONTACT | UPDATE_NAMESERVER | CHANGE_PRIVACY_PROTECTION | DOMAIN_LOCK

    • Class com.amazonaws.services.route53domains.model.RegisterDomainRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • adminContact

          ContactDetail adminContact

          Provides detailed contact information.

          Type: Complex

          Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

          Required: Yes

        • autoRenew

          Boolean autoRenew

          Indicates whether the domain will be automatically renewed ( true) or not (false). Autorenewal only takes effect after the account is charged.

          Type: Boolean

          Valid values: true | false

          Default: true

          Required: No

        • domainName

          String domainName

          The name of a domain.

          Type: String

          Default: None

          Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

          Required: Yes

        • durationInYears

          Integer durationInYears

          The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.

          Type: Integer

          Default: 1

          Valid values: Integer from 1 to 10

          Required: Yes

        • idnLangCode

          String idnLangCode

          Reserved for future use.

        • privacyProtectAdminContact

          Boolean privacyProtectAdminContact

          Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

          Type: Boolean

          Default: true

          Valid values: true | false

          Required: No

        • privacyProtectRegistrantContact

          Boolean privacyProtectRegistrantContact

          Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

          Type: Boolean

          Default: true

          Valid values: true | false

          Required: No

        • privacyProtectTechContact

          Boolean privacyProtectTechContact

          Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

          Type: Boolean

          Default: true

          Valid values: true | false

          Required: No

        • registrantContact

          ContactDetail registrantContact

          Provides detailed contact information.

          Type: Complex

          Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

          Required: Yes

        • techContact

          ContactDetail techContact

          Provides detailed contact information.

          Type: Complex

          Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

          Required: Yes

    • Class com.amazonaws.services.route53domains.model.RegisterDomainResult extends Object implements Serializable

      • Serialized Fields

        • operationId

          String operationId

          Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

          Type: String

          Default: None

          Constraints: Maximum 255 characters.

    • Class com.amazonaws.services.route53domains.model.ResendContactReachabilityEmailRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domainName

          String domainName

          The name of the domain for which you want Amazon Route 53 to resend a confirmation email to the registrant contact.

          Type: String

          Default: None

          Required: Yes

    • Class com.amazonaws.services.route53domains.model.ResendContactReachabilityEmailResult extends Object implements Serializable

      • Serialized Fields

        • domainName

          String domainName

          The domain name for which you requested a confirmation email.

        • emailAddress

          String emailAddress

          The email address for the registrant contact at the time that we sent the verification email.

        • isAlreadyVerified

          Boolean isAlreadyVerified

          True if the email address for the registrant contact has already been verified, and false otherwise. If the email address has already been verified, we don't send another confirmation email.

    • Class com.amazonaws.services.route53domains.model.RetrieveDomainAuthCodeRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domainName

          String domainName

          The name of a domain.

          Type: String

          Default: None

          Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

          Required: Yes

    • Class com.amazonaws.services.route53domains.model.RetrieveDomainAuthCodeResult extends Object implements Serializable

      • Serialized Fields

        • authCode

          String authCode

          The authorization code for the domain.

          Type: String

    • Class com.amazonaws.services.route53domains.model.Tag extends Object implements Serializable

      • Serialized Fields

        • key

          String key

          The key (name) of a tag.

          Type: String

          Default: None

          Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@"

          Constraints: Each key can be 1-128 characters long.

          Required: Yes

        • value

          String value

          The value of a tag.

          Type: String

          Default: None

          Valid values: A-Z, a-z, 0-9, space, ".:/=+\-@"

          Constraints: Each value can be 0-256 characters long.

          Required: Yes

    • Class com.amazonaws.services.route53domains.model.TLDRulesViolationException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53domains.model.TransferDomainRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • adminContact

          ContactDetail adminContact

          Provides detailed contact information.

          Type: Complex

          Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

          Required: Yes

        • authCode

          String authCode

          The authorization code for the domain. You get this value from the current registrar.

          Type: String

          Required: Yes

        • autoRenew

          Boolean autoRenew

          Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.

          Type: Boolean

          Valid values: true | false

          Default: true

          Required: No

        • domainName

          String domainName

          The name of a domain.

          Type: String

          Default: None

          Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

          Required: Yes

        • durationInYears

          Integer durationInYears

          The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.

          Type: Integer

          Default: 1

          Valid values: Integer from 1 to 10

          Required: Yes

        • idnLangCode

          String idnLangCode

          Reserved for future use.

        • nameservers

          com.amazonaws.internal.SdkInternalList<Nameserver> nameservers

          Contains details for the host and glue IP addresses.

          Type: Complex

          Children: GlueIps, Name

          Required: No

        • privacyProtectAdminContact

          Boolean privacyProtectAdminContact

          Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

          Type: Boolean

          Default: true

          Valid values: true | false

          Required: No

        • privacyProtectRegistrantContact

          Boolean privacyProtectRegistrantContact

          Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

          Type: Boolean

          Default: true

          Valid values: true | false

          Required: No

        • privacyProtectTechContact

          Boolean privacyProtectTechContact

          Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

          Type: Boolean

          Default: true

          Valid values: true | false

          Required: No

        • registrantContact

          ContactDetail registrantContact

          Provides detailed contact information.

          Type: Complex

          Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

          Required: Yes

        • techContact

          ContactDetail techContact

          Provides detailed contact information.

          Type: Complex

          Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

          Required: Yes

    • Class com.amazonaws.services.route53domains.model.TransferDomainResult extends Object implements Serializable

      • Serialized Fields

        • operationId

          String operationId

          Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

          Type: String

          Default: None

          Constraints: Maximum 255 characters.

    • Class com.amazonaws.services.route53domains.model.UnsupportedTLDException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.route53domains.model.UpdateDomainContactPrivacyRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • adminPrivacy

          Boolean adminPrivacy

          Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

          Type: Boolean

          Default: None

          Valid values: true | false

          Required: No

        • domainName

          String domainName

          The name of a domain.

          Type: String

          Default: None

          Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

          Required: Yes

        • registrantPrivacy

          Boolean registrantPrivacy

          Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

          Type: Boolean

          Default: None

          Valid values: true | false

          Required: No

        • techPrivacy

          Boolean techPrivacy

          Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

          Type: Boolean

          Default: None

          Valid values: true | false

          Required: No

    • Class com.amazonaws.services.route53domains.model.UpdateDomainContactPrivacyResult extends Object implements Serializable

      • Serialized Fields

        • operationId

          String operationId

          Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

          Type: String

          Default: None

          Constraints: Maximum 255 characters.

    • Class com.amazonaws.services.route53domains.model.UpdateDomainContactRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • adminContact

          ContactDetail adminContact

          Provides detailed contact information.

          Type: Complex

          Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

          Required: Yes

        • domainName

          String domainName

          The name of a domain.

          Type: String

          Default: None

          Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

          Required: Yes

        • registrantContact

          ContactDetail registrantContact

          Provides detailed contact information.

          Type: Complex

          Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

          Required: Yes

        • techContact

          ContactDetail techContact

          Provides detailed contact information.

          Type: Complex

          Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

          Required: Yes

    • Class com.amazonaws.services.route53domains.model.UpdateDomainContactResult extends Object implements Serializable

      • Serialized Fields

        • operationId

          String operationId

          Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

          Type: String

          Default: None

          Constraints: Maximum 255 characters.

    • Class com.amazonaws.services.route53domains.model.UpdateDomainNameserversRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domainName

          String domainName

          The name of a domain.

          Type: String

          Default: None

          Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

          Required: Yes

        • fIAuthKey

          String fIAuthKey

          The authorization key for .fi domains

        • nameservers

          com.amazonaws.internal.SdkInternalList<Nameserver> nameservers

          A list of new name servers for the domain.

          Type: Complex

          Children: Name, GlueIps

          Required: Yes

    • Class com.amazonaws.services.route53domains.model.UpdateDomainNameserversResult extends Object implements Serializable

      • Serialized Fields

        • operationId

          String operationId

          Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

          Type: String

          Default: None

          Constraints: Maximum 255 characters.

    • Class com.amazonaws.services.route53domains.model.UpdateTagsForDomainRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domainName

          String domainName

          The domain for which you want to add or update tags.

          The name of a domain.

          Type: String

          Default: None

          Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when they're surrounded by letters, numbers, or other hyphens. You can't specify a hyphen at the beginning or end of a label. To specify an Internationalized Domain Name, you must convert the name to Punycode.

          Required: Yes

        • tagsToUpdate

          com.amazonaws.internal.SdkInternalList<Tag> tagsToUpdate

          A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced.

          Type: A complex type containing a list of tags

          Default: None

          Required: No

          '>

          Each tag includes the following elements:

          • Key

            The key (name) of a tag.

            Type: String

            Default: None

            Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@"

            Constraints: Each key can be 1-128 characters long.

            Required: Yes

          • Value

            The value of a tag.

            Type: String

            Default: None

            Valid values: Unicode characters including alphanumeric, space, and ".:/=+\-@"

            Constraints: Each value can be 0-256 characters long.

            Required: Yes

    • Class com.amazonaws.services.route53domains.model.UpdateTagsForDomainResult extends Object implements Serializable

  • Package com.amazonaws.services.s3

  • Package com.amazonaws.services.s3.model

    • Class com.amazonaws.services.s3.model.AbortIncompleteMultipartUpload extends Object implements Serializable

      • Serialized Fields

        • daysAfterInitiation

          int daysAfterInitiation
          Indicates the number of days that must pass since initiation for Lifecycle to abort an Incomplete Multipart Upload.
    • Class com.amazonaws.services.s3.model.AbortMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket containing the multipart upload to abort
        • isRequesterPays

          boolean isRequesterPays
          If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.
        • key

          String key
          The key of the multipart upload to abort
        • uploadId

          String uploadId
          The ID of the multipart upload to abort
    • Class com.amazonaws.services.s3.model.AbstractPutObjectRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • accessControlList

          AccessControlList accessControlList
          An optional access control list to apply to the new object. If specified, cannedAcl will be ignored.
        • bucketName

          String bucketName
          The name of an existing bucket, to which this request will upload a new object. You must have Permission.Write permission granted to you in order to upload new objects to a bucket.
        • cannedAcl

          CannedAccessControlList cannedAcl
          An optional pre-configured access control policy to use for the new object. Ignored in favor of accessControlList, if present.
        • file

          File file
          The file containing the data to be uploaded to Amazon S3. You must either specify a file or an InputStream containing the data to be uploaded to Amazon S3.
        • key

          String key
          The key under which to store the new object.
        • metadata

          ObjectMetadata metadata
          Optional metadata instructing Amazon S3 how to handle the uploaded data (e.g. custom user metadata, hooks for specifying content type, etc.). If you are uploading from an InputStream, you should always specify metadata with the content size set, otherwise the contents of the InputStream will have to be buffered in memory before they can be sent to Amazon S3, which can have very negative performance impacts.
        • redirectLocation

          String redirectLocation
          The optional redirect location about an object
        • sseAwsKeyManagementParams

          SSEAwsKeyManagementParams sseAwsKeyManagementParams
          The optional AWS Key Management system parameters to be used to encrypt the the object on the server side.
        • sseCustomerKey

          SSECustomerKey sseCustomerKey
          The optional customer-provided server-side encryption key to use to encrypt the uploaded object.
        • storageClass

          String storageClass
          The optional Amazon S3 storage class to use when storing the new object. If not specified, the default, standard storage class will be used.

          For more information on Amazon S3 storage classes and available values, see the StorageClass enumeration.

    • Class com.amazonaws.services.s3.model.AccessControlList extends Object implements Serializable

      serialVersionUID:
      8095040648034788376L
      • Serialized Fields

        • grantList

          List<Grant> grantList
        • grantSet

          Set<Grant> grantSet
        • isRequesterCharged

          boolean isRequesterCharged
          Indicate if the requester is charged for conducting this operation from Requester Pays Buckets.
        • owner

          Owner owner
    • Class com.amazonaws.services.s3.model.AmazonS3Exception extends AmazonServiceException implements Serializable

      serialVersionUID:
      7573680383273658477L
      • Serialized Fields

        • additionalDetails

          Map<String,​String> additionalDetails
          Additional information on the exception.
        • cloudFrontId

          String cloudFrontId
          An S3 specific CloudFront ID in responses from the accelerate endpoint.
        • errorResponseXml

          String errorResponseXml
          Returns the error XML received in the HTTP Response or null if the exception is constructed from the headers.
        • extendedRequestId

          String extendedRequestId
          An S3 specific request ID that provides additional debugging information.
    • Class com.amazonaws.services.s3.model.Bucket extends Object implements Serializable

      serialVersionUID:
      -8646831898339939580L
      • Serialized Fields

        • creationDate

          Date creationDate
          The date this bucket was created
        • name

          String name
          The name of this S3 bucket
        • owner

          Owner owner
          The details on the owner of this bucket
    • Class com.amazonaws.services.s3.model.BucketCrossOriginConfiguration extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.BucketLifecycleConfiguration extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.BucketLifecycleConfiguration.NoncurrentVersionTransition extends Object implements Serializable

      • Serialized Fields

        • days

          int days
          The time, in days, between when a new version of the object is uploaded to the bucket and when older version are archived.
        • storageClass

          String storageClass
    • Class com.amazonaws.services.s3.model.BucketLifecycleConfiguration.Rule extends Object implements Serializable

      • Serialized Fields

        • abortIncompleteMultipartUpload

          AbortIncompleteMultipartUpload abortIncompleteMultipartUpload
          Specifies the days since the initiation of an Incomplete Multipart Upload that Lifecycle will wait before permanently removing all parts of the upload.
        • expirationDate

          Date expirationDate
          The expiration date of the object and should not coexist with expirationInDays within one lifecycle rule.
        • expirationInDays

          int expirationInDays
          The time, in days, between when the object is uploaded to the bucket and when it expires. Should not coexist with expirationDate within one lifecycle rule.
        • expiredObjectDeleteMarker

          boolean expiredObjectDeleteMarker
        • id

          String id
        • noncurrentVersionExpirationInDays

          int noncurrentVersionExpirationInDays
          The time, in days, between when a new version of the object is uploaded to the bucket and when older versions of the object expire.
        • noncurrentVersionTransitions

          List<BucketLifecycleConfiguration.NoncurrentVersionTransition> noncurrentVersionTransitions
          Transition rules for the non current objects in the bucket.
        • prefix

          String prefix
        • status

          String status
        • transitions

          List<BucketLifecycleConfiguration.Transition> transitions
          Transition rules for the objects in the bucket.
    • Class com.amazonaws.services.s3.model.BucketLifecycleConfiguration.Transition extends Object implements Serializable

      • Serialized Fields

        • date

          Date date
          The expiration date of the object and should not coexist with expirationInDays within one lifecycle rule.
        • days

          int days
          The time, in days, between when the object is uploaded to the bucket and when it expires. Should not coexist with expirationDate within one lifecycle rule.
        • storageClass

          String storageClass
    • Class com.amazonaws.services.s3.model.BucketLoggingConfiguration extends Object implements Serializable

      • Serialized Fields

        • destinationBucketName

          String destinationBucketName
        • logFilePrefix

          String logFilePrefix
    • Class com.amazonaws.services.s3.model.BucketNotificationConfiguration extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.BucketNotificationConfiguration.TopicConfiguration extends TopicConfiguration implements Serializable

    • Class com.amazonaws.services.s3.model.BucketPolicy extends Object implements Serializable

      • Serialized Fields

        • policyText

          String policyText
          The raw, policy JSON text, as returned by Amazon S3
    • Class com.amazonaws.services.s3.model.BucketReplicationConfiguration extends Object implements Serializable

      • Serialized Fields

        • roleARN

          String roleARN
          The ARN of the IAM role that Amazon S3 assumes while replication.
        • rules

          Map<String,​ReplicationRule> rules
          Collection of replication rules associated with the Amazon S3 bucket.
    • Class com.amazonaws.services.s3.model.BucketTaggingConfiguration extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.BucketVersioningConfiguration extends Object implements Serializable

      • Serialized Fields

        • isMfaDeleteEnabled

          Boolean isMfaDeleteEnabled
          Indicates if the optional Multi-Factor Authentication Delete control is enabled for this bucket versioning configuration.
        • status

          String status
          The current status of versioning
    • Class com.amazonaws.services.s3.model.BucketWebsiteConfiguration extends Object implements Serializable

      • Serialized Fields

        • errorDocument

          String errorDocument
          The complete path to the document to serve for 4xx errors.
        • indexDocumentSuffix

          String indexDocumentSuffix
          The document to serve when a directory is specified (ex: index.html). This path is relative to the requested resource.
        • redirectAllRequestsTo

          RedirectRule redirectAllRequestsTo
          Container for redirect information where all requests will be redirect to. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return. .
        • routingRules

          List<RoutingRule> routingRules
          The list of routing rules that can be used for configuring redirects if certain conditions are meet.
    • Class com.amazonaws.services.s3.model.CanonicalGrantee extends Object implements Serializable

      • Serialized Fields

    • Class com.amazonaws.services.s3.model.CloudFunctionConfiguration extends NotificationConfiguration implements Serializable

      • Serialized Fields

        • cloudFunctionARN

          String cloudFunctionARN
          Deprecated.
          The ARN for the lambda function to be invoked.
        • invocationRoleARN

          String invocationRoleARN
          Deprecated.
          The ARN for the IAM role to be used by Amazon S3.
    • Class com.amazonaws.services.s3.model.CompleteMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket containing the multipart upload to complete
        • isRequesterPays

          boolean isRequesterPays
          If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.
        • key

          String key
          The key of the multipart upload to complete
        • partETags

          List<PartETag> partETags
          The list of part numbers and ETags to use when completing the multipart upload
        • uploadId

          String uploadId
          The ID of the multipart upload to complete
    • Class com.amazonaws.services.s3.model.CompleteMultipartUploadResult extends com.amazonaws.services.s3.internal.SSEResultBase implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket containing the completed multipart upload.
        • eTag

          String eTag
          The entity tag identifying the new object. An entity tag is an opaque string that changes if and only if an object's data changes.
        • expirationTime

          Date expirationTime
          The time this object expires, or null if it has no expiration
        • expirationTimeRuleId

          String expirationTimeRuleId
          The expiration rule for this object
        • isRequesterCharged

          boolean isRequesterCharged
          Indicate if the requester is charged for conducting this operation from Requester Pays Buckets.
        • key

          String key
          The key by which the object is stored.
        • location

          String location
          The URL identifying the new multipart object.
        • versionId

          String versionId
          The version ID of the new object, only present if versioning has been enabled for the bucket.
    • Class com.amazonaws.services.s3.model.CopyObjectRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • accessControlList

          AccessControlList accessControlList
          An optional access control list to apply to the new object. If specified, cannedAcl will be ignored.
        • cannedACL

          CannedAccessControlList cannedACL
          Optional field specifying the ACL for the new object
        • destinationBucketName

          String destinationBucketName
          The name of the bucket to contain the copy of the source object
        • destinationKey

          String destinationKey
          The key in the destination bucket under which the source object will be copied
        • destinationSSECustomerKey

          SSECustomerKey destinationSSECustomerKey
          The optional customer-provided server-side encryption key to use to encrypt the destination object being copied.
        • isRequesterPays

          boolean isRequesterPays
          If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.
        • matchingETagConstraints

          List<String> matchingETagConstraints
          Optional list of ETag values that constrain the copy request to only be executed if the source object's ETag matches one of the specified ETag values.
        • modifiedSinceConstraint

          Date modifiedSinceConstraint
          Optional field that constrains the copy request to only be executed if the source object has been modified since the specified date.
        • newObjectMetadata

          ObjectMetadata newObjectMetadata
          Optional field specifying the object metadata for the new object
        • nonmatchingEtagConstraints

          List<String> nonmatchingEtagConstraints
          Optional list of ETag values that constrain the copy request to only be executed if the source object's ETag does not match any of the specified ETag constraint values.
        • redirectLocation

          String redirectLocation
          Optional field specifying the redirect location for the new object
        • sourceBucketName

          String sourceBucketName
          The name of the bucket containing the object to be copied
        • sourceKey

          String sourceKey
          The key in the source bucket under which the object to be copied is stored
        • sourceSSECustomerKey

          SSECustomerKey sourceSSECustomerKey
          The optional customer-provided server-side encryption key to use to decrypt the source object being copied.
        • sourceVersionId

          String sourceVersionId
          Optional version Id specifying which version of the source object to copy. If not specified, the most recent version of the source object will be copied.

          For more information about enabling versioning for a bucket, see AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest).

        • sseAwsKeyManagementParams

          SSEAwsKeyManagementParams sseAwsKeyManagementParams
          The optional AWS Key Management system parameters to be used to encrypt the the object on the server side.
        • storageClass

          String storageClass
          The optional Amazon S3 storage class to use when storing the newly copied object. If not specified, the default, standard storage class will be used.

          For more information on Amazon S3 storage classes and available values, see the StorageClass enumeration.

        • unmodifiedSinceConstraint

          Date unmodifiedSinceConstraint
          Optional field that constrains the copy request to only be executed if the source object has not been modified since the specified date.
    • Class com.amazonaws.services.s3.model.CopyObjectResult extends com.amazonaws.services.s3.internal.SSEResultBase implements Serializable

      • Serialized Fields

        • etag

          String etag
          The ETag value of the new object
        • expirationTime

          Date expirationTime
          The time this object expires, or null if it has no expiration
        • expirationTimeRuleId

          String expirationTimeRuleId
          The expiration rule for this object
        • isRequesterCharged

          boolean isRequesterCharged
          Indicate if the requester is charged for conducting this operation from Requester Pays Buckets.
        • lastModifiedDate

          Date lastModifiedDate
          The last modified date for the new object
        • versionId

          String versionId
          The version ID of the new, copied object. This field will only be present if object versioning has been enabled for the bucket to which the object was copied.
    • Class com.amazonaws.services.s3.model.CopyPartRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • destinationBucketName

          String destinationBucketName
          The name of the bucket to contain the copy of the source object
        • destinationKey

          String destinationKey
          The key in the destination bucket under which the source object will be copied
        • destinationSSECustomerKey

          SSECustomerKey destinationSSECustomerKey
          The optional customer-provided server-side encryption key to use to encrypt the source object part being copied.
        • firstByte

          Long firstByte
          Optional field that copies the object starting at the given zero-based byte offset. Used with CopyPartRequest.lastByte
        • lastByte

          Long lastByte
          Optional field that copies the object up to and including the given zero-based byte offset. Used with CopyPartRequest.firstByte.
        • matchingETagConstraints

          List<String> matchingETagConstraints
          Optional list of ETag values that constrain the copy request to only be executed if the source object's ETag matches one of the specified ETag values.
        • modifiedSinceConstraint

          Date modifiedSinceConstraint
          Optional field that constrains the copy request to only be executed if the source object has been modified since the specified date.
        • nonmatchingEtagConstraints

          List<String> nonmatchingEtagConstraints
          Optional list of ETag values that constrain the copy request to only be executed if the source object's ETag does not match any of the specified ETag constraint values.
        • partNumber

          int partNumber
          The part number to copy into.
          See Also:
          AmazonS3.uploadPart(UploadPartRequest)
        • sourceBucketName

          String sourceBucketName
          The name of the bucket containing the object to be copied
        • sourceKey

          String sourceKey
          The key in the source bucket under which the object to be copied is stored
        • sourceSSECustomerKey

          SSECustomerKey sourceSSECustomerKey
          The optional customer-provided server-side encryption key to use to decrypt the source object part being copied.
        • sourceVersionId

          String sourceVersionId
          Optional version Id specifying which version of the source object to copy. If not specified, the most recent version of the source object will be copied.

          For more information about enabling versioning for a bucket, see AmazonS3#withBucketVersioningConfiguration(withBucketVersioningConfigurationRequest).

        • unmodifiedSinceConstraint

          Date unmodifiedSinceConstraint
          Optional field that constrains the copy request to only be executed if the source object has not been modified since the specified date.
        • uploadId

          String uploadId
          The upload id of the multipart upload into which to copy this part.
          See Also:
          AmazonS3.initiateMultipartUpload(InitiateMultipartUploadRequest)
    • Class com.amazonaws.services.s3.model.CopyPartResult extends com.amazonaws.services.s3.internal.SSEResultBase implements Serializable

      • Serialized Fields

        • etag

          String etag
          The ETag value of the new part
        • lastModifiedDate

          Date lastModifiedDate
          The last modified date for the new part
        • partNumber

          int partNumber
          The part number of the copied part
        • versionId

          String versionId
          The version ID of the source object. This field will only be present if object versioning has been enabled for the bucket from which the object was copied.
    • Class com.amazonaws.services.s3.model.CORSRule extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.CreateBucketRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • accessControlList

          AccessControlList accessControlList
          An optional access control list to apply to the new object. If specified, cannedAcl will be ignored.
        • bucketName

          String bucketName
          The name of the Amazon S3 bucket to create.
        • cannedAcl

          CannedAccessControlList cannedAcl
          The optional Canned ACL to set for the new bucket. Ignored in favor of accessControlList, if present
        • region

          String region
          The name of the Amazon S3 region in which to create this bucket.
    • Class com.amazonaws.services.s3.model.CryptoConfiguration extends Object implements Serializable

      serialVersionUID:
      -8646831898339939580L
      • Serialized Fields

        • cryptoMode

          CryptoMode cryptoMode
        • cryptoProvider

          Provider cryptoProvider
        • ignoreMissingInstructionFile

          boolean ignoreMissingInstructionFile
          True to ignore instruction file that cannot be found during a GET operation; false otherwise. Default is true. This property is ignored if the crypto mode is CryptoMode.StrictAuthenticatedEncryption where missing instruction file would always cause security exception.
        • storageMode

          CryptoStorageMode storageMode
    • Class com.amazonaws.services.s3.model.DeleteBucketCrossOriginConfigurationRequest extends GenericBucketRequest implements Serializable

    • Class com.amazonaws.services.s3.model.DeleteBucketLifecycleConfigurationRequest extends GenericBucketRequest implements Serializable

    • Class com.amazonaws.services.s3.model.DeleteBucketPolicyRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the Amazon S3 bucket whose policy is being deleted.
    • Class com.amazonaws.services.s3.model.DeleteBucketReplicationConfigurationRequest extends GenericBucketRequest implements Serializable

    • Class com.amazonaws.services.s3.model.DeleteBucketRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the Amazon S3 bucket to delete.
    • Class com.amazonaws.services.s3.model.DeleteBucketTaggingConfigurationRequest extends GenericBucketRequest implements Serializable

    • Class com.amazonaws.services.s3.model.DeleteBucketWebsiteConfigurationRequest extends GenericBucketRequest implements Serializable

    • Class com.amazonaws.services.s3.model.DeleteObjectRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the Amazon S3 bucket containing the object to delete.
        • isRequesterPays

          boolean isRequesterPays
          If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.
        • key

          String key
          The key of the object to delete.
    • Class com.amazonaws.services.s3.model.DeleteObjectsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the Amazon S3 bucket containing the object(s) to delete.
        • isRequesterPays

          boolean isRequesterPays
          If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.
        • keys

          List<DeleteObjectsRequest.KeyVersion> keys
          List of keys to delete, with optional versions.
        • mfa

          MultiFactorAuthentication mfa
          The optional Multi-Factor Authentication information to include with this request. Multi-Factor Authentication is required when deleting a version from a bucket that has enabled MFA Delete in its bucket versioning configuration. See BucketVersioningConfiguration.setMfaDeleteEnabled(Boolean) for more information on MFA Delete.
        • quiet

          boolean quiet
          Whether to enable quiet mode for the response. In quiet mode, only errors are reported. Defaults to false.
    • Class com.amazonaws.services.s3.model.DeleteObjectsRequest.KeyVersion extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.DeleteObjectsResult extends Object implements Serializable

      • Serialized Fields

        • deletedObjects

          List<DeleteObjectsResult.DeletedObject> deletedObjects
        • isRequesterCharged

          boolean isRequesterCharged
          Indicate if the requester is charged for conducting this operation from Requester Pays Buckets.
    • Class com.amazonaws.services.s3.model.DeleteObjectsResult.DeletedObject extends Object implements Serializable

      • Serialized Fields

        • deleteMarker

          boolean deleteMarker
        • deleteMarkerVersionId

          String deleteMarkerVersionId
        • key

          String key
        • versionId

          String versionId
    • Class com.amazonaws.services.s3.model.DeleteVersionRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the Amazon S3 bucket containing the version to delete.
        • key

          String key
          The key of the object version to delete.
        • mfa

          MultiFactorAuthentication mfa
          The optional Multi-Factor Authentication information to include with this request. Multi-Factor Authentication is required when deleting a version from a bucket that has enabled MFA Delete in its bucket versioning configuration. See BucketVersioningConfiguration.setMfaDeleteEnabled(Boolean) for more information on MFA Delete.
        • versionId

          String versionId
          The version ID uniquely identifying which version of the object to delete.
    • Class com.amazonaws.services.s3.model.EmailAddressGrantee extends Object implements Serializable

      • Serialized Fields

        • emailAddress

          String emailAddress
    • Class com.amazonaws.services.s3.model.EncryptedGetObjectRequest extends GetObjectRequest implements Serializable

      • Serialized Fields

        • instructionFileSuffix

          String instructionFileSuffix
          Used to retrieve the S3 encrypted object via instruction file with an explicit suffix. Applicable only if specified (which means non-null and non-blank.)
        • keyWrapExpected

          boolean keyWrapExpected
          True if the retrieval of the encrypted object expects the CEK to have been key-wrapped; Default is false.

          Note, however, that if CryptoMode.StrictAuthenticatedEncryption is in use, key wrapping is always expected for the CEK regardless.

        • supplemental

          ExtraMaterialsDescription supplemental
          Request specific additional material description; never null.
    • Class com.amazonaws.services.s3.model.EncryptedInitiateMultipartUploadRequest extends InitiateMultipartUploadRequest implements Serializable

      • Serialized Fields

        • createEncryptionMaterial

          boolean createEncryptionMaterial
          True if a new set of encryption material is to be created; false otherwise. Default is true.
        • materialsDescription

          Map<String,​String> materialsDescription
          description of encryption materials to be used with this request.
    • Class com.amazonaws.services.s3.model.EncryptedPutObjectRequest extends PutObjectRequest implements Serializable

      • Serialized Fields

        • materialsDescription

          Map<String,​String> materialsDescription
          description of encryption materials to be used with this request.
    • Class com.amazonaws.services.s3.model.EncryptionMaterials extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.ExtraMaterialsDescription extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.Filter extends Object implements Serializable

      • Serialized Fields

    • Class com.amazonaws.services.s3.model.FilterRule extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.GeneratePresignedUrlRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket involved in this request
        • contentMd5

          String contentMd5
          The optional Content-MD5 header that will be sent when the presigned URL is accessed
        • contentType

          String contentType
          The optional Content-Type header that will be sent when the presigned URL is accessed
        • expiration

          Date expiration
          An optional expiration date at which point the generated pre-signed URL will no longer be accepted by Amazon S3. If not specified, a default value will be supplied.
        • key

          String key
          The key of the object involved in this request
        • kmsCmkId

          String kmsCmkId
          Used to specify the KMS CMS Key ID when KMS server side encryption is in use.
        • method

          HttpMethod method
          The HTTP method (GET, PUT, DELETE, HEAD) to be used in this request and when the pre-signed URL is used
        • requestParameters

          Map<String,​String> requestParameters
          An optional map of additional parameters to include in the pre-signed URL. Adding additional request parameters enables more advanced pre-signed URLs, such as accessing Amazon S3's torrent resource for an object, or for specifying a version ID when accessing an object.
        • responseHeaders

          ResponseHeaderOverrides responseHeaders
          Optional field that overrides headers on the response.
        • sseAlgorithm

          String sseAlgorithm
          Used to specify the server side encryption algorithm. Null means no server side encryption is in use.
        • sseCustomerKey

          SSECustomerKey sseCustomerKey
          Optional customer-provided server-side encryption key to use as part of the generated pre-signed URL.
        • zeroByteContent

          boolean zeroByteContent
          True if the request content is set to zero byte instead of null. This is necessary to make pre-signed URL generation work for multi-part upload initiation using SigV4. Ref: TT0050059365
    • Class com.amazonaws.services.s3.model.GenericBucketRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
    • Class com.amazonaws.services.s3.model.GetBucketAccelerateConfigurationRequest extends GenericBucketRequest implements Serializable

    • Class com.amazonaws.services.s3.model.GetBucketAclRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket whose ACL is being retrieved.
    • Class com.amazonaws.services.s3.model.GetBucketCrossOriginConfigurationRequest extends GenericBucketRequest implements Serializable

    • Class com.amazonaws.services.s3.model.GetBucketLifecycleConfigurationRequest extends GenericBucketRequest implements Serializable

    • Class com.amazonaws.services.s3.model.GetBucketLocationRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket whose location is being requested.
    • Class com.amazonaws.services.s3.model.GetBucketLoggingConfigurationRequest extends GenericBucketRequest implements Serializable

    • Class com.amazonaws.services.s3.model.GetBucketNotificationConfigurationRequest extends GenericBucketRequest implements Serializable

    • Class com.amazonaws.services.s3.model.GetBucketPolicyRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the Amazon S3 bucket whose policy is being retrieved.
    • Class com.amazonaws.services.s3.model.GetBucketReplicationConfigurationRequest extends GenericBucketRequest implements Serializable

    • Class com.amazonaws.services.s3.model.GetBucketTaggingConfigurationRequest extends GenericBucketRequest implements Serializable

    • Class com.amazonaws.services.s3.model.GetBucketVersioningConfigurationRequest extends GenericBucketRequest implements Serializable

    • Class com.amazonaws.services.s3.model.GetBucketWebsiteConfigurationRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket whose website configuration is being retrieved.
    • Class com.amazonaws.services.s3.model.GetObjectAclRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • isRequesterPays

          boolean isRequesterPays
          If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.
        • s3ObjectIdBuilder

          S3ObjectIdBuilder s3ObjectIdBuilder
          Builder of an S3 object identifier. This member field is never null.
    • Class com.amazonaws.services.s3.model.GetObjectMetadataRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket containing the object's whose metadata is being retrieved.
        • isRequesterPays

          boolean isRequesterPays
          If enabled, the requester is charged for downloading the metadata from Requester Pays Buckets.
        • key

          String key
          The key of the object whose metadata is being retrieved.
        • partNumber

          Integer partNumber
          The optional part number to find the number of parts of an object.
        • sseCustomerKey

          SSECustomerKey sseCustomerKey
          The optional customer-provided server-side encryption key to use when retrieving the metadata of a server-side encrypted object.
        • versionId

          String versionId
          The optional version ID of the object version whose metadata is being retrieved. If not specified, the latest version will be used.
    • Class com.amazonaws.services.s3.model.GetObjectRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • isRequesterPays

          boolean isRequesterPays
          If enabled, the requester is charged for downloading the data from Requester Pays Buckets.
        • matchingETagConstraints

          List<String> matchingETagConstraints
          Optional list of ETag values that constrain this request to only be executed if the object's ETag matches one of the specified ETag values.
        • modifiedSinceConstraint

          Date modifiedSinceConstraint
          Optional field that constrains this request to only be executed if the object has been modified since the specified date.
        • nonmatchingEtagConstraints

          List<String> nonmatchingEtagConstraints
          Optional list of ETag values that constrain this request to only be executed if the object's ETag does not match any of the specified ETag constraint values.
        • partNumber

          Integer partNumber
          The part number of the requested part in a multipart object.
        • range

          long[] range
          Optional member indicating the byte range of data to retrieve
        • responseHeaders

          ResponseHeaderOverrides responseHeaders
          Optional field that overrides headers on the response.
        • s3ObjectIdBuilder

          S3ObjectIdBuilder s3ObjectIdBuilder
          Builder of an S3 object identifier. This member field is never null.
        • sseCustomerKey

          SSECustomerKey sseCustomerKey
          The optional customer-provided server-side encryption key to use to decrypt this object.
        • unmodifiedSinceConstraint

          Date unmodifiedSinceConstraint
          Optional field that constrains this request to only be executed if the object has not been modified since the specified date.
    • Class com.amazonaws.services.s3.model.GetRequestPaymentConfigurationRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the Amazon S3 bucket.
    • Class com.amazonaws.services.s3.model.GetS3AccountOwnerRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.s3.model.Grant extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.HeadBucketRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
    • Class com.amazonaws.services.s3.model.HeadBucketResult extends Object implements Serializable

      • Serialized Fields

        • bucketRegion

          String bucketRegion
    • Class com.amazonaws.services.s3.model.InitiateMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • accessControlList

          AccessControlList accessControlList
          An optional access control list to apply to the new upload. If specified, cannedAcl will be ignored.
        • bucketName

          String bucketName
          The name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.
        • cannedACL

          CannedAccessControlList cannedACL
          An optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.
        • isRequesterPays

          boolean isRequesterPays
          If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.
        • key

          String key
          The key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.
        • objectMetadata

          ObjectMetadata objectMetadata
          Additional information about the new object being created, such as content type, content encoding, user metadata, etc.
        • redirectLocation

          String redirectLocation
          The optional redirect location for the new object.
        • sseAwsKeyManagementParams

          SSEAwsKeyManagementParams sseAwsKeyManagementParams
          The optional AWS Key Management system parameters to be used to encrypt the the object on the server side.
        • sseCustomerKey

          SSECustomerKey sseCustomerKey
          The optional customer-provided server-side encryption key to use to encrypt the upload being started.
        • storageClass

          StorageClass storageClass
          The optional storage class to use when storing this upload's data in S3. If not specified, the default storage class is used.
    • Class com.amazonaws.services.s3.model.InitiateMultipartUploadResult extends com.amazonaws.services.s3.internal.SSEResultBase implements Serializable

      • Serialized Fields

        • abortDate

          Date abortDate
          Date when multipart upload will become eligible for abort operation by lifecycle.
        • abortRuleId

          String abortRuleId
          Id of the lifecycle rule that makes a multipart upload eligible for abort operation.
        • bucketName

          String bucketName
          The name of the bucket in which the new multipart upload was initiated
        • isRequesterCharged

          boolean isRequesterCharged
          Indicate if the requester is charged for conducting this operation from Requester Pays Buckets.
        • key

          String key
          The object key for which the multipart upload was initiated
        • uploadId

          String uploadId
          The unique ID of the new multipart upload
    • Class com.amazonaws.services.s3.model.InstructionFileId extends S3ObjectId implements Serializable

    • Class com.amazonaws.services.s3.model.KMSEncryptionMaterials extends EncryptionMaterials implements Serializable

    • Class com.amazonaws.services.s3.model.KMSEncryptionMaterialsProvider extends StaticEncryptionMaterialsProvider implements Serializable

    • Class com.amazonaws.services.s3.model.LambdaConfiguration extends NotificationConfiguration implements Serializable

      • Serialized Fields

        • functionARN

          String functionARN
          The ARN for the lambda function to be invoked.
    • Class com.amazonaws.services.s3.model.ListBucketsRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.s3.model.ListMultipartUploadsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket containing the uploads to list.
        • delimiter

          String delimiter
          Optional parameter that causes multipart uploads for keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the MultipartUploadListing.getCommonPrefixes() list. These rolled-up keys are not returned elsewhere in the response. The most commonly used delimiter is "/", which simulates a hierarchical organization similar to a file system directory structure.
        • encodingType

          String encodingType
          Optional parameter indicating the encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
        • keyMarker

          String keyMarker
          The optional key marker indicating where in the results to begin listing.

          Together with the upload ID marker, specifies the multipart upload after which listing should begin.

          If the upload ID marker is not specified, only the keys lexicographically greater than the specified key-marker will be included in the list.

          If the upload ID marker is specified, any multipart uploads for a key equal to the key-marker may also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified marker.

        • maxUploads

          Integer maxUploads
          The optional maximum number of uploads to return.
        • prefix

          String prefix
          Optional parameter restricting the response to multipart uploads for keys which begin with the specified prefix. You can use prefixes to separate a bucket into different sets of keys in a way similar to how a file system uses folders.
        • uploadIdMarker

          String uploadIdMarker
          The optional upload ID marker indicating where in the results to begin listing.

          Together with the key marker, specifies the multipart upload after which listing should begin. If no key marker is specified, the upload ID marker is ignored. Otherwise, any multipart uploads for a key equal to the key marker may be included in the list only if they have an upload ID lexicographically greater than the specified marker.

    • Class com.amazonaws.services.s3.model.ListNextBatchOfObjectsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

    • Class com.amazonaws.services.s3.model.ListNextBatchOfVersionsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

    • Class com.amazonaws.services.s3.model.ListObjectsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the Amazon S3 bucket to list.
        • delimiter

          String delimiter
          Optional parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the ObjectListing.getCommonPrefixes() list. These rolled-up keys are not returned elsewhere in the response. The most commonly used delimiter is "/", which simulates a hierarchical organization similar to a file system directory structure.
        • encodingType

          String encodingType
          Optional parameter indicating the encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
        • marker

          String marker
          Optional parameter indicating where in the bucket to begin listing. The list will only include keys that occur lexicographically after the marker. This enables pagination; to get the next page of results use the current value from ObjectListing.getNextMarker() as the marker for the next request to list objects.
        • maxKeys

          Integer maxKeys
          Optional parameter indicating the maximum number of keys to include in the response. Amazon S3 might return fewer than this, but will not return more. Even if maxKeys is not specified, Amazon S3 will limit the number of results in the response.
        • prefix

          String prefix
          Optional parameter restricting the response to keys which begin with the specified prefix. You can use prefixes to separate a bucket into different sets of keys in a way similar to how a file system uses folders.
    • Class com.amazonaws.services.s3.model.ListObjectsV2Request extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the Amazon S3 bucket to list.
        • continuationToken

          String continuationToken
          Optional parameter which allows list to be continued from a specific point. ContinuationToken is provided in truncated list results.
        • delimiter

          String delimiter
          Optional parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the ListObjectsV2Result.getCommonPrefixes() list. These rolled-up keys are not returned elsewhere in the response. The most commonly used delimiter is "/", which simulates a hierarchical organization similar to a file system directory structure.
        • encodingType

          String encodingType
          Optional parameter indicating the encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
        • fetchOwner

          boolean fetchOwner
          The owner field is not present in ListObjectsV2 results by default. If this flag is set to true the owner field will be included.
        • maxKeys

          Integer maxKeys
          Optional parameter indicating the maximum number of keys to include in the response. Amazon S3 might return fewer than this, but will not return more. Even if maxKeys is not specified, Amazon S3 will limit the number of results in the response.
        • prefix

          String prefix
          Optional parameter restricting the response to keys which begin with the specified prefix. You can use prefixes to separate a bucket into different sets of keys in a way similar to how a file system uses folders.
        • startAfter

          String startAfter
          Optional parameter indicating where you want Amazon S3 to start the object listing from. This can be any key in the bucket.
    • Class com.amazonaws.services.s3.model.ListObjectsV2Result extends Object implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the Amazon S3 bucket containing the listed objects
        • commonPrefixes

          List<String> commonPrefixes
          A list of the common prefixes included in this object listing - common prefixes will only be populated for requests that specified a delimiter
        • continuationToken

          String continuationToken
          Optional parameter which allows list to be continued from a specific point. ContinuationToken is provided in truncated list results.
        • delimiter

          String delimiter
          The delimiter parameter originally specified by the caller when this object listing was returned
        • encodingType

          String encodingType
          The encodingType parameter originally specified by the caller when this object listing was returned.
        • isTruncated

          boolean isTruncated
          Indicates if this is a complete listing, or if the caller needs to make additional requests to Amazon S3 to see the full object listing for an S3 bucket
        • keyCount

          int keyCount
          KeyCount is the number of keys returned with this response
        • maxKeys

          int maxKeys
          The maxKeys parameter originally specified by the caller when this object listing was returned
        • nextContinuationToken

          String nextContinuationToken
          NextContinuationToken is sent when isTruncated is true meaning there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued by providing this NextContinuationToken.
        • objectSummaries

          List<S3ObjectSummary> objectSummaries
          A list of summary information describing the objects stored in the bucket
        • prefix

          String prefix
          The prefix parameter originally specified by the caller when this object listing was returned
        • startAfter

          String startAfter
          Optional parameter indicating where you want Amazon S3 to start the object listing from. This can be any key in the bucket.
    • Class com.amazonaws.services.s3.model.ListPartsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket containing the multipart upload whose parts are being listed.
        • encodingType

          String encodingType
          Optional parameter indicating the encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
        • isRequesterPays

          boolean isRequesterPays
          If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.
        • key

          String key
          The key of the associated multipart upload whose parts are being listed.
        • maxParts

          Integer maxParts
          The optional maximum number of parts to be returned in the part listing.
        • partNumberMarker

          Integer partNumberMarker
          The optional part number marker indicating where in the results to being listing parts.
        • uploadId

          String uploadId
          The ID of the multipart upload whose parts are being listed.
    • Class com.amazonaws.services.s3.model.ListVersionsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the Amazon S3 bucket whose versions are to be listed.
        • delimiter

          String delimiter
          Optional parameter that causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the VersionListing.getCommonPrefixes() list. These rolled-up keys are not returned elsewhere in the response. The most commonly used delimiter is "/", which simulates a hierarchical organization similar to a file system directory structure.
        • encodingType

          String encodingType
          Optional parameter indicating the encoding method to be applied on the response. An object key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
        • keyMarker

          String keyMarker
          Optional parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results. Results are always ordered first lexicographically (i.e. alphabetically) and then from most recent version to least recent version. If a keyMarker is used without a versionIdMarker, results begin immediately after that key's last version. When a keyMarker is used with a versionIdMarker, results begin immediately after the version with the specified key and version ID.

          This enables pagination; to get the next page of results use the next key marker and next version ID marker (from VersionListing.getNextKeyMarker() and VersionListing.getNextVersionIdMarker()) as the markers for the next request to list versions. Or use the convenience method AmazonS3.listNextBatchOfVersions(VersionListing)

        • maxResults

          Integer maxResults
          Optional parameter indicating the maximum number of results to include in the response. Amazon S3 might return fewer than this, but will not return more. Even if maxKeys is not specified, Amazon S3 will limit the number of results in the response.
        • prefix

          String prefix
          Optional parameter restricting the response to keys which begin with the specified prefix. You can use prefixes to separate a bucket into different sets of keys in a way similar to how a file system uses folders.
        • versionIdMarker

          String versionIdMarker
          Optional parameter indicating where in the sorted list of all versions in the specified bucket to begin returning results. Results are always ordered first lexicographically (i.e. alphabetically) and then from most recent version to least recent version. A keyMarker must be specified when specifying a versionIdMarker. Results begin immediately after the version with the specified key and version ID.

          This enables pagination; to get the next page of results use the next key marker and next version ID marker (from VersionListing.getNextKeyMarker() and VersionListing.getNextVersionIdMarker()) as the markers for the next request to list versions. Or use the convenience method AmazonS3.listNextBatchOfVersions(VersionListing)

    • Class com.amazonaws.services.s3.model.MultiFactorAuthentication extends Object implements Serializable

      • Serialized Fields

        • deviceSerialNumber

          String deviceSerialNumber
          The serial number of the Multi-Factor Authentication device associated with your AWS account.
        • token

          String token
          The current, unique Multi-Factor Authentication (MFA) token generated by the MFA device associated with your AWS account.
    • Class com.amazonaws.services.s3.model.MultiObjectDeleteException extends AmazonS3Exception implements Serializable

      serialVersionUID:
      -2004213552302446866L
    • Class com.amazonaws.services.s3.model.MultiObjectDeleteException.DeleteError extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.MultipartUpload extends Object implements Serializable

      • Serialized Fields

        • initiated

          Date initiated
          The date at which this upload was initiated.
        • initiator

          Owner initiator
          The initiator of this multipart upload.
        • key

          String key
          The key by which this upload is stored.
        • owner

          Owner owner
          The owner of this multipart upload.
        • storageClass

          String storageClass
          The storage class indicating how the data in this multipart upload will be stored.
        • uploadId

          String uploadId
          The unique ID of this multipart upload.
    • Class com.amazonaws.services.s3.model.MultipartUploadListing extends Object implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket containing the listed multipart uploads, as specified in the original request.
        • commonPrefixes

          List<String> commonPrefixes
          A list of the common prefixes included in this multipart upload listing - common prefixes will only be populated for requests that specified a delimiter, and indicate additional key prefixes that contain more multipart uploads that have not been included in this listing.
        • delimiter

          String delimiter
          The optional delimiter specified in the original request to control how multipart uploads for keys with common prefixes are condensed.
        • encodingType

          String encodingType
          The encodingType parameter originally specified by the caller when this multipart upload listing was returned.
        • isTruncated

          boolean isTruncated
          Indicates if the listing is truncated, and additional requests need to be made to get more results.
        • keyMarker

          String keyMarker
          The optional key marker specified in the original request to specify where in the results to begin listing multipart uploads.
        • maxUploads

          int maxUploads
          The optional maximum number of uploads to be listed, as specified in the original request.
        • multipartUploads

          List<MultipartUpload> multipartUploads
          The list of multipart uploads.
        • nextKeyMarker

          String nextKeyMarker
          If this listing is truncated, this is the next key marker that should be used in the next request to get the next page of results.
        • nextUploadIdMarker

          String nextUploadIdMarker
          If this listing is truncated, this is the next upload ID marker that should be used in the next request to get the next page of results.
        • prefix

          String prefix
          The optional prefix specified in the original request to limit the returned multipart uploads to those for keys that match this prefix.
        • uploadIdMarker

          String uploadIdMarker
          The optional upload ID marker specified in the original request to specify where in the results to begin listing multipart uploads.
    • Class com.amazonaws.services.s3.model.ObjectListing extends Object implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the Amazon S3 bucket containing the listed objects
        • commonPrefixes

          List<String> commonPrefixes
          A list of the common prefixes included in this object listing - common prefixes will only be populated for requests that specified a delimiter
        • delimiter

          String delimiter
          The delimiter parameter originally specified by the caller when this object listing was returned
        • encodingType

          String encodingType
          The encodingType parameter originally specified by the caller when this object listing was returned.
        • isTruncated

          boolean isTruncated
          Indicates if this is a complete listing, or if the caller needs to make additional requests to Amazon S3 to see the full object listing for an S3 bucket
        • marker

          String marker
          The marker parameter originally specified by the caller when this object listing was returned
        • maxKeys

          int maxKeys
          The maxKeys parameter originally specified by the caller when this object listing was returned
        • nextMarker

          String nextMarker
          The marker to use in order to request the next page of results - only populated if the isTruncated member indicates that this object listing is truncated
        • objectSummaries

          List<S3ObjectSummary> objectSummaries
          A list of summary information describing the objects stored in the bucket
        • prefix

          String prefix
          The prefix parameter originally specified by the caller when this object listing was returned
    • Class com.amazonaws.services.s3.model.ObjectMetadata extends Object implements Serializable

      • Serialized Fields

        • expirationTime

          Date expirationTime
          The time this object will expire and be completely removed from S3, or null if this object will never expire.

          This and the expiration time rule aren't stored in the metadata map because the header contains both the time and the rule.

        • expirationTimeRuleId

          String expirationTimeRuleId
          The expiration rule id for this object.
        • httpExpiresDate

          Date httpExpiresDate
          The date when the object is no longer cacheable.
        • metadata

          Map<String,​Object> metadata
          All other (non user custom) headers such as Content-Length, Content-Type, etc.
        • ongoingRestore

          Boolean ongoingRestore
          Boolean value indicating whether there is an ongoing request to restore an archived copy of this object from Amazon Glacier.
        • restoreExpirationTime

          Date restoreExpirationTime
          The time at which an object that has been temporarily restored from Glacier will expire, and will need to be restored again in order to be accessed. Null if this object has not been restored from Glacier.
        • userMetadata

          Map<String,​String> userMetadata
          Custom user metadata, represented in responses with the x-amz-meta- header prefix
    • Class com.amazonaws.services.s3.model.Owner extends Object implements Serializable

      serialVersionUID:
      -8916731456944569115L
      • Serialized Fields

    • Class com.amazonaws.services.s3.model.PartETag extends Object implements Serializable

      • Serialized Fields

        • eTag

          String eTag
          The entity tag generated from the content of the associated part.
        • partNumber

          int partNumber
          The part number of the associated part.
    • Class com.amazonaws.services.s3.model.PartListing extends Object implements Serializable

      • Serialized Fields

        • abortDate

          Date abortDate
          Date when multipart upload will become eligible for abort operation by lifecycle.
        • abortRuleId

          String abortRuleId
          Id of the lifecycle rule that makes a multipart upload eligible for abort operation.
        • bucketName

          String bucketName
          The name of the bucket containing the listed parts, as specified in the original request.
        • encodingType

          String encodingType
          The encodingType parameter originally specified by the caller when this part listing was returned.
        • initiator

          Owner initiator
          The initiator of the associated multipart upload.
        • isRequesterCharged

          boolean isRequesterCharged
          Indicate if the requester is charged for conducting this operation from Requester Pays Buckets.
        • isTruncated

          boolean isTruncated
          Indicates if the listing is truncated, and additional requests need to be made to get more results.
        • key

          String key
          The key value specified in the original request used to identify which multipart upload contains the parts to list.
        • maxParts

          Integer maxParts
          The optional max parts value specified in the original request to limit how many parts are listed.
        • nextPartNumberMarker

          Integer nextPartNumberMarker
          If this listing is truncated, this is the part number marker that should be used in the next request to get the next page of results.
        • owner

          Owner owner
          The user who owns the associated multipart upload.
        • partNumberMarker

          Integer partNumberMarker
          The optional part number marker specified in the original request to specify where in the results to begin listing parts.
        • parts

          List<PartSummary> parts
          The list of parts described in this part listing.
        • storageClass

          String storageClass
          The class of storage used for the parts in the associated multipart upload.
        • uploadId

          String uploadId
          The upload ID value specified in the original request used to identify which multipart upload contains the parts to list.
    • Class com.amazonaws.services.s3.model.PartSummary extends Object implements Serializable

      • Serialized Fields

        • eTag

          String eTag
          The entity tag generated from the part content.
        • lastModified

          Date lastModified
          The date at which this part was last modified.
        • partNumber

          int partNumber
          The part number describing this part's position relative to the other parts in the multipart upload. Part number must be between 1 and 10,000 (inclusive).
        • size

          long size
          The size, in bytes, of the part.
    • Class com.amazonaws.services.s3.model.PutObjectRequest extends AbstractPutObjectRequest implements Serializable

      • Serialized Fields

        • isRequesterPays

          boolean isRequesterPays
          If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.
    • Class com.amazonaws.services.s3.model.PutObjectResult extends com.amazonaws.services.s3.internal.SSEResultBase implements Serializable

      • Serialized Fields

        • contentMd5

          String contentMd5
          The content MD5
        • eTag

          String eTag
          The ETag value of the new object
        • expirationTime

          Date expirationTime
          The time this object expires, or null if it has no expiration
        • expirationTimeRuleId

          String expirationTimeRuleId
          The expiration rule for this object
        • isRequesterCharged

          boolean isRequesterCharged
          Indicate if the requester is charged for conducting this operation from Requester Pays Buckets.
        • metadata

          ObjectMetadata metadata
          The metadata returned as a result of PutObject operation.
        • versionId

          String versionId
          The version ID of the new, uploaded object. This field will only be present if object versioning has been enabled for the bucket to which the object was uploaded.
    • Class com.amazonaws.services.s3.model.QueueConfiguration extends NotificationConfiguration implements Serializable

      • Serialized Fields

        • queueARN

          String queueARN
          The Amazon SQS queue ARN for this configuration.
    • Class com.amazonaws.services.s3.model.RedirectRule extends Object implements Serializable

      • Serialized Fields

        • hostName

          String hostName
          The host name to use in the redirect request
        • httpRedirectCode

          String httpRedirectCode
          The HTTP code to use in the redirect response
        • protocol

          String protocol
          The protocol to use in the redirect request
        • replaceKeyPrefixWith

          String replaceKeyPrefixWith
          The object prefix key to use in the redirect request
        • replaceKeyWith

          String replaceKeyWith
          The specific key to use in the redirect request
    • Class com.amazonaws.services.s3.model.ReplicationDestinationConfig extends Object implements Serializable

      • Serialized Fields

        • bucketARN

          String bucketARN
          The ARN of the Amazon S3 bucket where the replicas are sent.
        • storageClass

          String storageClass
          Storage class for the replica. If not specified, Amazon S3 uses the storage class of the source object to create object replica.
    • Class com.amazonaws.services.s3.model.ReplicationRule extends Object implements Serializable

      • Serialized Fields

        • destinationConfig

          ReplicationDestinationConfig destinationConfig
          Destination configuration for the replication rule.
        • prefix

          String prefix
          The Amazon S3 object prefix for the replication rule. This rule will be applied if an Amazon S3 object matches this prefix.
        • status

          String status
          The status of this replication rule. Valid values are Enabled, Disabled. The rule will be applied only if the status is Enabled.
    • Class com.amazonaws.services.s3.model.RequestPaymentConfiguration extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.ResponseHeaderOverrides extends Object implements Serializable

      • Serialized Fields

        • cacheControl

          String cacheControl
        • contentDisposition

          String contentDisposition
        • contentEncoding

          String contentEncoding
        • contentLanguage

          String contentLanguage
        • contentType

          String contentType
        • expires

          String expires
    • Class com.amazonaws.services.s3.model.RestoreObjectRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket containing the reference to the object to restore which is now stored in Amazon Glacier.
        • expirationInDays

          int expirationInDays
          The time, in days, between when an object is restored to the bucket and when it expires.
        • isRequesterPays

          boolean isRequesterPays
          If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.
        • key

          String key
          The key, the name of the reference to the object to restore, which is now stored in Amazon Glacier.
        • versionId

          String versionId
          Optional version ID specifying which version of the object to restore. If not specified, the most recent version will be restored.

          For more information about enabling versioning for a bucket, see AmazonS3#setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest). For more information about enabling lifecycle versioning for a bucket, see AmazonS3#setBucketLifecycleConfiguration(SetBucketLifecycleConfigurationRequest).

    • Class com.amazonaws.services.s3.model.RoutingRule extends Object implements Serializable

      • Serialized Fields

        • condition

          RoutingRuleCondition condition
          The condition that must be met for the specified redirect to apply. For example if request is for pages in the /docs folder, redirect to the /documents folder or if request results in HTTP error 4xx, redirect request to another host where you might process the error.
        • redirect

          RedirectRule redirect
          Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can can specify a different error code to return.
    • Class com.amazonaws.services.s3.model.RoutingRuleCondition extends Object implements Serializable

      • Serialized Fields

        • httpErrorCodeReturnedEquals

          String httpErrorCodeReturnedEquals
          The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied.
        • keyPrefixEquals

          String keyPrefixEquals
          The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder.
    • Class com.amazonaws.services.s3.model.S3KeyFilter extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.S3Object extends Object implements Serializable

      serialVersionUID:
      1L
      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket in which this object is contained
        • isRequesterCharged

          boolean isRequesterCharged
          Indicates if the requester is charged for downloading the data from Requester Pays Buckets.
        • key

          String key
          The key under which this object is stored
        • metadata

          ObjectMetadata metadata
          The metadata stored by Amazon S3 for this object
        • redirectLocation

          String redirectLocation
          The redirect location for this object
    • Class com.amazonaws.services.s3.model.S3ObjectId extends Object implements Serializable

      • Serialized Fields

        • bucket

          String bucket
        • key

          String key
        • versionId

          String versionId
          Optional and applicable only for get operation.
    • Class com.amazonaws.services.s3.model.S3ObjectIdBuilder extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.S3ObjectSummary extends Object implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket in which this object is stored
        • eTag

          String eTag
          Hex encoded MD5 hash of this object's contents, as computed by Amazon S3
        • key

          String key
          The key under which this object is stored
        • lastModified

          Date lastModified
          The date, according to Amazon S3, when this object was last modified
        • owner

          Owner owner
          The owner of this object - can be null if the requester doesn't have permission to view object ownership information
        • size

          long size
          The size of this object, in bytes
        • storageClass

          String storageClass
          The class of storage used by Amazon S3 to store this object
    • Class com.amazonaws.services.s3.model.S3VersionSummary extends Object implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket in which this version is stored
        • eTag

          String eTag
          Hex encoded MD5 hash of this version's contents, as computed by Amazon S3
        • isDeleteMarker

          boolean isDeleteMarker
          True if this object represents a delete marker
        • isLatest

          boolean isLatest
          True if this is the latest version of the associated object
        • key

          String key
          The key under which this version is stored
        • lastModified

          Date lastModified
          The date, according to Amazon S3, when this version was last modified
        • owner

          Owner owner
          The owner of this version of the associated object - can be null if the requester doesn't have permission to view object ownership information
        • size

          long size
          The size of this version, in bytes
        • storageClass

          String storageClass
          The class of storage used by Amazon S3 to store this version
        • versionId

          String versionId
          The version ID uniquely identifying this version of an object
    • Class com.amazonaws.services.s3.model.SetBucketAclRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • acl

          AccessControlList acl
          The custom ACL to apply to the specified bucket.
        • bucketName

          String bucketName
          The name of the bucket whose ACL is being set.
        • cannedAcl

          CannedAccessControlList cannedAcl
          The canned ACL to apply to the specified bucket.
    • Class com.amazonaws.services.s3.model.SetBucketCrossOriginConfigurationRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The bucket whose cross origin configuration is being set.
        • crossOriginConfiguration

          BucketCrossOriginConfiguration crossOriginConfiguration
          The new cross origin configuration for the specified bucket.
    • Class com.amazonaws.services.s3.model.SetBucketLifecycleConfigurationRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The bucket whose lifecycle configuration is being set.
        • lifecycleConfiguration

          BucketLifecycleConfiguration lifecycleConfiguration
          The new lifecycle configuration for the specified bucket.
    • Class com.amazonaws.services.s3.model.SetBucketLoggingConfigurationRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket whose logging configuration is being set.
        • loggingConfiguration

          BucketLoggingConfiguration loggingConfiguration
          The new logging configuration for the specified bucket.
    • Class com.amazonaws.services.s3.model.SetBucketNotificationConfigurationRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.s3.model.SetBucketPolicyRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the Amazon S3 bucket whose policy is being set.
        • policyText

          String policyText
          The policy to apply to the specified bucket.
    • Class com.amazonaws.services.s3.model.SetBucketReplicationConfigurationRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of Amazon S3 bucket to which the replication configuration is set.
        • replicationConfiguration

          BucketReplicationConfiguration replicationConfiguration
          Replication configuration for an Amazon S3 bucket.
    • Class com.amazonaws.services.s3.model.SetBucketTaggingConfigurationRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The bucket whose tagging configuration is being set.
        • taggingConfiguration

          BucketTaggingConfiguration taggingConfiguration
          The new tagging configuration for the specified bucket.
    • Class com.amazonaws.services.s3.model.SetBucketVersioningConfigurationRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The bucket whose versioning configuration is being set.
        • mfa

          MultiFactorAuthentication mfa
          The optional Multi-Factor Authentication information to include with this request. Multi-Factor Authentication is required when enabling or disabling the MFA Delete option. See BucketVersioningConfiguration for more details on MFA Delete.
        • versioningConfiguration

          BucketVersioningConfiguration versioningConfiguration
          The new versioning configuration for the specified bucket.
    • Class com.amazonaws.services.s3.model.SetBucketWebsiteConfigurationRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket whose website configuration is being set.
        • configuration

          BucketWebsiteConfiguration configuration
          The new website configuration for the specified bucket.
    • Class com.amazonaws.services.s3.model.SetObjectAclRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • acl

          AccessControlList acl
          The custom ACL to apply to the specified object.
        • bucketName

          String bucketName
          The name of the bucket containing the object whose ACL is being set.
        • cannedAcl

          CannedAccessControlList cannedAcl
          The canned ACL to apply to the specified object.
        • isRequesterPays

          boolean isRequesterPays
          If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.
        • key

          String key
          The name of the object whose ACL is being set.
        • versionId

          String versionId
          The version ID of the object version whose ACL is being set.
    • Class com.amazonaws.services.s3.model.SetRequestPaymentConfigurationRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the Amazon S3 bucket.
        • configuration

          RequestPaymentConfiguration configuration
          The configuration associated with the Amazon S3 bucket.
    • Class com.amazonaws.services.s3.model.SimpleMaterialProvider extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.SSEAwsKeyManagementParams extends Object implements Serializable

      • Serialized Fields

        • awsKmsKeyId

          String awsKmsKeyId
          The AWS Key Management Key id to be used for Server Side Encryption of the Amazon S3 object.
    • Class com.amazonaws.services.s3.model.SSECustomerKey extends Object implements Serializable

      • Serialized Fields

        • algorithm

          String algorithm
        • base64EncodedKey

          String base64EncodedKey
        • base64EncodedMd5

          String base64EncodedMd5
    • Class com.amazonaws.services.s3.model.StaticEncryptionMaterialsProvider extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.TagSet extends Object implements Serializable

    • Class com.amazonaws.services.s3.model.TopicConfiguration extends NotificationConfiguration implements Serializable

      • Serialized Fields

        • topicARN

          String topicARN
          The Amazon SNS topic ARN for this configuration.
    • Class com.amazonaws.services.s3.model.UploadObjectRequest extends AbstractPutObjectRequest implements Serializable

      serialVersionUID:
      1L
      • Serialized Fields

        • diskLimit

          long diskLimit
          Limitation (in bytes) on temporary disk space consumption for this request; must be at least twice the amount of the specified UploadObjectRequest.partSize. The default is 9223372036854775807L.
        • materialsDescription

          Map<String,​String> materialsDescription
          description of encryption materials to be used with this request.
        • partSize

          long partSize
          Part size (in bytes). Default is 5242880. This part size will be used as a reference for the multi-part uploads but the physical part size may vary.
        • uploadPartMetadata

          ObjectMetadata uploadPartMetadata
          Optional metadata to be included in each upload part requests.
    • Class com.amazonaws.services.s3.model.UploadPartRequest extends AmazonWebServiceRequest implements Serializable

      serialVersionUID:
      1L
      • Serialized Fields

        • bucketName

          String bucketName
          The name of the bucket containing the initiated multipart upload with which this new part will be associated.
        • file

          File file
          The file containing the data to upload. Exactly one File or InputStream must be specified as the input to this operation.
        • fileOffset

          long fileOffset
          The optional offset in the specified file, at which to begin uploading data for this part. If not specified, data will be read from the beginning of the file.
        • isLastPart

          boolean isLastPart
          Allows the caller to indicate if this is the last part being uploaded in a multipart upload.
        • isRequesterPays

          boolean isRequesterPays
          If enabled, the requester is charged for conducting this operation from Requester Pays Buckets.
        • key

          String key
          The key of the initiated multipart upload
        • md5Digest

          String md5Digest
          The optional, but recommended, MD5 hash of the content of this part. If specified, this value will be sent to Amazon S3 to verify the data integrity when the data reaches Amazon S3.
        • objectMetadata

          ObjectMetadata objectMetadata
          Additional information about the part being uploaded, such as referrer.
        • partNumber

          int partNumber
          The part number describing this part's position relative to the other parts in the multipart upload. Part number must be between 1 and 10,000 (inclusive).
        • partSize

          long partSize
          The size of this part, in bytes.
        • sseCustomerKey

          SSECustomerKey sseCustomerKey
          The optional customer-provided server-side encryption key to use to encrypt the object part being uploaded.
        • uploadId

          String uploadId
          The ID of an existing, initiated multipart upload, with which this new part will be associated.
    • Class com.amazonaws.services.s3.model.UploadPartResult extends com.amazonaws.services.s3.internal.SSEResultBase implements Serializable

      • Serialized Fields

        • eTag

          String eTag
          The entity tag generated from the content of the upload part
        • isRequesterCharged

          boolean isRequesterCharged
          Indicate if the requester is charged for conducting this operation from Requester Pays Buckets.
        • partNumber

          int partNumber
          The part number of the newly uploaded part
    • Class com.amazonaws.services.s3.model.VersionListing extends Object implements Serializable

      • Serialized Fields

        • bucketName

          String bucketName
          The name of the Amazon S3 bucket containing the listed versions
        • commonPrefixes

          List<String> commonPrefixes
          A list of the common prefixes included in this version listing - common prefixes will only be populated for requests that specified a delimiter
        • delimiter

          String delimiter
          The delimiter parameter originally specified by the caller when this version listing was returned
        • encodingType

          String encodingType
          The encodingType parameter originally specified by the caller when this version listing was returned.
        • isTruncated

          boolean isTruncated
          Indicates if this is a complete listing, or if the caller needs to make additional requests to Amazon S3 to see the full object listing for an S3 bucket
        • keyMarker

          String keyMarker
          The key marker parameter originally specified by the caller when this version listing was returned
        • maxKeys

          int maxKeys
          The maxKeys parameter originally specified by the caller when this version listing was returned
        • nextKeyMarker

          String nextKeyMarker
          The key marker to use in order to request the next page of results - only populated if the isTruncated member indicates that this version listing is truncated
        • nextVersionIdMarker

          String nextVersionIdMarker
          The version ID marker to use in order to request the next page of results - only populated if the isTruncated member indicates that this version listing is truncated
        • prefix

          String prefix
          The prefix parameter originally specified by the caller when this version listing was returned
        • versionIdMarker

          String versionIdMarker
          The version ID marker parameter originally specified by the caller when this version listing was returned
        • versionSummaries

          List<S3VersionSummary> versionSummaries
          A list of summary information describing the versions stored in the bucket
    • Class com.amazonaws.services.s3.model.WebsiteConfiguration extends Object implements Serializable

      • Serialized Fields

        • errorDocument

          String errorDocument
        • indexDocumentSuffix

          String indexDocumentSuffix
        • redirectAllRequestsTo

          String redirectAllRequestsTo
        • routingRules

          List<RoutingRule> routingRules
  • Package com.amazonaws.services.s3.transfer.exception

  • Package com.amazonaws.services.securitytoken.model

    • Class com.amazonaws.services.securitytoken.model.AssumedRoleUser extends Object implements Serializable

      • Serialized Fields

        • arn

          String arn

          The ARN of the temporary security credentials that are returned from the AssumeRole action. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.

        • assumedRoleId

          String assumedRoleId

          A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role ID is generated by AWS when the role is created.

    • Class com.amazonaws.services.securitytoken.model.AssumeRoleRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • durationSeconds

          Integer durationSeconds

          The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

        • externalId

          String externalId

          A unique identifier that is used by third parties when assuming roles in their customers' accounts. For each role that the third party can assume, they should instruct their customers to ensure the role's trust policy checks for the external ID that the third party generated. Each time the third party assumes the role, they should pass the customer's external ID. The external ID is useful in order to help third parties bind a role to the customer who created it. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide.

          The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:\/-

        • policy

          String policy

          An IAM policy in JSON format.

          This parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both (the intersection of) the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.

          The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.

          The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

        • roleArn

          String roleArn

          The Amazon Resource Name (ARN) of the role to assume.

        • roleSessionName

          String roleSessionName

          An identifier for the assumed role session.

          Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests using the temporary security credentials will expose the role session name to the external account in their CloudTrail logs.

          The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

        • serialNumber

          String serialNumber

          The identification number of the MFA device that is associated with the user who is making the AssumeRole call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user).

          The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

        • tokenCode

          String tokenCode

          The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the TokenCode value is missing or expired, the AssumeRole call returns an "access denied" error.

          The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

    • Class com.amazonaws.services.securitytoken.model.AssumeRoleResult extends Object implements Serializable

      • Serialized Fields

        • assumedRoleUser

          AssumedRoleUser assumedRoleUser

          The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.

        • credentials

          Credentials credentials

          The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

          Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

        • packedPolicySize

          Integer packedPolicySize

          A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

    • Class com.amazonaws.services.securitytoken.model.AssumeRoleWithSAMLRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • durationSeconds

          Integer durationSeconds

          The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds. An expiration can also be specified in the SAML authentication response's SessionNotOnOrAfter value. The actual expiration time is whichever value is shorter.

          The maximum duration for a session is 1 hour, and the minimum duration is 15 minutes, even if values outside this range are specified.

        • policy

          String policy

          An IAM policy in JSON format.

          The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, Permissions for AssumeRole, AssumeRoleWithSAML, and AssumeRoleWithWebIdentity in the IAM User Guide.

          The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.

          The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

        • principalArn

          String principalArn

          The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

        • roleArn

          String roleArn

          The Amazon Resource Name (ARN) of the role that the caller is assuming.

        • sAMLAssertion

          String sAMLAssertion

          The base-64 encoded SAML authentication response provided by the IdP.

          For more information, see Configuring a Relying Party and Adding Claims in the Using IAM guide.

    • Class com.amazonaws.services.securitytoken.model.AssumeRoleWithSAMLResult extends Object implements Serializable

      • Serialized Fields

        • assumedRoleUser

          AssumedRoleUser assumedRoleUser

          The identifiers for the temporary security credentials that the operation returns.

        • audience

          String audience

          The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.

        • credentials

          Credentials credentials

          The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

          Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

        • issuer

          String issuer

          The value of the Issuer element of the SAML assertion.

        • nameQualifier

          String nameQualifier

          A hash value based on the concatenation of the Issuer response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM. The combination of NameQualifier and Subject can be used to uniquely identify a federated user.

          The following pseudocode shows how the hash value is calculated:

          BASE64 ( SHA1 ( "https://example.com/saml" + "123456789012" + "/MySAMLIdP" ) )

        • packedPolicySize

          Integer packedPolicySize

          A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

        • subject

          String subject

          The value of the NameID element in the Subject element of the SAML assertion.

        • subjectType

          String subjectType

          The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion. Typical examples of the format are transient or persistent.

          If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If the format includes any other prefix, the format is returned with no modifications.

    • Class com.amazonaws.services.securitytoken.model.AssumeRoleWithWebIdentityRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • durationSeconds

          Integer durationSeconds

          The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set to 3600 seconds.

        • policy

          String policy

          An IAM policy in JSON format.

          The policy parameter is optional. If you pass a policy, the temporary security credentials that are returned by the operation have the permissions that are allowed by both the access policy of the role that is being assumed, and the policy that you pass. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use the passed policy to grant permissions that are in excess of those allowed by the access policy of the role that is being assumed. For more information, see Permissions for AssumeRoleWithWebIdentity in the IAM User Guide.

          The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.

          The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

        • providerId

          String providerId

          The fully qualified host component of the domain name of the identity provider.

          Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com and graph.facebook.com are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.

          Do not specify this value for OpenID Connect ID tokens.

        • roleArn

          String roleArn

          The Amazon Resource Name (ARN) of the role that the caller is assuming.

        • roleSessionName

          String roleSessionName

          An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the AssumedRoleUser response element.

          The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

        • webIdentityToken

          String webIdentityToken

          The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an AssumeRoleWithWebIdentity call.

    • Class com.amazonaws.services.securitytoken.model.AssumeRoleWithWebIdentityResult extends Object implements Serializable

      • Serialized Fields

        • assumedRoleUser

          AssumedRoleUser assumedRoleUser

          The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.

        • audience

          String audience

          The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.

        • credentials

          Credentials credentials

          The temporary security credentials, which include an access key ID, a secret access key, and a security token.

          Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

        • packedPolicySize

          Integer packedPolicySize

          A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

        • provider

          String provider

          The issuing authority of the web identity token presented. For OpenID Connect ID Tokens this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.

        • subjectFromWebIdentityToken

          String subjectFromWebIdentityToken

          The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim.

    • Class com.amazonaws.services.securitytoken.model.Credentials extends Object implements Serializable

      • Serialized Fields

        • accessKeyId

          String accessKeyId

          The access key ID that identifies the temporary security credentials.

        • expiration

          Date expiration

          The date on which the current credentials expire.

        • secretAccessKey

          String secretAccessKey

          The secret access key that can be used to sign requests.

        • sessionToken

          String sessionToken

          The token that users must pass to the service API to use the temporary credentials.

    • Class com.amazonaws.services.securitytoken.model.DecodeAuthorizationMessageRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • encodedMessage

          String encodedMessage

          The encoded message that was returned with the response.

    • Class com.amazonaws.services.securitytoken.model.DecodeAuthorizationMessageResult extends Object implements Serializable

      • Serialized Fields

        • decodedMessage

          String decodedMessage

          An XML document that contains the decoded message.

    • Class com.amazonaws.services.securitytoken.model.ExpiredTokenException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.securitytoken.model.FederatedUser extends Object implements Serializable

      • Serialized Fields

        • arn

          String arn

          The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.

        • federatedUserId

          String federatedUserId

          The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.

    • Class com.amazonaws.services.securitytoken.model.GetCallerIdentityRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.securitytoken.model.GetCallerIdentityResult extends Object implements Serializable

      • Serialized Fields

        • account

          String account

          The AWS account ID number of the account that owns or contains the calling entity.

        • arn

          String arn

          The AWS ARN associated with the calling entity.

        • userId

          String userId

          The unique identifier of the calling entity. The exact value depends on the type of entity making the call. The values returned are those listed in the aws:userid column in the Principal table found on the Policy Variables reference page in the IAM User Guide.

    • Class com.amazonaws.services.securitytoken.model.GetFederationTokenRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • durationSeconds

          Integer durationSeconds

          The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions obtained using AWS account (root) credentials are restricted to a maximum of 3600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using AWS account (root) credentials defaults to one hour.

        • name

          String name

          The name of the federated user. The name is used as an identifier for the temporary security credentials (such as Bob). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.

          The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

        • policy

          String policy

          An IAM policy in JSON format that is passed with the GetFederationToken call and evaluated along with the policy or policies that are attached to the IAM user whose credentials are used to call GetFederationToken. The passed policy is used to scope down the permissions that are available to the IAM user, by allowing only a subset of the permissions that are granted to the IAM user. The passed policy cannot grant more permissions than those granted to the IAM user. The final permissions for the federated user are the most restrictive set based on the intersection of the passed policy and the IAM user policy.

          If you do not pass a policy, the resulting temporary security credentials have no effective permissions. The only exception is when the temporary security credentials are used to access a resource that has a resource-based policy that specifically allows the federated user to access the resource.

          The format for this parameter, as described by its regex pattern, is a string of characters up to 2048 characters in length. The characters can be any ASCII character from the space character to the end of the valid character list ( -ÿ). It can also include the tab ( ), linefeed ( ), and carriage return ( ) characters.

          The policy plain text must be 2048 bytes or shorter. However, an internal conversion compresses it into a packed binary format with a separate limit. The PackedPolicySize response element indicates by percentage how close to the upper size limit the policy is, with 100% equaling the maximum allowed size.

          For more information about how permissions work, see Permissions for GetFederationToken.

    • Class com.amazonaws.services.securitytoken.model.GetFederationTokenResult extends Object implements Serializable

      • Serialized Fields

        • credentials

          Credentials credentials

          The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

          Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

        • federatedUser

          FederatedUser federatedUser

          Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.

        • packedPolicySize

          Integer packedPolicySize

          A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.

    • Class com.amazonaws.services.securitytoken.model.GetSessionTokenRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • durationSeconds

          Integer durationSeconds

          The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129600 seconds (36 hours), with 43200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.

        • serialNumber

          String serialNumber

          The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.

          The format for this parameter, as described by its regex pattern, is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

        • tokenCode

          String tokenCode

          The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, and the user does not provide a code when requesting a set of temporary security credentials, the user will receive an "access denied" response when requesting resources that require MFA authentication.

          The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

    • Class com.amazonaws.services.securitytoken.model.GetSessionTokenResult extends Object implements Serializable

      • Serialized Fields

        • credentials

          Credentials credentials

          The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

          Note: The size of the security token that STS APIs return is not fixed. We strongly recommend that you make no assumptions about the maximum size. As of this writing, the typical size is less than 4096 bytes, but that can vary. Also, future updates to AWS might require larger sizes.

    • Class com.amazonaws.services.securitytoken.model.IDPCommunicationErrorException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.securitytoken.model.IDPRejectedClaimException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.securitytoken.model.InvalidAuthorizationMessageException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.securitytoken.model.InvalidIdentityTokenException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.securitytoken.model.MalformedPolicyDocumentException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.securitytoken.model.PackedPolicyTooLargeException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.securitytoken.model.RegionDisabledException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
  • Package com.amazonaws.services.simpledb.model

  • Package com.amazonaws.services.simpleemail.model

  • Package com.amazonaws.services.simplesystemsmanagement.model

  • Package com.amazonaws.services.simpleworkflow.model

    • Class com.amazonaws.services.simpleworkflow.model.ActivityTask extends Object implements Serializable

      • Serialized Fields

        • activityId

          String activityId

          The unique ID of the task.

        • activityType

          ActivityType activityType

          The type of this activity task.

        • input

          String input

          The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.

        • startedEventId

          Long startedEventId

          The ID of the ActivityTaskStarted event recorded in the history.

        • taskToken

          String taskToken

          The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

        • workflowExecution

          WorkflowExecution workflowExecution

          The workflow execution that started this activity task.

    • Class com.amazonaws.services.simpleworkflow.model.ActivityTaskCanceledEventAttributes extends Object implements Serializable

      • Serialized Fields

        • details

          String details

          Details of the cancellation (if any).

        • latestCancelRequestedEventId

          Long latestCancelRequestedEventId

          If set, contains the ID of the last ActivityTaskCancelRequested event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • scheduledEventId

          Long scheduledEventId

          The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startedEventId

          Long startedEventId

          The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • Class com.amazonaws.services.simpleworkflow.model.ActivityTaskCancelRequestedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • activityId

          String activityId

          The unique ID of the task.

        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • Class com.amazonaws.services.simpleworkflow.model.ActivityTaskCompletedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • result

          String result

          The results of the activity task (if any).

        • scheduledEventId

          Long scheduledEventId

          The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startedEventId

          Long startedEventId

          The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • Class com.amazonaws.services.simpleworkflow.model.ActivityTaskFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • details

          String details

          The details of the failure (if any).

        • reason

          String reason

          The reason provided for the failure (if any).

        • scheduledEventId

          Long scheduledEventId

          The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startedEventId

          Long startedEventId

          The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • Class com.amazonaws.services.simpleworkflow.model.ActivityTaskScheduledEventAttributes extends Object implements Serializable

      • Serialized Fields

        • activityId

          String activityId

          The unique ID of the activity task.

        • activityType

          ActivityType activityType

          The type of the activity task.

        • control

          String control

          Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.

        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • heartbeatTimeout

          String heartbeatTimeout

          The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it will be ignored.

        • input

          String input

          The input provided to the activity task.

        • scheduleToCloseTimeout

          String scheduleToCloseTimeout

          The maximum amount of time for this activity task.

        • scheduleToStartTimeout

          String scheduleToStartTimeout

          The maximum amount of time the activity task can wait to be assigned to a worker.

        • startToCloseTimeout

          String startToCloseTimeout

          The maximum amount of time a worker may take to process the activity task.

        • taskList

          TaskList taskList

          The task list in which the activity task has been scheduled.

        • taskPriority

          String taskPriority

          Optional. The priority to assign to the scheduled activity task. If set, this will override any default priority value that was assigned when the activity type was registered.

          Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

    • Class com.amazonaws.services.simpleworkflow.model.ActivityTaskStartedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • identity

          String identity

          Identity of the worker that was assigned this task. This aids diagnostics when problems arise. The form of this identity is user defined.

        • scheduledEventId

          Long scheduledEventId

          The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • Class com.amazonaws.services.simpleworkflow.model.ActivityTaskStatus extends Object implements Serializable

      • Serialized Fields

        • cancelRequested

          Boolean cancelRequested

          Set to true if cancellation of the task is requested.

    • Class com.amazonaws.services.simpleworkflow.model.ActivityTaskTimedOutEventAttributes extends Object implements Serializable

      • Serialized Fields

        • details

          String details

          Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat.

        • scheduledEventId

          Long scheduledEventId

          The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startedEventId

          Long startedEventId

          The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • timeoutType

          String timeoutType

          The type of the timeout that caused this event.

    • Class com.amazonaws.services.simpleworkflow.model.ActivityType extends Object implements Serializable

      • Serialized Fields

        • name

          String name

          The name of this activity.

          The combination of activity type name and version must be unique within a domain.
        • version

          String version

          The version of this activity.

          The combination of activity type name and version must be unique with in a domain.
    • Class com.amazonaws.services.simpleworkflow.model.ActivityTypeConfiguration extends Object implements Serializable

      • Serialized Fields

        • defaultTaskHeartbeatTimeout

          String defaultTaskHeartbeatTimeout

          Optional. The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.

          You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • defaultTaskList

          TaskList defaultTaskList

          Optional. The default task list specified for this activity type at registration. This default is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask decision.

        • defaultTaskPriority

          String defaultTaskPriority

          Optional. The default task priority for tasks of this activity type, specified at registration. If not set, then "0" will be used as the default priority. This default can be overridden when scheduling an activity task.

          Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

        • defaultTaskScheduleToCloseTimeout

          String defaultTaskScheduleToCloseTimeout

          Optional. The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask decision.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • defaultTaskScheduleToStartTimeout

          String defaultTaskScheduleToStartTimeout

          Optional. The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask decision.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • defaultTaskStartToCloseTimeout

          String defaultTaskStartToCloseTimeout

          Optional. The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask decision.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

    • Class com.amazonaws.services.simpleworkflow.model.ActivityTypeDetail extends Object implements Serializable

      • Serialized Fields

        • configuration

          ActivityTypeConfiguration configuration

          The configuration settings registered with the activity type.

        • typeInfo

          ActivityTypeInfo typeInfo

          General information about the activity type.

          The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.

          • REGISTERED: The type is registered and available. Workers supporting this type should be running.
          • DEPRECATED: The type was deprecated using DeprecateActivityType, but is still in use. You should keep workers supporting this type running. You cannot create new tasks of this type.
    • Class com.amazonaws.services.simpleworkflow.model.ActivityTypeInfo extends Object implements Serializable

    • Class com.amazonaws.services.simpleworkflow.model.ActivityTypeInfos extends Object implements Serializable

      • Serialized Fields

        • nextPageToken

          String nextPageToken

          If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

          The configured maximumPageSize determines how many results can be returned in a single call.

        • typeInfos

          List<ActivityTypeInfo> typeInfos

          List of activity type information.

    • Class com.amazonaws.services.simpleworkflow.model.CancelTimerDecisionAttributes extends Object implements Serializable

      • Serialized Fields

        • timerId

          String timerId

          Required. The unique ID of the timer to cancel.

    • Class com.amazonaws.services.simpleworkflow.model.CancelTimerFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • cause

          String cause

          The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

          If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • timerId

          String timerId

          The timerId provided in the CancelTimer decision that failed.

    • Class com.amazonaws.services.simpleworkflow.model.CancelWorkflowExecutionDecisionAttributes extends Object implements Serializable

      • Serialized Fields

        • details

          String details

          Optional. details of the cancellation.

    • Class com.amazonaws.services.simpleworkflow.model.CancelWorkflowExecutionFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • cause

          String cause

          The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

          If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • Class com.amazonaws.services.simpleworkflow.model.ChildWorkflowExecutionCanceledEventAttributes extends Object implements Serializable

      • Serialized Fields

        • details

          String details

          Details of the cancellation (if provided).

        • initiatedEventId

          Long initiatedEventId

          The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startedEventId

          Long startedEventId

          The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • workflowExecution

          WorkflowExecution workflowExecution

          The child workflow execution that was canceled.

        • workflowType

          WorkflowType workflowType

          The type of the child workflow execution.

    • Class com.amazonaws.services.simpleworkflow.model.ChildWorkflowExecutionCompletedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • initiatedEventId

          Long initiatedEventId

          The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • result

          String result

          The result of the child workflow execution (if any).

        • startedEventId

          Long startedEventId

          The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • workflowExecution

          WorkflowExecution workflowExecution

          The child workflow execution that was completed.

        • workflowType

          WorkflowType workflowType

          The type of the child workflow execution.

    • Class com.amazonaws.services.simpleworkflow.model.ChildWorkflowExecutionFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • details

          String details

          The details of the failure (if provided).

        • initiatedEventId

          Long initiatedEventId

          The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • reason

          String reason

          The reason for the failure (if provided).

        • startedEventId

          Long startedEventId

          The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • workflowExecution

          WorkflowExecution workflowExecution

          The child workflow execution that failed.

        • workflowType

          WorkflowType workflowType

          The type of the child workflow execution.

    • Class com.amazonaws.services.simpleworkflow.model.ChildWorkflowExecutionStartedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • initiatedEventId

          Long initiatedEventId

          The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • workflowExecution

          WorkflowExecution workflowExecution

          The child workflow execution that was started.

        • workflowType

          WorkflowType workflowType

          The type of the child workflow execution.

    • Class com.amazonaws.services.simpleworkflow.model.ChildWorkflowExecutionTerminatedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • initiatedEventId

          Long initiatedEventId

          The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startedEventId

          Long startedEventId

          The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • workflowExecution

          WorkflowExecution workflowExecution

          The child workflow execution that was terminated.

        • workflowType

          WorkflowType workflowType

          The type of the child workflow execution.

    • Class com.amazonaws.services.simpleworkflow.model.ChildWorkflowExecutionTimedOutEventAttributes extends Object implements Serializable

      • Serialized Fields

        • initiatedEventId

          Long initiatedEventId

          The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startedEventId

          Long startedEventId

          The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • timeoutType

          String timeoutType

          The type of the timeout that caused the child workflow execution to time out.

        • workflowExecution

          WorkflowExecution workflowExecution

          The child workflow execution that timed out.

        • workflowType

          WorkflowType workflowType

          The type of the child workflow execution.

    • Class com.amazonaws.services.simpleworkflow.model.CloseStatusFilter extends Object implements Serializable

      • Serialized Fields

        • status

          String status

          Required. The close status that must match the close status of an execution for it to meet the criteria of this filter.

    • Class com.amazonaws.services.simpleworkflow.model.CompleteWorkflowExecutionDecisionAttributes extends Object implements Serializable

      • Serialized Fields

        • result

          String result

          The result of the workflow execution. The form of the result is implementation defined.

    • Class com.amazonaws.services.simpleworkflow.model.CompleteWorkflowExecutionFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • cause

          String cause

          The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

          If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • Class com.amazonaws.services.simpleworkflow.model.ContinueAsNewWorkflowExecutionDecisionAttributes extends Object implements Serializable

      • Serialized Fields

        • childPolicy

          String childPolicy

          If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

          The supported child policies are:

          • TERMINATE: the child executions will be terminated.
          • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
          • ABANDON: no action will be taken. The child executions will continue to run.
          A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.
        • executionStartToCloseTimeout

          String executionStartToCloseTimeout

          If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

          An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.
        • input

          String input

          The input provided to the new workflow execution.

        • lambdaRole

          String lambdaRole

          The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.

          In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field.
        • tagList

          List<String> tagList

          The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

        • taskList

          TaskList taskList
        • taskPriority

          String taskPriority

          Optional. The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

        • taskStartToCloseTimeout

          String taskStartToCloseTimeout

          Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

          A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.
        • workflowTypeVersion

          String workflowTypeVersion
    • Class com.amazonaws.services.simpleworkflow.model.ContinueAsNewWorkflowExecutionFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • cause

          String cause

          The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

          If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • Class com.amazonaws.services.simpleworkflow.model.CountClosedWorkflowExecutionsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • closeStatusFilter

          CloseStatusFilter closeStatusFilter

          If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED.

          closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
        • closeTimeFilter

          ExecutionTimeFilter closeTimeFilter

          If specified, only workflow executions that meet the close time criteria of the filter are counted.

          startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
        • domain

          String domain

          The name of the domain containing the workflow executions to count.

        • executionFilter

          WorkflowExecutionFilter executionFilter

          If specified, only workflow executions matching the WorkflowId in the filter are counted.

          closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
        • startTimeFilter

          ExecutionTimeFilter startTimeFilter

          If specified, only workflow executions that meet the start time criteria of the filter are counted.

          startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
        • tagFilter

          TagFilter tagFilter

          If specified, only executions that have a tag that matches the filter are counted.

          closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
        • typeFilter

          WorkflowTypeFilter typeFilter

          If specified, indicates the type of the workflow executions to be counted.

          closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
    • Class com.amazonaws.services.simpleworkflow.model.CountOpenWorkflowExecutionsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domain

          String domain

          The name of the domain containing the workflow executions to count.

        • executionFilter

          WorkflowExecutionFilter executionFilter

          If specified, only workflow executions matching the WorkflowId in the filter are counted.

          executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
        • startTimeFilter

          ExecutionTimeFilter startTimeFilter

          Specifies the start time criteria that workflow executions must meet in order to be counted.

        • tagFilter

          TagFilter tagFilter

          If specified, only executions that have a tag that matches the filter are counted.

          executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
        • typeFilter

          WorkflowTypeFilter typeFilter

          Specifies the type of the workflow executions to be counted.

          executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
    • Class com.amazonaws.services.simpleworkflow.model.CountPendingActivityTasksRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domain

          String domain

          The name of the domain that contains the task list.

        • taskList

          TaskList taskList

          The name of the task list.

    • Class com.amazonaws.services.simpleworkflow.model.CountPendingDecisionTasksRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domain

          String domain

          The name of the domain that contains the task list.

        • taskList

          TaskList taskList

          The name of the task list.

    • Class com.amazonaws.services.simpleworkflow.model.Decision extends Object implements Serializable

      • Serialized Fields

        • cancelTimerDecisionAttributes

          CancelTimerDecisionAttributes cancelTimerDecisionAttributes

          Provides details of the CancelTimer decision. It is not set for other decision types.

        • cancelWorkflowExecutionDecisionAttributes

          CancelWorkflowExecutionDecisionAttributes cancelWorkflowExecutionDecisionAttributes

          Provides details of the CancelWorkflowExecution decision. It is not set for other decision types.

        • completeWorkflowExecutionDecisionAttributes

          CompleteWorkflowExecutionDecisionAttributes completeWorkflowExecutionDecisionAttributes

          Provides details of the CompleteWorkflowExecution decision. It is not set for other decision types.

        • continueAsNewWorkflowExecutionDecisionAttributes

          ContinueAsNewWorkflowExecutionDecisionAttributes continueAsNewWorkflowExecutionDecisionAttributes

          Provides details of the ContinueAsNewWorkflowExecution decision. It is not set for other decision types.

        • decisionType

          String decisionType

          Specifies the type of the decision.

        • failWorkflowExecutionDecisionAttributes

          FailWorkflowExecutionDecisionAttributes failWorkflowExecutionDecisionAttributes

          Provides details of the FailWorkflowExecution decision. It is not set for other decision types.

        • recordMarkerDecisionAttributes

          RecordMarkerDecisionAttributes recordMarkerDecisionAttributes

          Provides details of the RecordMarker decision. It is not set for other decision types.

        • requestCancelActivityTaskDecisionAttributes

          RequestCancelActivityTaskDecisionAttributes requestCancelActivityTaskDecisionAttributes

          Provides details of the RequestCancelActivityTask decision. It is not set for other decision types.

        • requestCancelExternalWorkflowExecutionDecisionAttributes

          RequestCancelExternalWorkflowExecutionDecisionAttributes requestCancelExternalWorkflowExecutionDecisionAttributes

          Provides details of the RequestCancelExternalWorkflowExecution decision. It is not set for other decision types.

        • scheduleActivityTaskDecisionAttributes

          ScheduleActivityTaskDecisionAttributes scheduleActivityTaskDecisionAttributes

          Provides details of the ScheduleActivityTask decision. It is not set for other decision types.

        • scheduleLambdaFunctionDecisionAttributes

          ScheduleLambdaFunctionDecisionAttributes scheduleLambdaFunctionDecisionAttributes
        • signalExternalWorkflowExecutionDecisionAttributes

          SignalExternalWorkflowExecutionDecisionAttributes signalExternalWorkflowExecutionDecisionAttributes

          Provides details of the SignalExternalWorkflowExecution decision. It is not set for other decision types.

        • startChildWorkflowExecutionDecisionAttributes

          StartChildWorkflowExecutionDecisionAttributes startChildWorkflowExecutionDecisionAttributes

          Provides details of the StartChildWorkflowExecution decision. It is not set for other decision types.

        • startTimerDecisionAttributes

          StartTimerDecisionAttributes startTimerDecisionAttributes

          Provides details of the StartTimer decision. It is not set for other decision types.

    • Class com.amazonaws.services.simpleworkflow.model.DecisionTask extends Object implements Serializable

      • Serialized Fields

        • events

          List<HistoryEvent> events

          A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.

        • nextPageToken

          String nextPageToken

          If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

          The configured maximumPageSize determines how many results can be returned in a single call.

        • previousStartedEventId

          Long previousStartedEventId

          The ID of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider. This can be used to determine the events in the history new since the last decision task received by the decider.

        • startedEventId

          Long startedEventId

          The ID of the DecisionTaskStarted event recorded in the history.

        • taskToken

          String taskToken

          The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

        • workflowExecution

          WorkflowExecution workflowExecution

          The workflow execution for which this decision task was created.

        • workflowType

          WorkflowType workflowType

          The type of the workflow execution for which this decision task was created.

    • Class com.amazonaws.services.simpleworkflow.model.DecisionTaskCompletedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • executionContext

          String executionContext

          User defined context for the workflow execution.

        • scheduledEventId

          Long scheduledEventId

          The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startedEventId

          Long startedEventId

          The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • Class com.amazonaws.services.simpleworkflow.model.DecisionTaskScheduledEventAttributes extends Object implements Serializable

      • Serialized Fields

        • startToCloseTimeout

          String startToCloseTimeout

          The maximum duration for this decision task. The task is considered timed out if it does not completed within this duration.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • taskList

          TaskList taskList

          The name of the task list in which the decision task was scheduled.

        • taskPriority

          String taskPriority

          Optional. A task priority that, if set, specifies the priority for this decision task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

    • Class com.amazonaws.services.simpleworkflow.model.DecisionTaskStartedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • identity

          String identity

          Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

        • scheduledEventId

          Long scheduledEventId

          The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • Class com.amazonaws.services.simpleworkflow.model.DecisionTaskTimedOutEventAttributes extends Object implements Serializable

      • Serialized Fields

        • scheduledEventId

          Long scheduledEventId

          The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startedEventId

          Long startedEventId

          The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • timeoutType

          String timeoutType

          The type of timeout that expired before the decision task could be completed.

    • Class com.amazonaws.services.simpleworkflow.model.DefaultUndefinedException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.simpleworkflow.model.DeprecateActivityTypeRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • activityType

          ActivityType activityType

          The activity type to deprecate.

        • domain

          String domain

          The name of the domain in which the activity type is registered.

    • Class com.amazonaws.services.simpleworkflow.model.DeprecateDomainRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • name

          String name

          The name of the domain to deprecate.

    • Class com.amazonaws.services.simpleworkflow.model.DeprecateWorkflowTypeRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domain

          String domain

          The name of the domain in which the workflow type is registered.

        • workflowType

          WorkflowType workflowType

          The workflow type to deprecate.

    • Class com.amazonaws.services.simpleworkflow.model.DescribeActivityTypeRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • activityType

          ActivityType activityType

          The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.

        • domain

          String domain

          The name of the domain in which the activity type is registered.

    • Class com.amazonaws.services.simpleworkflow.model.DescribeDomainRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • name

          String name

          The name of the domain to describe.

    • Class com.amazonaws.services.simpleworkflow.model.DescribeWorkflowExecutionRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domain

          String domain

          The name of the domain containing the workflow execution.

        • execution

          WorkflowExecution execution

          The workflow execution to describe.

    • Class com.amazonaws.services.simpleworkflow.model.DescribeWorkflowTypeRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domain

          String domain

          The name of the domain in which this workflow type is registered.

        • workflowType

          WorkflowType workflowType

          The workflow type to describe.

    • Class com.amazonaws.services.simpleworkflow.model.DomainAlreadyExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.simpleworkflow.model.DomainConfiguration extends Object implements Serializable

      • Serialized Fields

        • workflowExecutionRetentionPeriodInDays

          String workflowExecutionRetentionPeriodInDays

          The retention period for workflow executions in this domain.

    • Class com.amazonaws.services.simpleworkflow.model.DomainDeprecatedException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.simpleworkflow.model.DomainDetail extends Object implements Serializable

    • Class com.amazonaws.services.simpleworkflow.model.DomainInfo extends Object implements Serializable

      • Serialized Fields

        • description

          String description

          The description of the domain provided through RegisterDomain.

        • name

          String name

          The name of the domain. This name is unique within the account.

        • status

          String status

          The status of the domain:

          • REGISTERED: The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.
          • DEPRECATED: The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.
    • Class com.amazonaws.services.simpleworkflow.model.DomainInfos extends Object implements Serializable

      • Serialized Fields

        • domainInfos

          List<DomainInfo> domainInfos

          A list of DomainInfo structures.

        • nextPageToken

          String nextPageToken

          If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

          The configured maximumPageSize determines how many results can be returned in a single call.

    • Class com.amazonaws.services.simpleworkflow.model.ExecutionTimeFilter extends Object implements Serializable

      • Serialized Fields

        • latestDate

          Date latestDate

          Specifies the latest start or close date and time to return.

        • oldestDate

          Date oldestDate

          Specifies the oldest start or close date and time to return.

    • Class com.amazonaws.services.simpleworkflow.model.ExternalWorkflowExecutionCancelRequestedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • initiatedEventId

          Long initiatedEventId

          The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • workflowExecution

          WorkflowExecution workflowExecution

          The external workflow execution to which the cancellation request was delivered.

    • Class com.amazonaws.services.simpleworkflow.model.ExternalWorkflowExecutionSignaledEventAttributes extends Object implements Serializable

      • Serialized Fields

        • initiatedEventId

          Long initiatedEventId

          The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • workflowExecution

          WorkflowExecution workflowExecution

          The external workflow execution that the signal was delivered to.

    • Class com.amazonaws.services.simpleworkflow.model.FailWorkflowExecutionDecisionAttributes extends Object implements Serializable

      • Serialized Fields

        • details

          String details

          Optional. Details of the failure.

        • reason

          String reason

          A descriptive reason for the failure that may help in diagnostics.

    • Class com.amazonaws.services.simpleworkflow.model.FailWorkflowExecutionFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • cause

          String cause

          The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

          If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • Class com.amazonaws.services.simpleworkflow.model.GetWorkflowExecutionHistoryRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domain

          String domain

          The name of the domain containing the workflow execution.

        • execution

          WorkflowExecution execution

          Specifies the workflow execution for which to return the history.

        • maximumPageSize

          Integer maximumPageSize

          The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

          This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

        • nextPageToken

          String nextPageToken

          If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

          The configured maximumPageSize determines how many results can be returned in a single call.

        • reverseOrder

          Boolean reverseOrder

          When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

    • Class com.amazonaws.services.simpleworkflow.model.History extends Object implements Serializable

      • Serialized Fields

        • events

          List<HistoryEvent> events

          The list of history events.

        • nextPageToken

          String nextPageToken

          If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

          The configured maximumPageSize determines how many results can be returned in a single call.

    • Class com.amazonaws.services.simpleworkflow.model.HistoryEvent extends Object implements Serializable

      • Serialized Fields

        • activityTaskCanceledEventAttributes

          ActivityTaskCanceledEventAttributes activityTaskCanceledEventAttributes

          If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It is not set for other event types.

        • activityTaskCancelRequestedEventAttributes

          ActivityTaskCancelRequestedEventAttributes activityTaskCancelRequestedEventAttributes

          If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.

        • activityTaskCompletedEventAttributes

          ActivityTaskCompletedEventAttributes activityTaskCompletedEventAttributes

          If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.

        • activityTaskFailedEventAttributes

          ActivityTaskFailedEventAttributes activityTaskFailedEventAttributes

          If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.

        • activityTaskScheduledEventAttributes

          ActivityTaskScheduledEventAttributes activityTaskScheduledEventAttributes

          If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.

        • activityTaskStartedEventAttributes

          ActivityTaskStartedEventAttributes activityTaskStartedEventAttributes

          If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.

        • activityTaskTimedOutEventAttributes

          ActivityTaskTimedOutEventAttributes activityTaskTimedOutEventAttributes

          If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.

        • cancelTimerFailedEventAttributes

          CancelTimerFailedEventAttributes cancelTimerFailedEventAttributes

          If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.

        • cancelWorkflowExecutionFailedEventAttributes

          CancelWorkflowExecutionFailedEventAttributes cancelWorkflowExecutionFailedEventAttributes

          If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

        • childWorkflowExecutionCanceledEventAttributes

          ChildWorkflowExecutionCanceledEventAttributes childWorkflowExecutionCanceledEventAttributes

          If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.

        • childWorkflowExecutionCompletedEventAttributes

          ChildWorkflowExecutionCompletedEventAttributes childWorkflowExecutionCompletedEventAttributes

          If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.

        • childWorkflowExecutionFailedEventAttributes

          ChildWorkflowExecutionFailedEventAttributes childWorkflowExecutionFailedEventAttributes

          If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

        • childWorkflowExecutionStartedEventAttributes

          ChildWorkflowExecutionStartedEventAttributes childWorkflowExecutionStartedEventAttributes

          If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.

        • childWorkflowExecutionTerminatedEventAttributes

          ChildWorkflowExecutionTerminatedEventAttributes childWorkflowExecutionTerminatedEventAttributes

          If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.

        • childWorkflowExecutionTimedOutEventAttributes

          ChildWorkflowExecutionTimedOutEventAttributes childWorkflowExecutionTimedOutEventAttributes

          If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.

        • completeWorkflowExecutionFailedEventAttributes

          CompleteWorkflowExecutionFailedEventAttributes completeWorkflowExecutionFailedEventAttributes

          If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

        • continueAsNewWorkflowExecutionFailedEventAttributes

          ContinueAsNewWorkflowExecutionFailedEventAttributes continueAsNewWorkflowExecutionFailedEventAttributes

          If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

        • decisionTaskCompletedEventAttributes

          DecisionTaskCompletedEventAttributes decisionTaskCompletedEventAttributes

          If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It is not set for other event types.

        • decisionTaskScheduledEventAttributes

          DecisionTaskScheduledEventAttributes decisionTaskScheduledEventAttributes

          If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It is not set for other event types.

        • decisionTaskStartedEventAttributes

          DecisionTaskStartedEventAttributes decisionTaskStartedEventAttributes

          If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It is not set for other event types.

        • decisionTaskTimedOutEventAttributes

          DecisionTaskTimedOutEventAttributes decisionTaskTimedOutEventAttributes

          If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.

        • eventId

          Long eventId

          The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history.

        • eventTimestamp

          Date eventTimestamp

          The date and time when the event occurred.

        • eventType

          String eventType

          The type of the history event.

        • externalWorkflowExecutionCancelRequestedEventAttributes

          ExternalWorkflowExecutionCancelRequestedEventAttributes externalWorkflowExecutionCancelRequestedEventAttributes

          If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.

        • externalWorkflowExecutionSignaledEventAttributes

          ExternalWorkflowExecutionSignaledEventAttributes externalWorkflowExecutionSignaledEventAttributes

          If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.

        • failWorkflowExecutionFailedEventAttributes

          FailWorkflowExecutionFailedEventAttributes failWorkflowExecutionFailedEventAttributes

          If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

        • lambdaFunctionCompletedEventAttributes

          LambdaFunctionCompletedEventAttributes lambdaFunctionCompletedEventAttributes
        • lambdaFunctionFailedEventAttributes

          LambdaFunctionFailedEventAttributes lambdaFunctionFailedEventAttributes
        • lambdaFunctionScheduledEventAttributes

          LambdaFunctionScheduledEventAttributes lambdaFunctionScheduledEventAttributes
        • lambdaFunctionStartedEventAttributes

          LambdaFunctionStartedEventAttributes lambdaFunctionStartedEventAttributes
        • lambdaFunctionTimedOutEventAttributes

          LambdaFunctionTimedOutEventAttributes lambdaFunctionTimedOutEventAttributes
        • markerRecordedEventAttributes

          MarkerRecordedEventAttributes markerRecordedEventAttributes

          If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It is not set for other event types.

        • recordMarkerFailedEventAttributes

          RecordMarkerFailedEventAttributes recordMarkerFailedEventAttributes

          If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.

        • requestCancelActivityTaskFailedEventAttributes

          RequestCancelActivityTaskFailedEventAttributes requestCancelActivityTaskFailedEventAttributes

          If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.

        • requestCancelExternalWorkflowExecutionFailedEventAttributes

          RequestCancelExternalWorkflowExecutionFailedEventAttributes requestCancelExternalWorkflowExecutionFailedEventAttributes

          If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

        • requestCancelExternalWorkflowExecutionInitiatedEventAttributes

          RequestCancelExternalWorkflowExecutionInitiatedEventAttributes requestCancelExternalWorkflowExecutionInitiatedEventAttributes

          If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.

        • scheduleActivityTaskFailedEventAttributes

          ScheduleActivityTaskFailedEventAttributes scheduleActivityTaskFailedEventAttributes

          If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It is not set for other event types.

        • scheduleLambdaFunctionFailedEventAttributes

          ScheduleLambdaFunctionFailedEventAttributes scheduleLambdaFunctionFailedEventAttributes
        • signalExternalWorkflowExecutionFailedEventAttributes

          SignalExternalWorkflowExecutionFailedEventAttributes signalExternalWorkflowExecutionFailedEventAttributes

          If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

        • signalExternalWorkflowExecutionInitiatedEventAttributes

          SignalExternalWorkflowExecutionInitiatedEventAttributes signalExternalWorkflowExecutionInitiatedEventAttributes

          If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.

        • startChildWorkflowExecutionFailedEventAttributes

          StartChildWorkflowExecutionFailedEventAttributes startChildWorkflowExecutionFailedEventAttributes

          If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

        • startChildWorkflowExecutionInitiatedEventAttributes

          StartChildWorkflowExecutionInitiatedEventAttributes startChildWorkflowExecutionInitiatedEventAttributes

          If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It is not set for other event types.

        • startLambdaFunctionFailedEventAttributes

          StartLambdaFunctionFailedEventAttributes startLambdaFunctionFailedEventAttributes
        • startTimerFailedEventAttributes

          StartTimerFailedEventAttributes startTimerFailedEventAttributes

          If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It is not set for other event types.

        • timerCanceledEventAttributes

          TimerCanceledEventAttributes timerCanceledEventAttributes

          If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It is not set for other event types.

        • timerFiredEventAttributes

          TimerFiredEventAttributes timerFiredEventAttributes

          If the event is of type TimerFired then this member is set and provides detailed information about the event. It is not set for other event types.

        • timerStartedEventAttributes

          TimerStartedEventAttributes timerStartedEventAttributes

          If the event is of type TimerStarted then this member is set and provides detailed information about the event. It is not set for other event types.

        • workflowExecutionCanceledEventAttributes

          WorkflowExecutionCanceledEventAttributes workflowExecutionCanceledEventAttributes

          If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It is not set for other event types.

        • workflowExecutionCancelRequestedEventAttributes

          WorkflowExecutionCancelRequestedEventAttributes workflowExecutionCancelRequestedEventAttributes

          If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It is not set for other event types.

        • workflowExecutionCompletedEventAttributes

          WorkflowExecutionCompletedEventAttributes workflowExecutionCompletedEventAttributes

          If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It is not set for other event types.

        • workflowExecutionContinuedAsNewEventAttributes

          WorkflowExecutionContinuedAsNewEventAttributes workflowExecutionContinuedAsNewEventAttributes

          If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It is not set for other event types.

        • workflowExecutionFailedEventAttributes

          WorkflowExecutionFailedEventAttributes workflowExecutionFailedEventAttributes

          If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It is not set for other event types.

        • workflowExecutionSignaledEventAttributes

          WorkflowExecutionSignaledEventAttributes workflowExecutionSignaledEventAttributes

          If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It is not set for other event types.

        • workflowExecutionStartedEventAttributes

          WorkflowExecutionStartedEventAttributes workflowExecutionStartedEventAttributes

          If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It is not set for other event types.

        • workflowExecutionTerminatedEventAttributes

          WorkflowExecutionTerminatedEventAttributes workflowExecutionTerminatedEventAttributes

          If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It is not set for other event types.

        • workflowExecutionTimedOutEventAttributes

          WorkflowExecutionTimedOutEventAttributes workflowExecutionTimedOutEventAttributes

          If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It is not set for other event types.

    • Class com.amazonaws.services.simpleworkflow.model.LambdaFunctionCompletedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • result

          String result

          The result of the function execution (if any).

        • scheduledEventId

          Long scheduledEventId

          The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startedEventId

          Long startedEventId

          The ID of the LambdaFunctionStarted event recorded in the history.

    • Class com.amazonaws.services.simpleworkflow.model.LambdaFunctionFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • details

          String details

          The details of the failure (if any).

        • reason

          String reason

          The reason provided for the failure (if any).

        • scheduledEventId

          Long scheduledEventId

          The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startedEventId

          Long startedEventId

          The ID of the LambdaFunctionStarted event recorded in the history.

    • Class com.amazonaws.services.simpleworkflow.model.LambdaFunctionScheduledEventAttributes extends Object implements Serializable

      • Serialized Fields

        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event for the decision that resulted in the scheduling of this AWS Lambda function. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • id

          String id

          The unique Amazon SWF ID for the AWS Lambda task.

        • input

          String input

          Input provided to the AWS Lambda function.

        • name

          String name

          The name of the scheduled AWS Lambda function.

        • startToCloseTimeout

          String startToCloseTimeout

          The maximum time, in seconds, that the AWS Lambda function can take to execute from start to close before it is marked as failed.

    • Class com.amazonaws.services.simpleworkflow.model.LambdaFunctionStartedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • scheduledEventId

          Long scheduledEventId

          The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • Class com.amazonaws.services.simpleworkflow.model.LambdaFunctionTimedOutEventAttributes extends Object implements Serializable

      • Serialized Fields

        • scheduledEventId

          Long scheduledEventId

          The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startedEventId

          Long startedEventId

          The ID of the LambdaFunctionStarted event recorded in the history.

        • timeoutType

          String timeoutType

          The type of the timeout that caused this event.

    • Class com.amazonaws.services.simpleworkflow.model.LimitExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.simpleworkflow.model.ListActivityTypesRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domain

          String domain

          The name of the domain in which the activity types have been registered.

        • maximumPageSize

          Integer maximumPageSize

          The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

          This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

        • name

          String name

          If specified, only lists the activity types that have this name.

        • nextPageToken

          String nextPageToken

          If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

          The configured maximumPageSize determines how many results can be returned in a single call.

        • registrationStatus

          String registrationStatus

          Specifies the registration status of the activity types to list.

        • reverseOrder

          Boolean reverseOrder

          When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the activity types.

    • Class com.amazonaws.services.simpleworkflow.model.ListClosedWorkflowExecutionsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • closeStatusFilter

          CloseStatusFilter closeStatusFilter

          If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

          closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
        • closeTimeFilter

          ExecutionTimeFilter closeTimeFilter

          If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

          startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
        • domain

          String domain

          The name of the domain that contains the workflow executions to list.

        • executionFilter

          WorkflowExecutionFilter executionFilter

          If specified, only workflow executions matching the workflow ID specified in the filter are returned.

          closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
        • maximumPageSize

          Integer maximumPageSize

          The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

          This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

        • nextPageToken

          String nextPageToken

          If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

          The configured maximumPageSize determines how many results can be returned in a single call.

        • reverseOrder

          Boolean reverseOrder

          When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

        • startTimeFilter

          ExecutionTimeFilter startTimeFilter

          If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

          startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.
        • tagFilter

          TagFilter tagFilter

          If specified, only executions that have the matching tag are listed.

          closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
        • typeFilter

          WorkflowTypeFilter typeFilter

          If specified, only executions of the type specified in the filter are returned.

          closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
    • Class com.amazonaws.services.simpleworkflow.model.ListDomainsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • maximumPageSize

          Integer maximumPageSize

          The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

          This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

        • nextPageToken

          String nextPageToken

          If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

          The configured maximumPageSize determines how many results can be returned in a single call.

        • registrationStatus

          String registrationStatus

          Specifies the registration status of the domains to list.

        • reverseOrder

          Boolean reverseOrder

          When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

    • Class com.amazonaws.services.simpleworkflow.model.ListOpenWorkflowExecutionsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domain

          String domain

          The name of the domain that contains the workflow executions to list.

        • executionFilter

          WorkflowExecutionFilter executionFilter

          If specified, only workflow executions matching the workflow ID specified in the filter are returned.

          executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
        • maximumPageSize

          Integer maximumPageSize

          The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

          This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

        • nextPageToken

          String nextPageToken

          If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

          The configured maximumPageSize determines how many results can be returned in a single call.

        • reverseOrder

          Boolean reverseOrder

          When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.

        • startTimeFilter

          ExecutionTimeFilter startTimeFilter

          Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

        • tagFilter

          TagFilter tagFilter

          If specified, only executions that have the matching tag are listed.

          executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
        • typeFilter

          WorkflowTypeFilter typeFilter

          If specified, only executions of the type specified in the filter are returned.

          executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.
    • Class com.amazonaws.services.simpleworkflow.model.ListWorkflowTypesRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domain

          String domain

          The name of the domain in which the workflow types have been registered.

        • maximumPageSize

          Integer maximumPageSize

          The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

          This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

        • name

          String name

          If specified, lists the workflow type with this name.

        • nextPageToken

          String nextPageToken

          If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

          The configured maximumPageSize determines how many results can be returned in a single call.

        • registrationStatus

          String registrationStatus

          Specifies the registration status of the workflow types to list.

        • reverseOrder

          Boolean reverseOrder

          When set to true, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name of the workflow types.

    • Class com.amazonaws.services.simpleworkflow.model.MarkerRecordedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarker decision that requested this marker. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • details

          String details

          Details of the marker (if any).

        • markerName

          String markerName

          The name of the marker.

    • Class com.amazonaws.services.simpleworkflow.model.OperationNotPermittedException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.simpleworkflow.model.PendingTaskCount extends Object implements Serializable

      • Serialized Fields

        • count

          Integer count

          The number of tasks in the task list.

        • truncated

          Boolean truncated

          If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

    • Class com.amazonaws.services.simpleworkflow.model.PollForActivityTaskRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domain

          String domain

          The name of the domain that contains the task lists being polled.

        • identity

          String identity

          Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

        • taskList

          TaskList taskList

          Specifies the task list to poll for activity tasks.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

    • Class com.amazonaws.services.simpleworkflow.model.PollForDecisionTaskRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domain

          String domain

          The name of the domain containing the task lists to poll.

        • identity

          String identity

          Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

        • maximumPageSize

          Integer maximumPageSize

          The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.

          This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

        • nextPageToken

          String nextPageToken

          If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

          The configured maximumPageSize determines how many results can be returned in a single call.

          The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken will not return a new decision task..
        • reverseOrder

          Boolean reverseOrder

          When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events.

        • taskList

          TaskList taskList

          Specifies the task list to poll for decision tasks.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

    • Class com.amazonaws.services.simpleworkflow.model.RecordActivityTaskHeartbeatRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • details

          String details

          If specified, contains details about the progress of the task.

        • taskToken

          String taskToken

          The taskToken of the ActivityTask.

          taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
    • Class com.amazonaws.services.simpleworkflow.model.RecordMarkerDecisionAttributes extends Object implements Serializable

      • Serialized Fields

        • details

          String details

          Optional. details of the marker.

        • markerName

          String markerName

          Required. The name of the marker.

    • Class com.amazonaws.services.simpleworkflow.model.RecordMarkerFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • cause

          String cause

          The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

          If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarkerFailed decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • markerName

          String markerName

          The marker's name.

    • Class com.amazonaws.services.simpleworkflow.model.RegisterActivityTypeRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • defaultTaskHeartbeatTimeout

          String defaultTaskHeartbeatTimeout

          If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • defaultTaskList

          TaskList defaultTaskList

          If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask decision.

        • defaultTaskPriority

          String defaultTaskPriority

          The default task priority to assign to the activity type. If not assigned, then "0" will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

        • defaultTaskScheduleToCloseTimeout

          String defaultTaskScheduleToCloseTimeout

          If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • defaultTaskScheduleToStartTimeout

          String defaultTaskScheduleToStartTimeout

          If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • defaultTaskStartToCloseTimeout

          String defaultTaskStartToCloseTimeout

          If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask decision.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • description

          String description

          A textual description of the activity type.

        • domain

          String domain

          The name of the domain in which this activity is to be registered.

        • name

          String name

          The name of the activity type within the domain.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

        • version

          String version

          The version of the activity type.

          The activity type consists of the name and version, the combination of which must be unique within the domain.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

    • Class com.amazonaws.services.simpleworkflow.model.RegisterDomainRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • description

          String description

          A text description of the domain.

        • name

          String name

          Name of the domain to register. The name must be unique in the region that the domain is registered in.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

        • workflowExecutionRetentionPeriodInDays

          String workflowExecutionRetentionPeriodInDays

          The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution is not available in the results of visibility calls.

          If you pass the value NONE or 0 (zero), then the workflow execution history will not be retained. As soon as the workflow execution completes, the execution record and its history are deleted.

          The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.

    • Class com.amazonaws.services.simpleworkflow.model.RegisterWorkflowTypeRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • defaultChildPolicy

          String defaultChildPolicy

          If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

          The supported child policies are:

          • TERMINATE: the child executions will be terminated.
          • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
          • ABANDON: no action will be taken. The child executions will continue to run.
        • defaultExecutionStartToCloseTimeout

          String defaultExecutionStartToCloseTimeout

          If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution action or StartChildWorkflowExecution decision.

          The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit will always cause the workflow execution to time out.

        • defaultLambdaRole

          String defaultLambdaRole

          The ARN of the default IAM role to use when a workflow execution of this type invokes AWS Lambda functions.

          This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution and ContinueAsNewWorkflowExecution decision.

        • defaultTaskList

          TaskList defaultTaskList

          If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list is not provided when starting the execution through the StartWorkflowExecution action or StartChildWorkflowExecution decision.

        • defaultTaskPriority

          String defaultTaskPriority

          The default task priority to assign to the workflow type. If not assigned, then "0" will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

        • defaultTaskStartToCloseTimeout

          String defaultTaskStartToCloseTimeout

          If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • description

          String description

          Textual description of the workflow type.

        • domain

          String domain

          The name of the domain in which to register the workflow type.

        • name

          String name

          The name of the workflow type.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

        • version

          String version

          The version of the workflow type.

          The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

    • Class com.amazonaws.services.simpleworkflow.model.RequestCancelActivityTaskDecisionAttributes extends Object implements Serializable

      • Serialized Fields

        • activityId

          String activityId

          The activityId of the activity task to be canceled.

    • Class com.amazonaws.services.simpleworkflow.model.RequestCancelActivityTaskFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • activityId

          String activityId

          The activityId provided in the RequestCancelActivityTask decision that failed.

        • cause

          String cause

          The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

          If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • Class com.amazonaws.services.simpleworkflow.model.RequestCancelExternalWorkflowExecutionDecisionAttributes extends Object implements Serializable

      • Serialized Fields

        • control

          String control

          Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.

        • runId

          String runId

          The runId of the external workflow execution to cancel.

        • workflowId

          String workflowId

          Required. The workflowId of the external workflow execution to cancel.

    • Class com.amazonaws.services.simpleworkflow.model.RequestCancelExternalWorkflowExecutionFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • cause

          String cause

          The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

          If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
        • control

          String control
        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • initiatedEventId

          Long initiatedEventId

          The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • runId

          String runId

          The runId of the external workflow execution.

        • workflowId

          String workflowId

          The workflowId of the external workflow to which the cancel request was to be delivered.

    • Class com.amazonaws.services.simpleworkflow.model.RequestCancelExternalWorkflowExecutionInitiatedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • control

          String control

          Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.

        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • runId

          String runId

          The runId of the external workflow execution to be canceled.

        • workflowId

          String workflowId

          The workflowId of the external workflow execution to be canceled.

    • Class com.amazonaws.services.simpleworkflow.model.RequestCancelWorkflowExecutionRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domain

          String domain

          The name of the domain containing the workflow execution to cancel.

        • runId

          String runId

          The runId of the workflow execution to cancel.

        • workflowId

          String workflowId

          The workflowId of the workflow execution to cancel.

    • Class com.amazonaws.services.simpleworkflow.model.RespondActivityTaskCanceledRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • details

          String details

          Optional. Information about the cancellation.

        • taskToken

          String taskToken

          The taskToken of the ActivityTask.

          taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
    • Class com.amazonaws.services.simpleworkflow.model.RespondActivityTaskCompletedRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • result

          String result

          The result of the activity task. It is a free form string that is implementation specific.

        • taskToken

          String taskToken

          The taskToken of the ActivityTask.

          taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
    • Class com.amazonaws.services.simpleworkflow.model.RespondActivityTaskFailedRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • details

          String details

          Optional. Detailed information about the failure.

        • reason

          String reason

          Description of the error that may assist in diagnostics.

        • taskToken

          String taskToken

          The taskToken of the ActivityTask.

          taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
    • Class com.amazonaws.services.simpleworkflow.model.RespondDecisionTaskCompletedRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • decisions

          List<Decision> decisions

          The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the decision structure for details.

        • executionContext

          String executionContext

          User defined context to add to workflow execution.

        • taskToken

          String taskToken

          The taskToken from the DecisionTask.

          taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.
    • Class com.amazonaws.services.simpleworkflow.model.Run extends Object implements Serializable

      • Serialized Fields

        • runId

          String runId

          The runId of a workflow execution. This ID is generated by the service and can be used to uniquely identify the workflow execution within a domain.

    • Class com.amazonaws.services.simpleworkflow.model.ScheduleActivityTaskDecisionAttributes extends Object implements Serializable

      • Serialized Fields

        • activityId

          String activityId

          Required. The activityId of the activity task.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

        • activityType

          ActivityType activityType

          Required. The type of the activity task to schedule.

        • control

          String control

          Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.

        • heartbeatTimeout

          String heartbeatTimeout

          If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it will be ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • input

          String input

          The input provided to the activity task.

        • scheduleToCloseTimeout

          String scheduleToCloseTimeout

          The maximum duration for this activity task.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

          A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault will be returned.
        • scheduleToStartTimeout

          String scheduleToStartTimeout

          Optional. If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

          A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault will be returned.
        • startToCloseTimeout

          String startToCloseTimeout

          If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

          A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault will be returned.
        • taskList

          TaskList taskList

          If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type will be used.

          A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault will be returned.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

        • taskPriority

          String taskPriority

          Optional. If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

    • Class com.amazonaws.services.simpleworkflow.model.ScheduleActivityTaskFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • activityId

          String activityId

          The activityId provided in the ScheduleActivityTask decision that failed.

        • activityType

          ActivityType activityType

          The activity type provided in the ScheduleActivityTask decision that failed.

        • cause

          String cause

          The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

          If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • Class com.amazonaws.services.simpleworkflow.model.ScheduleLambdaFunctionDecisionAttributes extends Object implements Serializable

      • Serialized Fields

        • id

          String id

          Required. The SWF id of the AWS Lambda task.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

        • input

          String input

          The input provided to the AWS Lambda function.

        • name

          String name

          Required. The name of the AWS Lambda function to invoke.

        • startToCloseTimeout

          String startToCloseTimeout

          If set, specifies the maximum duration the function may take to execute.

    • Class com.amazonaws.services.simpleworkflow.model.ScheduleLambdaFunctionFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • cause

          String cause

          The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

          If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this AWS Lambda function. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • id

          String id

          The unique Amazon SWF ID of the AWS Lambda task.

        • name

          String name

          The name of the scheduled AWS Lambda function.

    • Class com.amazonaws.services.simpleworkflow.model.SignalExternalWorkflowExecutionDecisionAttributes extends Object implements Serializable

      • Serialized Fields

        • control

          String control

          Optional. Data attached to the event that can be used by the decider in subsequent decision tasks.

        • input

          String input

          Optional. Input data to be provided with the signal. The target workflow execution will use the signal name and input data to process the signal.

        • runId

          String runId

          The runId of the workflow execution to be signaled.

        • signalName

          String signalName

          Required. The name of the signal.The target workflow execution will use the signal name and input to process the signal.

        • workflowId

          String workflowId

          Required. The workflowId of the workflow execution to be signaled.

    • Class com.amazonaws.services.simpleworkflow.model.SignalExternalWorkflowExecutionFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • cause

          String cause

          The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

          If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
        • control

          String control
        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • initiatedEventId

          Long initiatedEventId

          The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • runId

          String runId

          The runId of the external workflow execution that the signal was being delivered to.

        • workflowId

          String workflowId

          The workflowId of the external workflow execution that the signal was being delivered to.

    • Class com.amazonaws.services.simpleworkflow.model.SignalExternalWorkflowExecutionInitiatedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • control

          String control

          Optional. data attached to the event that can be used by the decider in subsequent decision tasks.

        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • input

          String input

          Input provided to the signal (if any).

        • runId

          String runId

          The runId of the external workflow execution to send the signal to.

        • signalName

          String signalName

          The name of the signal.

        • workflowId

          String workflowId

          The workflowId of the external workflow execution.

    • Class com.amazonaws.services.simpleworkflow.model.SignalWorkflowExecutionRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • domain

          String domain

          The name of the domain containing the workflow execution to signal.

        • input

          String input

          Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.

        • runId

          String runId

          The runId of the workflow execution to signal.

        • signalName

          String signalName

          The name of the signal. This name must be meaningful to the target workflow.

        • workflowId

          String workflowId

          The workflowId of the workflow execution to signal.

    • Class com.amazonaws.services.simpleworkflow.model.StartChildWorkflowExecutionDecisionAttributes extends Object implements Serializable

      • Serialized Fields

        • childPolicy

          String childPolicy

          Optional. If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

          The supported child policies are:

          • TERMINATE: the child executions will be terminated.
          • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
          • ABANDON: no action will be taken. The child executions will continue to run.
          A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.
        • control

          String control

          Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the child workflow execution.

        • executionStartToCloseTimeout

          String executionStartToCloseTimeout

          The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

          An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault will be returned.
        • input

          String input

          The input to be provided to the workflow execution.

        • lambdaRole

          String lambdaRole

          The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.

          In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field.
        • tagList

          List<String> tagList

          The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

        • taskList

          TaskList taskList

          The name of the task list to be used for decision tasks of the child workflow execution.

          A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

        • taskPriority

          String taskPriority

          Optional. A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

        • taskStartToCloseTimeout

          String taskStartToCloseTimeout

          Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

          A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.
        • workflowId

          String workflowId

          Required. The workflowId of the workflow execution.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

        • workflowType

          WorkflowType workflowType

          Required. The type of the workflow execution to be started.

    • Class com.amazonaws.services.simpleworkflow.model.StartChildWorkflowExecutionFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • cause

          String cause

          The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

          If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
        • control

          String control
        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

        • initiatedEventId

          Long initiatedEventId

          The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • workflowId

          String workflowId

          The workflowId of the child workflow execution.

        • workflowType

          WorkflowType workflowType

          The workflow type provided in the StartChildWorkflowExecution decision that failed.

    • Class com.amazonaws.services.simpleworkflow.model.StartChildWorkflowExecutionInitiatedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • childPolicy

          String childPolicy

          The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

          The supported child policies are:

          • TERMINATE: the child executions will be terminated.
          • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
          • ABANDON: no action will be taken. The child executions will continue to run.
        • control

          String control

          Optional. Data attached to the event that can be used by the decider in subsequent decision tasks. This data is not sent to the activity.

        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

        • executionStartToCloseTimeout

          String executionStartToCloseTimeout

          The maximum duration for the child workflow execution. If the workflow execution is not closed within this duration, it will be timed out and force terminated.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • input

          String input

          The inputs provided to the child workflow execution (if any).

        • lambdaRole

          String lambdaRole

          The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.

        • tagList

          List<String> tagList

          The list of tags to associated with the child workflow execution.

        • taskList

          TaskList taskList

          The name of the task list used for the decision tasks of the child workflow execution.

        • taskPriority

          String taskPriority

          Optional. The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

        • taskStartToCloseTimeout

          String taskStartToCloseTimeout

          The maximum duration allowed for the decision tasks for this workflow execution.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • workflowId

          String workflowId

          The workflowId of the child workflow execution.

        • workflowType

          WorkflowType workflowType

          The type of the child workflow execution.

    • Class com.amazonaws.services.simpleworkflow.model.StartLambdaFunctionFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • cause

          String cause

          The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

          If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
        • message

          String message

          The error message (if any).

        • scheduledEventId

          Long scheduledEventId

          The ID of the LambdaFunctionScheduled event that was recorded when this AWS Lambda function was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • Class com.amazonaws.services.simpleworkflow.model.StartTimerDecisionAttributes extends Object implements Serializable

      • Serialized Fields

        • control

          String control

          Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.

        • startToFireTimeout

          String startToFireTimeout

          Required. The duration to wait before firing the timer.

          The duration is specified in seconds; an integer greater than or equal to 0.

        • timerId

          String timerId

          Required. The unique ID of the timer.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

    • Class com.amazonaws.services.simpleworkflow.model.StartTimerFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • cause

          String cause

          The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

          If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.
        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • timerId

          String timerId

          The timerId provided in the StartTimer decision that failed.

    • Class com.amazonaws.services.simpleworkflow.model.StartWorkflowExecutionRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • childPolicy

          String childPolicy

          If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

          The supported child policies are:

          • TERMINATE: the child executions will be terminated.
          • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
          • ABANDON: no action will be taken. The child executions will continue to run.
          A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.
        • domain

          String domain

          The name of the domain in which the workflow execution is created.

        • executionStartToCloseTimeout

          String executionStartToCloseTimeout

          The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

          The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit will cause the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for this timeout; there is a one-year max limit on the time that a workflow execution can run.

          An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.
        • input

          String input

          The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

        • lambdaRole

          String lambdaRole

          The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.

          In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field.
        • tagList

          List<String> tagList

          The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

        • taskList

          TaskList taskList

          The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

          A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

        • taskPriority

          String taskPriority

          The task priority to use for this workflow execution. This will override any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type will be used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

        • taskStartToCloseTimeout

          String taskStartToCloseTimeout

          Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

          A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.
        • workflowId

          String workflowId

          The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time.

          The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string quotarnquot.

        • workflowType

          WorkflowType workflowType

          The type of the workflow to start.

    • Class com.amazonaws.services.simpleworkflow.model.TagFilter extends Object implements Serializable

      • Serialized Fields

        • tag

          String tag

          Required. Specifies the tag that must be associated with the execution for it to meet the filter criteria.

    • Class com.amazonaws.services.simpleworkflow.model.TaskList extends Object implements Serializable

      • Serialized Fields

        • name

          String name

          The name of the task list.

    • Class com.amazonaws.services.simpleworkflow.model.TerminateWorkflowExecutionRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • childPolicy

          String childPolicy

          If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

          The supported child policies are:

          • TERMINATE: the child executions will be terminated.
          • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
          • ABANDON: no action will be taken. The child executions will continue to run.
          A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned.
        • details

          String details

          Optional. Details for terminating the workflow execution.

        • domain

          String domain

          The domain of the workflow execution to terminate.

        • reason

          String reason

          Optional. A descriptive reason for terminating the workflow execution.

        • runId

          String runId

          The runId of the workflow execution to terminate.

        • workflowId

          String workflowId

          The workflowId of the workflow execution to terminate.

    • Class com.amazonaws.services.simpleworkflow.model.TimerCanceledEventAttributes extends Object implements Serializable

      • Serialized Fields

        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startedEventId

          Long startedEventId

          The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • timerId

          String timerId

          The unique ID of the timer that was canceled.

    • Class com.amazonaws.services.simpleworkflow.model.TimerFiredEventAttributes extends Object implements Serializable

      • Serialized Fields

        • startedEventId

          Long startedEventId

          The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • timerId

          String timerId

          The unique ID of the timer that fired.

    • Class com.amazonaws.services.simpleworkflow.model.TimerStartedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • control

          String control

          Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.

        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • startToFireTimeout

          String startToFireTimeout

          The duration of time after which the timer will fire.

          The duration is specified in seconds; an integer greater than or equal to 0.

        • timerId

          String timerId

          The unique ID of the timer that was started.

    • Class com.amazonaws.services.simpleworkflow.model.TypeAlreadyExistsException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.simpleworkflow.model.TypeDeprecatedException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.simpleworkflow.model.UnknownResourceException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecution extends Object implements Serializable

      • Serialized Fields

        • runId

          String runId

          A system-generated unique identifier for the workflow execution.

        • workflowId

          String workflowId

          The user defined identifier associated with the workflow execution.

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionAlreadyStartedException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionCanceledEventAttributes extends Object implements Serializable

      • Serialized Fields

        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • details

          String details

          Details for the cancellation (if any).

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionCancelRequestedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • cause

          String cause

          If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.

        • externalInitiatedEventId

          Long externalInitiatedEventId

          The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • externalWorkflowExecution

          WorkflowExecution externalWorkflowExecution

          The external workflow execution for which the cancellation was requested.

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionCompletedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • result

          String result

          The result produced by the workflow execution upon successful completion.

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionConfiguration extends Object implements Serializable

      • Serialized Fields

        • childPolicy

          String childPolicy

          The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

          The supported child policies are:

          • TERMINATE: the child executions will be terminated.
          • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
          • ABANDON: no action will be taken. The child executions will continue to run.
        • executionStartToCloseTimeout

          String executionStartToCloseTimeout

          The total duration for this workflow execution.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • lambdaRole

          String lambdaRole

          The IAM role used by this workflow execution when invoking AWS Lambda functions.

        • taskList

          TaskList taskList

          The task list used for the decision tasks generated for this workflow execution.

        • taskPriority

          String taskPriority

          The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

        • taskStartToCloseTimeout

          String taskStartToCloseTimeout

          The maximum duration allowed for decision tasks for this workflow execution.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionContinuedAsNewEventAttributes extends Object implements Serializable

      • Serialized Fields

        • childPolicy

          String childPolicy

          The policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

          The supported child policies are:

          • TERMINATE: the child executions will be terminated.
          • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
          • ABANDON: no action will be taken. The child executions will continue to run.
        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • executionStartToCloseTimeout

          String executionStartToCloseTimeout

          The total duration allowed for the new workflow execution.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • input

          String input

          The input provided to the new workflow execution.

        • lambdaRole

          String lambdaRole

          The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.

        • newExecutionRunId

          String newExecutionRunId

          The runId of the new workflow execution.

        • tagList

          List<String> tagList

          The list of tags associated with the new workflow execution.

        • taskList

          TaskList taskList
        • taskPriority

          String taskPriority
        • taskStartToCloseTimeout

          String taskStartToCloseTimeout

          The maximum duration of decision tasks for the new workflow execution.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • workflowType

          WorkflowType workflowType
    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionCount extends Object implements Serializable

      • Serialized Fields

        • count

          Integer count

          The number of workflow executions.

        • truncated

          Boolean truncated

          If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionDetail extends Object implements Serializable

      • Serialized Fields

        • executionConfiguration

          WorkflowExecutionConfiguration executionConfiguration

          The configuration settings for this workflow execution including timeout values, tasklist etc.

        • executionInfo

          WorkflowExecutionInfo executionInfo

          Information about the workflow execution.

        • latestActivityTaskTimestamp

          Date latestActivityTaskTimestamp

          The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.

        • latestExecutionContext

          String latestExecutionContext

          The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.

        • openCounts

          WorkflowExecutionOpenCounts openCounts

          The number of tasks for this workflow execution. This includes open and closed tasks of all types.

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionFailedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • decisionTaskCompletedEventId

          Long decisionTaskCompletedEventId

          The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • details

          String details

          The details of the failure (if any).

        • reason

          String reason

          The descriptive reason provided for the failure (if any).

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionFilter extends Object implements Serializable

      • Serialized Fields

        • workflowId

          String workflowId

          The workflowId to pass of match the criteria of this filter.

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionInfo extends Object implements Serializable

      • Serialized Fields

        • cancelRequested

          Boolean cancelRequested

          Set to true if a cancellation is requested for this workflow execution.

        • closeStatus

          String closeStatus

          If the execution status is closed then this specifies how the execution was closed:

          • COMPLETED: the execution was successfully completed.
          • CANCELED: the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.
          • TERMINATED: the execution was force terminated.
          • FAILED: the execution failed to complete.
          • TIMED_OUT: the execution did not complete in the alloted time and was automatically timed out.
          • CONTINUED_AS_NEW: the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.
        • closeTimestamp

          Date closeTimestamp

          The time when the workflow execution was closed. Set only if the execution status is CLOSED.

        • execution

          WorkflowExecution execution

          The workflow execution this information is about.

        • executionStatus

          String executionStatus

          The current status of the execution.

        • parent

          WorkflowExecution parent

          If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

        • startTimestamp

          Date startTimestamp

          The time when the execution was started.

        • tagList

          List<String> tagList

          The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

        • workflowType

          WorkflowType workflowType

          The type of the workflow execution.

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionInfos extends Object implements Serializable

      • Serialized Fields

        • executionInfos

          List<WorkflowExecutionInfo> executionInfos

          The list of workflow information structures.

        • nextPageToken

          String nextPageToken

          If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

          The configured maximumPageSize determines how many results can be returned in a single call.

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionOpenCounts extends Object implements Serializable

      • Serialized Fields

        • openActivityTasks

          Integer openActivityTasks

          The count of activity tasks whose status is OPEN.

        • openChildWorkflowExecutions

          Integer openChildWorkflowExecutions

          The count of child workflow executions whose status is OPEN.

        • openDecisionTasks

          Integer openDecisionTasks

          The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task.

        • openLambdaFunctions

          Integer openLambdaFunctions

          The count of AWS Lambda functions that are currently executing.

        • openTimers

          Integer openTimers

          The count of timers started by this workflow execution that have not fired yet.

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionSignaledEventAttributes extends Object implements Serializable

      • Serialized Fields

        • externalInitiatedEventId

          Long externalInitiatedEventId

          The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflow decision to signal this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. This field is set only if the signal was initiated by another workflow execution.

        • externalWorkflowExecution

          WorkflowExecution externalWorkflowExecution

          The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.

        • input

          String input

          Inputs provided with the signal (if any). The decider can use the signal name and inputs to determine how to process the signal.

        • signalName

          String signalName

          The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionStartedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • childPolicy

          String childPolicy

          The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

          The supported child policies are:

          • TERMINATE: the child executions will be terminated.
          • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
          • ABANDON: no action will be taken. The child executions will continue to run.
        • continuedExecutionRunId

          String continuedExecutionRunId

          If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.

        • executionStartToCloseTimeout

          String executionStartToCloseTimeout

          The maximum duration for this workflow execution.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • input

          String input

          The input provided to the workflow execution (if any).

        • lambdaRole

          String lambdaRole

          The IAM role attached to this workflow execution to use when invoking AWS Lambda functions.

        • parentInitiatedEventId

          Long parentInitiatedEventId

          The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

        • parentWorkflowExecution

          WorkflowExecution parentWorkflowExecution

          The source workflow execution that started this workflow execution. The member is not set if the workflow execution was not started by a workflow.

        • tagList

          List<String> tagList

          The list of tags associated with this workflow execution. An execution can have up to 5 tags.

        • taskList

          TaskList taskList

          The name of the task list for scheduling the decision tasks for this workflow execution.

        • taskPriority

          String taskPriority
        • taskStartToCloseTimeout

          String taskStartToCloseTimeout

          The maximum duration of decision tasks for this workflow type.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • workflowType

          WorkflowType workflowType

          The workflow type of this execution.

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionTerminatedEventAttributes extends Object implements Serializable

      • Serialized Fields

        • cause

          String cause

          If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.

        • childPolicy

          String childPolicy

          The policy used for the child workflow executions of this workflow execution.

          The supported child policies are:

          • TERMINATE: the child executions will be terminated.
          • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
          • ABANDON: no action will be taken. The child executions will continue to run.
        • details

          String details

          The details provided for the termination (if any).

        • reason

          String reason

          The reason provided for the termination (if any).

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowExecutionTimedOutEventAttributes extends Object implements Serializable

      • Serialized Fields

        • childPolicy

          String childPolicy

          The policy used for the child workflow executions of this workflow execution.

          The supported child policies are:

          • TERMINATE: the child executions will be terminated.
          • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
          • ABANDON: no action will be taken. The child executions will continue to run.
        • timeoutType

          String timeoutType

          The type of timeout that caused this event.

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowType extends Object implements Serializable

      • Serialized Fields

        • name

          String name

          Required. The name of the workflow type.

          The combination of workflow type name and version must be unique with in a domain.
        • version

          String version

          Required. The version of the workflow type.

          The combination of workflow type name and version must be unique with in a domain.
    • Class com.amazonaws.services.simpleworkflow.model.WorkflowTypeConfiguration extends Object implements Serializable

      • Serialized Fields

        • defaultChildPolicy

          String defaultChildPolicy

          Optional. The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

          The supported child policies are:

          • TERMINATE: the child executions will be terminated.
          • REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
          • ABANDON: no action will be taken. The child executions will continue to run.
        • defaultExecutionStartToCloseTimeout

          String defaultExecutionStartToCloseTimeout

          Optional. The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

        • defaultLambdaRole

          String defaultLambdaRole

          The default IAM role to use when a workflow execution invokes a AWS Lambda function.

        • defaultTaskList

          TaskList defaultTaskList

          Optional. The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

        • defaultTaskPriority

          String defaultTaskPriority

          Optional. The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

          Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

          For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.

        • defaultTaskStartToCloseTimeout

          String defaultTaskStartToCloseTimeout

          Optional. The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task does not close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

          The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowTypeDetail extends Object implements Serializable

      • Serialized Fields

        • configuration

          WorkflowTypeConfiguration configuration

          Configuration settings of the workflow type registered through RegisterWorkflowType

        • typeInfo

          WorkflowTypeInfo typeInfo

          General information about the workflow type.

          The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.

          • REGISTERED: The type is registered and available. Workers supporting this type should be running.
          • DEPRECATED: The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type.
    • Class com.amazonaws.services.simpleworkflow.model.WorkflowTypeFilter extends Object implements Serializable

      • Serialized Fields

        • name

          String name

          Required. Name of the workflow type.

        • version

          String version

          Version of the workflow type.

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowTypeInfo extends Object implements Serializable

      • Serialized Fields

        • creationDate

          Date creationDate

          The date when this type was registered.

        • deprecationDate

          Date deprecationDate

          If the type is in deprecated state, then it is set to the date when the type was deprecated.

        • description

          String description

          The description of the type registered through RegisterWorkflowType.

        • status

          String status

          The current status of the workflow type.

        • workflowType

          WorkflowType workflowType

          The workflow type this information is about.

    • Class com.amazonaws.services.simpleworkflow.model.WorkflowTypeInfos extends Object implements Serializable

      • Serialized Fields

        • nextPageToken

          String nextPageToken

          If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

          The configured maximumPageSize determines how many results can be returned in a single call.

        • typeInfos

          List<WorkflowTypeInfo> typeInfos

          The list of workflow type information.

  • Package com.amazonaws.services.sns.model

  • Package com.amazonaws.services.sqs.model

  • Package com.amazonaws.services.storagegateway.model

  • Package com.amazonaws.services.support.model

  • Package com.amazonaws.services.waf.model

    • Class com.amazonaws.services.waf.model.ActivatedRule extends Object implements Serializable

      • Serialized Fields

        • action

          WafAction action

          Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

          • ALLOW: CloudFront responds with the requested object.
          • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.
          • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.
        • priority

          Integer priority

          Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

        • ruleId

          String ruleId

          The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

          RuleId is returned by CreateRule and by ListRules.

    • Class com.amazonaws.services.waf.model.ByteMatchSet extends Object implements Serializable

      • Serialized Fields

        • byteMatchSetId

          String byteMatchSetId

          The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

          ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

        • byteMatchTuples

          List<ByteMatchTuple> byteMatchTuples

          Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

        • name

          String name

          A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    • Class com.amazonaws.services.waf.model.ByteMatchSetSummary extends Object implements Serializable

      • Serialized Fields

        • byteMatchSetId

          String byteMatchSetId

          The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF.

          ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

        • name

          String name

          A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    • Class com.amazonaws.services.waf.model.ByteMatchSetUpdate extends Object implements Serializable

      • Serialized Fields

        • action

          String action

          Specifies whether to insert or delete a ByteMatchTuple.

        • byteMatchTuple

          ByteMatchTuple byteMatchTuple

          Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify DELETE for the value of Action, the ByteMatchTuple values must exactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet.

    • Class com.amazonaws.services.waf.model.ByteMatchTuple extends Object implements Serializable

      • Serialized Fields

        • fieldToMatch

          FieldToMatch fieldToMatch

          The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch.

        • positionalConstraint

          String positionalConstraint

          Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:

          CONTAINS

          The specified part of the web request must include the value of TargetString, but the location doesn't matter.

          CONTAINS_WORD

          The specified part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, which means one of the following:

          • TargetString exactly matches the value of the specified part of the web request, such as the value of a header.
          • TargetString is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot;.
          • TargetString is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example, ;BadBot.
          • TargetString is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, -BadBot;.

          EXACTLY

          The value of the specified part of the web request must exactly match the value of TargetString.

          STARTS_WITH

          The value of TargetString must appear at the beginning of the specified part of the web request.

          ENDS_WITH

          The value of TargetString must appear at the end of the specified part of the web request.

        • targetString

          ByteBuffer targetString

          The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.

          Valid values depend on the values that you specified for FieldToMatch:

          • HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header.
          • METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
          • QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character.
          • URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg.
          • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

          If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

          If you're using the AWS WAF API

          Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

          For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64 encoding and include the resulting value, QmFkQm90, in the value of TargetString.

          If you're using the AWS CLI or one of the AWS SDKs

          The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.

        • textTransformation

          String textTransformation

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match.

          CMD_LINE

          When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

          • Delete the following characters: \ " ' ^
          • Delete spaces before the following characters: / (
          • Replace the following characters with a space: , ;
          • Replace multiple spaces with one space
          • Convert uppercase letters (A-Z) to lowercase (a-z)

          COMPRESS_WHITE_SPACE

          Use this option to replace the following characters with a space character (decimal 32):

          • \f, formfeed, decimal 12
          • \t, tab, decimal 9
          • \n, newline, decimal 10
          • \r, carriage return, decimal 13
          • \v, vertical tab, decimal 11
          • non-breaking space, decimal 160

          COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

          HTML_ENTITY_DECODE

          Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

          • Replaces (ampersand)quot; with "
          • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
          • Replaces (ampersand)lt; with a "less than" symbol
          • Replaces (ampersand)gt; with >
          • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters
          • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

          LOWERCASE

          Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

          URL_DECODE

          Use this option to decode a URL-encoded value.

          NONE

          Specify NONE if you don't want to perform any text transformations.

    • Class com.amazonaws.services.waf.model.CreateByteMatchSetRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The value returned by the most recent call to GetChangeToken.

        • name

          String name

          A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    • Class com.amazonaws.services.waf.model.CreateByteMatchSetResult extends Object implements Serializable

      • Serialized Fields

        • byteMatchSet

          ByteMatchSet byteMatchSet

          A ByteMatchSet that contains no ByteMatchTuple objects.

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    • Class com.amazonaws.services.waf.model.CreateIPSetRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The value returned by the most recent call to GetChangeToken.

        • name

          String name

          A friendly name or description of the IPSet. You can't change Name after you create the IPSet.

    • Class com.amazonaws.services.waf.model.CreateIPSetResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the CreateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

        • iPSet

          IPSet iPSet

          The IPSet returned in the CreateIPSet response.

    • Class com.amazonaws.services.waf.model.CreateRuleRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The value returned by the most recent call to GetChangeToken.

        • metricName

          String metricName

          A friendly name or description for the metrics for this Rule . The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the Rule.

        • name

          String name

          A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

    • Class com.amazonaws.services.waf.model.CreateRuleResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the CreateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

        • rule

          Rule rule

          The Rule returned in the CreateRule response.

    • Class com.amazonaws.services.waf.model.CreateSizeConstraintSetRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The value returned by the most recent call to GetChangeToken.

        • name

          String name

          A friendly name or description of the SizeConstraintSet. You can't change Name after you create a SizeConstraintSet.

    • Class com.amazonaws.services.waf.model.CreateSizeConstraintSetResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the CreateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

        • sizeConstraintSet

          SizeConstraintSet sizeConstraintSet

          A SizeConstraintSet that contains no SizeConstraint objects.

    • Class com.amazonaws.services.waf.model.CreateSqlInjectionMatchSetRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The value returned by the most recent call to GetChangeToken.

        • name

          String name

          A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name after you create the SqlInjectionMatchSet.

    • Class com.amazonaws.services.waf.model.CreateSqlInjectionMatchSetResult extends Object implements Serializable

    • Class com.amazonaws.services.waf.model.CreateWebACLRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The value returned by the most recent call to GetChangeToken.

        • defaultAction

          WafAction defaultAction

          The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL.

        • metricName

          String metricName

          A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the WebACL.

        • name

          String name

          A friendly name or description of the WebACL. You can't change Name after you create the WebACL.

    • Class com.amazonaws.services.waf.model.CreateWebACLResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the CreateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

        • webACL

          WebACL webACL

          The WebACL returned in the CreateWebACL response.

    • Class com.amazonaws.services.waf.model.CreateXssMatchSetRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The value returned by the most recent call to GetChangeToken.

        • name

          String name

          A friendly name or description for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet.

    • Class com.amazonaws.services.waf.model.CreateXssMatchSetResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

        • xssMatchSet

          XssMatchSet xssMatchSet
    • Class com.amazonaws.services.waf.model.DeleteByteMatchSetRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.DeleteByteMatchSetResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    • Class com.amazonaws.services.waf.model.DeleteIPSetRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.DeleteIPSetResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the DeleteIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    • Class com.amazonaws.services.waf.model.DeleteRuleRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.DeleteRuleResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the DeleteRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    • Class com.amazonaws.services.waf.model.DeleteSizeConstraintSetRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.DeleteSizeConstraintSetResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    • Class com.amazonaws.services.waf.model.DeleteSqlInjectionMatchSetRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.DeleteSqlInjectionMatchSetResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    • Class com.amazonaws.services.waf.model.DeleteWebACLRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.DeleteWebACLResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the DeleteWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    • Class com.amazonaws.services.waf.model.DeleteXssMatchSetRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.DeleteXssMatchSetResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the DeleteXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    • Class com.amazonaws.services.waf.model.FieldToMatch extends Object implements Serializable

      • Serialized Fields

        • data

          String data

          When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. If the value of Type is any other value, omit Data.

          The name of the header is not case sensitive.

        • type

          String type

          The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

          • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.
          • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
          • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.
          • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
          • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.
    • Class com.amazonaws.services.waf.model.GetByteMatchSetRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.GetByteMatchSetResult extends Object implements Serializable

      • Serialized Fields

        • byteMatchSet

          ByteMatchSet byteMatchSet

          Information about the ByteMatchSet that you specified in the GetByteMatchSet request. For more information, see the following topics:

          • ByteMatchSet: Contains ByteMatchSetId, ByteMatchTuples, and Name
          • ByteMatchTuples: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple object contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation
          • FieldToMatch: Contains Data and Type
    • Class com.amazonaws.services.waf.model.GetChangeTokenRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.GetChangeTokenResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request.

    • Class com.amazonaws.services.waf.model.GetChangeTokenStatusRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The change token for which you want to get the status. This change token was previously returned in the GetChangeToken response.

    • Class com.amazonaws.services.waf.model.GetChangeTokenStatusResult extends Object implements Serializable

      • Serialized Fields

        • changeTokenStatus

          String changeTokenStatus

          The status of the change token.

    • Class com.amazonaws.services.waf.model.GetIPSetRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.GetIPSetResult extends Object implements Serializable

      • Serialized Fields

        • iPSet

          IPSet iPSet

          Information about the IPSet that you specified in the GetIPSet request. For more information, see the following topics:

          • IPSet: Contains IPSetDescriptors, IPSetId, and Name
          • IPSetDescriptors: Contains an array of IPSetDescriptor objects. Each IPSetDescriptor object contains Type and Value
    • Class com.amazonaws.services.waf.model.GetRuleRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.GetRuleResult extends Object implements Serializable

      • Serialized Fields

        • rule

          Rule rule

          Information about the Rule that you specified in the GetRule request. For more information, see the following topics:

          • Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId
          • Predicate: Each Predicate object contains DataId, Negated, and Type
    • Class com.amazonaws.services.waf.model.GetSampledRequestsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • maxItems

          Long maxItems

          The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

        • ruleId

          String ruleId

          RuleId is one of two values:

          • The RuleId of the Rule for which you want GetSampledRequests to return a sample of requests.
          • Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL.
        • timeWindow

          TimeWindow timeWindow

          The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. Specify the date and time in Unix time format (in seconds). You can specify any time range in the previous three hours.

        • webAclId

          String webAclId

          The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

    • Class com.amazonaws.services.waf.model.GetSampledRequestsResult extends Object implements Serializable

      • Serialized Fields

        • populationSize

          Long populationSize

          The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range.

        • sampledRequests

          List<SampledHTTPRequest> sampledRequests

          A complex type that contains detailed information about each of the requests in the sample.

        • timeWindow

          TimeWindow timeWindow

          Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests.

    • Class com.amazonaws.services.waf.model.GetSizeConstraintSetRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.GetSizeConstraintSetResult extends Object implements Serializable

      • Serialized Fields

        • sizeConstraintSet

          SizeConstraintSet sizeConstraintSet

          Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet request. For more information, see the following topics:

    • Class com.amazonaws.services.waf.model.GetSqlInjectionMatchSetRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.GetSqlInjectionMatchSetResult extends Object implements Serializable

      • Serialized Fields

    • Class com.amazonaws.services.waf.model.GetWebACLRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.GetWebACLResult extends Object implements Serializable

      • Serialized Fields

        • webACL

          WebACL webACL

          Information about the WebACL that you specified in the GetWebACL request. For more information, see the following topics:

          • WebACL: Contains DefaultAction, MetricName, Name, an array of Rule objects, and WebACLId
          • DefaultAction (Data type is WafAction): Contains Type
          • Rules: Contains an array of ActivatedRule objects, which contain Action, Priority, and RuleId
          • Action: Contains Type
    • Class com.amazonaws.services.waf.model.GetXssMatchSetRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.GetXssMatchSetResult extends Object implements Serializable

      • Serialized Fields

        • xssMatchSet

          XssMatchSet xssMatchSet

          Information about the XssMatchSet that you specified in the GetXssMatchSet request. For more information, see the following topics:

          • XssMatchSet: Contains Name, XssMatchSetId, and an array of XssMatchTuple objects
          • XssMatchTuple: Each XssMatchTuple object contains FieldToMatch and TextTransformation
          • FieldToMatch: Contains Data and Type
    • Class com.amazonaws.services.waf.model.HTTPHeader extends Object implements Serializable

      • Serialized Fields

        • name

          String name

          The name of one of the headers in the sampled web request.

        • value

          String value

          The value of one of the headers in the sampled web request.

    • Class com.amazonaws.services.waf.model.HTTPRequest extends Object implements Serializable

      • Serialized Fields

        • clientIP

          String clientIP

          The IP address that the request originated from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

          • c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request
          • x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request
        • country

          String country

          The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.

        • headers

          List<HTTPHeader> headers

          A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.

        • hTTPVersion

          String hTTPVersion

          The HTTP version specified in the sampled web request, for example, HTTP/1.1.

        • method

          String method

          The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

        • uRI

          String uRI

          The part of a web request that identifies the resource, for example, /images/daily-ad.jpg.

    • Class com.amazonaws.services.waf.model.IPSet extends Object implements Serializable

      • Serialized Fields

        • iPSetDescriptors

          List<IPSetDescriptor> iPSetDescriptors

          The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

          • c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request
          • x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request
        • iPSetId

          String iPSetId

          The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).

          IPSetId is returned by CreateIPSet and by ListIPSets.

        • name

          String name

          A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

    • Class com.amazonaws.services.waf.model.IPSetDescriptor extends Object implements Serializable

      • Serialized Fields

        • type

          String type

          Specify IPV4.

        • value

          String value

          Specify an IPv4 address by using CIDR notation. For example:

          • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
          • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

          AWS WAF supports only /8, /16, /24, and /32 IP addresses.

          For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

    • Class com.amazonaws.services.waf.model.IPSetSummary extends Object implements Serializable

      • Serialized Fields

        • iPSetId

          String iPSetId

          The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed information about an IPSet.

        • name

          String name

          A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

    • Class com.amazonaws.services.waf.model.IPSetUpdate extends Object implements Serializable

      • Serialized Fields

        • action

          String action

          Specifies whether to insert or delete an IP address with UpdateIPSet.

        • iPSetDescriptor

          IPSetDescriptor iPSetDescriptor

          The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from.

    • Class com.amazonaws.services.waf.model.ListByteMatchSetsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • limit

          Integer limit

          Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more ByteMatchSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ByteMatchSet objects.

        • nextMarker

          String nextMarker

          If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListByteMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets.

    • Class com.amazonaws.services.waf.model.ListByteMatchSetsResult extends Object implements Serializable

      • Serialized Fields

        • byteMatchSets

          List<ByteMatchSetSummary> byteMatchSets

          An array of ByteMatchSetSummary objects.

        • nextMarker

          String nextMarker

          If you have more ByteMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ByteMatchSet objects, submit another ListByteMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    • Class com.amazonaws.services.waf.model.ListIPSetsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • limit

          Integer limit

          Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have more IPSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of IPSet objects.

        • nextMarker

          String nextMarker

          If you specify a value for Limit and you have more IPSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of IPSets. For the second and subsequent ListIPSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets.

    • Class com.amazonaws.services.waf.model.ListIPSetsResult extends Object implements Serializable

      • Serialized Fields

        • iPSets

          List<IPSetSummary> iPSets

          An array of IPSetSummary objects.

        • nextMarker

          String nextMarker

          If you have more IPSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more IPSet objects, submit another ListIPSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    • Class com.amazonaws.services.waf.model.ListRulesRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • limit

          Integer limit

          Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

        • nextMarker

          String nextMarker

          If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

    • Class com.amazonaws.services.waf.model.ListRulesResult extends Object implements Serializable

      • Serialized Fields

        • nextMarker

          String nextMarker

          If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

        • rules

          List<RuleSummary> rules

          An array of RuleSummary objects.

    • Class com.amazonaws.services.waf.model.ListSizeConstraintSetsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • limit

          Integer limit

          Specifies the number of SizeConstraintSet objects that you want AWS WAF to return for this request. If you have more SizeConstraintSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of SizeConstraintSet objects.

        • nextMarker

          String nextMarker

          If you specify a value for Limit and you have more SizeConstraintSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SizeConstraintSets. For the second and subsequent ListSizeConstraintSets requests, specify the value of NextMarker from the previous response to get information about another batch of SizeConstraintSets .

    • Class com.amazonaws.services.waf.model.ListSizeConstraintSetsResult extends Object implements Serializable

      • Serialized Fields

        • nextMarker

          String nextMarker

          If you have more SizeConstraintSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SizeConstraintSet objects, submit another ListSizeConstraintSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

        • sizeConstraintSets

          List<SizeConstraintSetSummary> sizeConstraintSets

          An array of SizeConstraintSetSummary objects.

    • Class com.amazonaws.services.waf.model.ListSqlInjectionMatchSetsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • limit

          Integer limit

          Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If you have more SqlInjectionMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

        • nextMarker

          String nextMarker

          If you specify a value for Limit and you have more SqlInjectionMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SqlInjectionMatchSets. For the second and subsequent ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of SqlInjectionMatchSets.

    • Class com.amazonaws.services.waf.model.ListSqlInjectionMatchSetsResult extends Object implements Serializable

      • Serialized Fields

        • nextMarker

          String nextMarker

          If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

        • sqlInjectionMatchSets

          List<SqlInjectionMatchSetSummary> sqlInjectionMatchSets

          An array of SqlInjectionMatchSetSummary objects.

    • Class com.amazonaws.services.waf.model.ListWebACLsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • limit

          Integer limit

          Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have more WebACL objects than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of WebACL objects.

        • nextMarker

          String nextMarker

          If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of WebACL objects. For the second and subsequent ListWebACLs requests, specify the value of NextMarker from the previous response to get information about another batch of WebACL objects.

    • Class com.amazonaws.services.waf.model.ListWebACLsResult extends Object implements Serializable

      • Serialized Fields

        • nextMarker

          String nextMarker

          If you have more WebACL objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more WebACL objects, submit another ListWebACLs request, and specify the NextMarker value from the response in the NextMarker value in the next request.

        • webACLs

          List<WebACLSummary> webACLs

          An array of WebACLSummary objects.

    • Class com.amazonaws.services.waf.model.ListXssMatchSetsRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • limit

          Integer limit

          Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more XssMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

        • nextMarker

          String nextMarker

          If you specify a value for Limit and you have more XssMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of XssMatchSets.

    • Class com.amazonaws.services.waf.model.ListXssMatchSetsResult extends Object implements Serializable

      • Serialized Fields

        • nextMarker

          String nextMarker

          If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

        • xssMatchSets

          List<XssMatchSetSummary> xssMatchSets

          An array of XssMatchSetSummary objects.

    • Class com.amazonaws.services.waf.model.Predicate extends Object implements Serializable

      • Serialized Fields

        • dataId

          String dataId

          A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

        • negated

          Boolean negated

          Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

          Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

        • type

          String type

          The type of predicate in a Rule, such as ByteMatchSet or IPSet.

    • Class com.amazonaws.services.waf.model.Rule extends Object implements Serializable

      • Serialized Fields

        • metricName

          String metricName
        • name

          String name

          The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

        • predicates

          List<Predicate> predicates

          The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

        • ruleId

          String ruleId

          A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

          RuleId is returned by CreateRule and by ListRules.

    • Class com.amazonaws.services.waf.model.RuleSummary extends Object implements Serializable

      • Serialized Fields

        • name

          String name

          A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

        • ruleId

          String ruleId

          A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

          RuleId is returned by CreateRule and by ListRules.

    • Class com.amazonaws.services.waf.model.RuleUpdate extends Object implements Serializable

      • Serialized Fields

        • action

          String action

          Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate from a Rule.

        • predicate

          Predicate predicate

          The ID of the Predicate (such as an IPSet) that you want to add to a Rule.

    • Class com.amazonaws.services.waf.model.SampledHTTPRequest extends Object implements Serializable

      • Serialized Fields

        • action

          String action

          The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT.

        • request

          HTTPRequest request

          A complex type that contains detailed information about the request.

        • timestamp

          Date timestamp

          The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

        • weight

          Long weight

          A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2 represents roughly twice as many CloudFront web requests as a result that has a weight of 1.

    • Class com.amazonaws.services.waf.model.SizeConstraint extends Object implements Serializable

      • Serialized Fields

        • comparisonOperator

          String comparisonOperator

          The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of " Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.

          EQ: Used to test if the Size is equal to the size of the FieldToMatch

          NE: Used to test if the Size is not equal to the size of the FieldToMatch

          LE: Used to test if the Size is less than or equal to the size of the FieldToMatch

          LT: Used to test if the Size is strictly less than the size of the FieldToMatch

          GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch

          GT: Used to test if the Size is strictly greater than the size of the FieldToMatch

        • fieldToMatch

          FieldToMatch fieldToMatch
        • size

          Long size

          The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.

          Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).

          If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

        • textTransformation

          String textTransformation

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

          Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection.

          NONE

          Specify NONE if you don't want to perform any text transformations.

          CMD_LINE

          When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

          • Delete the following characters: \ " ' ^
          • Delete spaces before the following characters: / (
          • Replace the following characters with a space: , ;
          • Replace multiple spaces with one space
          • Convert uppercase letters (A-Z) to lowercase (a-z)

          COMPRESS_WHITE_SPACE

          Use this option to replace the following characters with a space character (decimal 32):

          • \f, formfeed, decimal 12
          • \t, tab, decimal 9
          • \n, newline, decimal 10
          • \r, carriage return, decimal 13
          • \v, vertical tab, decimal 11
          • non-breaking space, decimal 160

          COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

          HTML_ENTITY_DECODE

          Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

          • Replaces (ampersand)quot; with "
          • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
          • Replaces (ampersand)lt; with a "less than" symbol
          • Replaces (ampersand)gt; with >
          • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters
          • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

          LOWERCASE

          Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

          URL_DECODE

          Use this option to decode a URL-encoded value.

    • Class com.amazonaws.services.waf.model.SizeConstraintSet extends Object implements Serializable

    • Class com.amazonaws.services.waf.model.SizeConstraintSetSummary extends Object implements Serializable

    • Class com.amazonaws.services.waf.model.SizeConstraintSetUpdate extends Object implements Serializable

      • Serialized Fields

        • action

          String action

          Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet.

        • sizeConstraint

          SizeConstraint sizeConstraint

          Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of " Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.

    • Class com.amazonaws.services.waf.model.SqlInjectionMatchSet extends Object implements Serializable

    • Class com.amazonaws.services.waf.model.SqlInjectionMatchSetSummary extends Object implements Serializable

    • Class com.amazonaws.services.waf.model.SqlInjectionMatchSetUpdate extends Object implements Serializable

      • Serialized Fields

        • action

          String action

          Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet.

        • sqlInjectionMatchTuple

          SqlInjectionMatchTuple sqlInjectionMatchTuple

          Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

    • Class com.amazonaws.services.waf.model.SqlInjectionMatchTuple extends Object implements Serializable

      • Serialized Fields

        • fieldToMatch

          FieldToMatch fieldToMatch
        • textTransformation

          String textTransformation

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

          CMD_LINE

          When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

          • Delete the following characters: \ " ' ^
          • Delete spaces before the following characters: / (
          • Replace the following characters with a space: , ;
          • Replace multiple spaces with one space
          • Convert uppercase letters (A-Z) to lowercase (a-z)

          COMPRESS_WHITE_SPACE

          Use this option to replace the following characters with a space character (decimal 32):

          • \f, formfeed, decimal 12
          • \t, tab, decimal 9
          • \n, newline, decimal 10
          • \r, carriage return, decimal 13
          • \v, vertical tab, decimal 11
          • non-breaking space, decimal 160

          COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

          HTML_ENTITY_DECODE

          Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

          • Replaces (ampersand)quot; with "
          • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
          • Replaces (ampersand)lt; with a "less than" symbol
          • Replaces (ampersand)gt; with >
          • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters
          • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

          LOWERCASE

          Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

          URL_DECODE

          Use this option to decode a URL-encoded value.

          NONE

          Specify NONE if you don't want to perform any text transformations.

    • Class com.amazonaws.services.waf.model.TimeWindow extends Object implements Serializable

      • Serialized Fields

        • endTime

          Date endTime

          The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You can specify any time range in the previous three hours.

        • startTime

          Date startTime

          The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You can specify any time range in the previous three hours.

    • Class com.amazonaws.services.waf.model.UpdateByteMatchSetRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.UpdateByteMatchSetResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the UpdateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    • Class com.amazonaws.services.waf.model.UpdateIPSetRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

    • Class com.amazonaws.services.waf.model.UpdateIPSetResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the UpdateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    • Class com.amazonaws.services.waf.model.UpdateRuleRequest extends AmazonWebServiceRequest implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The value returned by the most recent call to GetChangeToken.

        • ruleId

          String ruleId

          The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.

        • updates

          List<RuleUpdate> updates

          An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:

    • Class com.amazonaws.services.waf.model.UpdateRuleResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the UpdateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    • Class com.amazonaws.services.waf.model.UpdateSizeConstraintSetRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.UpdateSizeConstraintSetResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the UpdateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    • Class com.amazonaws.services.waf.model.UpdateSqlInjectionMatchSetRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.UpdateSqlInjectionMatchSetResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the UpdateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    • Class com.amazonaws.services.waf.model.UpdateWebACLRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.UpdateWebACLResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the UpdateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    • Class com.amazonaws.services.waf.model.UpdateXssMatchSetRequest extends AmazonWebServiceRequest implements Serializable

    • Class com.amazonaws.services.waf.model.UpdateXssMatchSetResult extends Object implements Serializable

      • Serialized Fields

        • changeToken

          String changeToken

          The ChangeToken that you used to submit the UpdateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    • Class com.amazonaws.services.waf.model.WafAction extends Object implements Serializable

      • Serialized Fields

        • type

          String type

          Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

          • ALLOW: AWS WAF allows requests
          • BLOCK: AWS WAF blocks requests
          • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.
    • Class com.amazonaws.services.waf.model.WAFDisallowedNameException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.waf.model.WAFInternalErrorException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.waf.model.WAFInvalidAccountException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.waf.model.WAFInvalidOperationException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.waf.model.WAFInvalidParameterException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.waf.model.WAFLimitsExceededException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.waf.model.WAFNonEmptyEntityException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.waf.model.WAFNonexistentContainerException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.waf.model.WAFNonexistentItemException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.waf.model.WAFReferencedItemException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.waf.model.WAFStaleDataException extends AmazonServiceException implements Serializable

      serialVersionUID:
      1L
    • Class com.amazonaws.services.waf.model.WebACL extends Object implements Serializable

      • Serialized Fields

        • defaultAction

          WafAction defaultAction

          The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

        • metricName

          String metricName
        • name

          String name

          A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

        • rules

          List<ActivatedRule> rules

          An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

        • webACLId

          String webACLId

          A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

          WebACLId is returned by CreateWebACL and by ListWebACLs.

    • Class com.amazonaws.services.waf.model.WebACLSummary extends Object implements Serializable

      • Serialized Fields

        • name

          String name

          A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

        • webACLId

          String webACLId

          A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

          WebACLId is returned by CreateWebACL and by ListWebACLs.

    • Class com.amazonaws.services.waf.model.WebACLUpdate extends Object implements Serializable

      • Serialized Fields

        • action

          String action

          Specifies whether to insert a Rule into or delete a Rule from a WebACL.

        • activatedRule

          ActivatedRule activatedRule
    • Class com.amazonaws.services.waf.model.XssMatchSet extends Object implements Serializable

      • Serialized Fields

        • name

          String name

          The name, if any, of the XssMatchSet.

        • xssMatchSetId

          String xssMatchSetId

          A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

          XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

        • xssMatchTuples

          List<XssMatchTuple> xssMatchTuples

          Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

    • Class com.amazonaws.services.waf.model.XssMatchSetSummary extends Object implements Serializable

    • Class com.amazonaws.services.waf.model.XssMatchSetUpdate extends Object implements Serializable

      • Serialized Fields

        • action

          String action

          Specify INSERT to add a XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove a XssMatchSetUpdate from an XssMatchSet.

        • xssMatchTuple

          XssMatchTuple xssMatchTuple

          Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

    • Class com.amazonaws.services.waf.model.XssMatchTuple extends Object implements Serializable

      • Serialized Fields

        • fieldToMatch

          FieldToMatch fieldToMatch
        • textTransformation

          String textTransformation

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

          CMD_LINE

          When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

          • Delete the following characters: \ " ' ^
          • Delete spaces before the following characters: / (
          • Replace the following characters with a space: , ;
          • Replace multiple spaces with one space
          • Convert uppercase letters (A-Z) to lowercase (a-z)

          COMPRESS_WHITE_SPACE

          Use this option to replace the following characters with a space character (decimal 32):

          • \f, formfeed, decimal 12
          • \t, tab, decimal 9
          • \n, newline, decimal 10
          • \r, carriage return, decimal 13
          • \v, vertical tab, decimal 11
          • non-breaking space, decimal 160

          COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

          HTML_ENTITY_DECODE

          Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

          • Replaces (ampersand)quot; with "
          • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
          • Replaces (ampersand)lt; with a "less than" symbol
          • Replaces (ampersand)gt; with >
          • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters
          • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

          LOWERCASE

          Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

          URL_DECODE

          Use this option to decode a URL-encoded value.

          NONE

          Specify NONE if you don't want to perform any text transformations.

  • Package com.amazonaws.services.workspaces.model

  • Package com.amazonaws.test.util

    • Class com.amazonaws.test.util.RandomTempFile extends File implements Serializable

      serialVersionUID:
      -8232143353692832238L
      • Serialized Fields

        • binaryData

          boolean binaryData
          Flag controlling whether binary or character data is used
  • Package com.amazonaws.util