Learn more  » Push, build, and install  RubyGems npm packages Python packages Maven artifacts PHP packages Go Modules Bower components Debian packages RPM packages NuGet packages

squarecapadmin / botocore   python

Repository URL to install this package:

/ botocore / data / opsworkscm / 2016-11-01 / service-2.json

{
  "version":"2.0",
  "metadata":{
    "apiVersion":"2016-11-01",
    "endpointPrefix":"opsworks-cm",
    "jsonVersion":"1.1",
    "protocol":"json",
    "serviceAbbreviation":"OpsWorksCM",
    "serviceFullName":"AWS OpsWorks for Chef Automate",
    "signatureVersion":"v4",
    "signingName":"opsworks-cm",
    "targetPrefix":"OpsWorksCM_V2016_11_01",
    "uid":"opsworkscm-2016-11-01"
  },
  "operations":{
    "AssociateNode":{
      "name":"AssociateNode",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"AssociateNodeRequest"},
      "output":{"shape":"AssociateNodeResponse"},
      "errors":[
        {"shape":"InvalidStateException"},
        {"shape":"ResourceNotFoundException"},
        {"shape":"ValidationException"}
      ]
    },
    "CreateBackup":{
      "name":"CreateBackup",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"CreateBackupRequest"},
      "output":{"shape":"CreateBackupResponse"},
      "errors":[
        {"shape":"InvalidStateException"},
        {"shape":"LimitExceededException"},
        {"shape":"ResourceNotFoundException"},
        {"shape":"ValidationException"}
      ],
      "documentation":"<p> Creates an application-level backup of a server. While the server is <code>BACKING_UP</code>, the server can not be modified and no additional backup can be created. </p> <p> Backups can be created for <code>RUNNING</code>, <code>HEALTHY</code> and <code>UNHEALTHY</code> servers. </p> <p> This operation is asnychronous. </p> <p> By default 50 manual backups can be created. </p> <p> A <code>LimitExceededException</code> is thrown then the maximum number of manual backup is reached. A <code>InvalidStateException</code> is thrown when the server is not in any of RUNNING, HEALTHY, UNHEALTHY. A <code>ResourceNotFoundException</code> is thrown when the server is not found. A <code>ValidationException</code> is thrown when parameters of the request are not valid. </p>"
    },
    "CreateServer":{
      "name":"CreateServer",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"CreateServerRequest"},
      "output":{"shape":"CreateServerResponse"},
      "errors":[
        {"shape":"LimitExceededException"},
        {"shape":"ResourceAlreadyExistsException"},
        {"shape":"ResourceNotFoundException"},
        {"shape":"ValidationException"}
      ],
      "documentation":"<p> Creates and immedately starts a new Server. The server can be used once it has reached the <code>HEALTHY</code> state. </p> <p> This operation is asnychronous. </p> <p> A <code>LimitExceededException</code> is thrown then the maximum number of server backup is reached. A <code>ResourceAlreadyExistsException</code> is raise when a server with the same name already exists in the account. A <code>ResourceNotFoundException</code> is thrown when a backupId is passed, but the backup does not exist. A <code>ValidationException</code> is thrown when parameters of the request are not valid. </p> <p> By default 10 servers can be created. A <code>LimitExceededException</code> is raised when the limit is exceeded. </p> <p> When no security groups are provided by using <code>SecurityGroupIds</code>, AWS OpsWorks creates a new security group. This security group opens the Chef server to the world on TCP port 443. If a KeyName is present, SSH access is enabled. SSH is also open to the world on TCP port 22. </p> <p>By default, the Chef Server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console. </p>"
    },
    "DeleteBackup":{
      "name":"DeleteBackup",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DeleteBackupRequest"},
      "output":{"shape":"DeleteBackupResponse"},
      "errors":[
        {"shape":"InvalidStateException"},
        {"shape":"ResourceNotFoundException"},
        {"shape":"ValidationException"}
      ],
      "documentation":"<p> Deletes a backup. You can delete both manual and automated backups. </p> <p> This operation is asynchronous. </p> <p> A <code>InvalidStateException</code> is thrown then a backup is already deleting. A <code>ResourceNotFoundException</code> is thrown when the backup does not exist. A <code>ValidationException</code> is thrown when parameters of the request are not valid. </p>"
    },
    "DeleteServer":{
      "name":"DeleteServer",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DeleteServerRequest"},
      "output":{"shape":"DeleteServerResponse"},
      "errors":[
        {"shape":"InvalidStateException"},
        {"shape":"ResourceNotFoundException"},
        {"shape":"ValidationException"}
      ],
      "documentation":"<p> Deletes the server and the underlying AWS CloudFormation stack (including the server's EC2 instance). The server status updated to <code>DELETING</code>. Once the server is successfully deleted, it will no longer be returned by <code>DescribeServer</code> requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted. </p> <p> This operation is asynchronous. </p> <p> A <code>InvalidStateException</code> is thrown then a server is already deleting. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are invalid. </p> <p> </p>"
    },
    "DescribeAccountAttributes":{
      "name":"DescribeAccountAttributes",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeAccountAttributesRequest"},
      "output":{"shape":"DescribeAccountAttributesResponse"},
      "documentation":"<p> Describes your account attributes, and creates requests to increase limits before they are reached or exceeded. </p> <p> This operation is synchronous. </p>"
    },
    "DescribeBackups":{
      "name":"DescribeBackups",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeBackupsRequest"},
      "output":{"shape":"DescribeBackupsResponse"},
      "errors":[
        {"shape":"ValidationException"},
        {"shape":"ResourceNotFoundException"},
        {"shape":"InvalidNextTokenException"}
      ],
      "documentation":"<p> Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups. </p> <p> This operation is synchronous. </p> <p> A <code>ResourceNotFoundException</code> is thrown when the backup does not exist. A <code>ValidationException</code> is raised when parameters of the request are invalid. </p>"
    },
    "DescribeEvents":{
      "name":"DescribeEvents",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeEventsRequest"},
      "output":{"shape":"DescribeEventsResponse"},
      "errors":[
        {"shape":"ValidationException"},
        {"shape":"InvalidNextTokenException"},
        {"shape":"ResourceNotFoundException"}
      ],
      "documentation":"<p> Describes events for a specified server. Results are ordered by time, with newest events first. </p> <p> This operation is synchronous. </p> <p> A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are invalid. </p>"
    },
    "DescribeNodeAssociationStatus":{
      "name":"DescribeNodeAssociationStatus",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeNodeAssociationStatusRequest"},
      "output":{"shape":"DescribeNodeAssociationStatusResponse"},
      "errors":[
        {"shape":"ResourceNotFoundException"},
        {"shape":"ValidationException"}
      ]
    },
    "DescribeServers":{
      "name":"DescribeServers",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DescribeServersRequest"},
      "output":{"shape":"DescribeServersResponse"},
      "errors":[
        {"shape":"ValidationException"},
        {"shape":"ResourceNotFoundException"},
        {"shape":"InvalidNextTokenException"}
      ],
      "documentation":"<p> Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks for Chef Automate does not query other services. </p> <p> This operation is synchronous. </p> <p> A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are invalid. </p>"
    },
    "DisassociateNode":{
      "name":"DisassociateNode",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DisassociateNodeRequest"},
      "output":{"shape":"DisassociateNodeResponse"},
      "errors":[
        {"shape":"InvalidStateException"},
        {"shape":"ResourceNotFoundException"},
        {"shape":"ValidationException"}
      ]
    },
    "RestoreServer":{
      "name":"RestoreServer",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"RestoreServerRequest"},
      "output":{"shape":"RestoreServerResponse"},
      "errors":[
        {"shape":"InvalidStateException"},
        {"shape":"ResourceNotFoundException"},
        {"shape":"ValidationException"}
      ],
      "documentation":"<p> Restores a backup to a server that is in a <code>RUNNING</code>, <code>FAILED</code>, or <code>HEALTHY</code> state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of all of the server's client devices should continue to work. </p> <p> This operation is asynchronous. </p> <p> A <code>InvalidStateException</code> is thrown when the server is not in a valid state. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are invalid. </p>"
    },
    "StartMaintenance":{
      "name":"StartMaintenance",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"StartMaintenanceRequest"},
      "output":{"shape":"StartMaintenanceResponse"},
      "errors":[
        {"shape":"InvalidStateException"},
        {"shape":"ResourceNotFoundException"},
        {"shape":"ValidationException"}
      ],
      "documentation":"<p> Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server will switch to <code>UNDER_MAINTENANCE</code> state, while maintenace is in progress. </p> <p> Maintenace can only be started for <code>HEALTHY</code> and <code>UNHEALTHY</code> servers. A <code>InvalidStateException</code> is thrown otherwise. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are invalid. </p>"
    },
    "UpdateServer":{
      "name":"UpdateServer",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"UpdateServerRequest"},
      "output":{"shape":"UpdateServerResponse"},
      "errors":[
        {"shape":"InvalidStateException"},
        {"shape":"ResourceNotFoundException"},
        {"shape":"ValidationException"}
      ],
      "documentation":"<p> Updates settings for a server. </p> <p> This operation is synchronous. </p>"
    },
    "UpdateServerEngineAttributes":{
      "name":"UpdateServerEngineAttributes",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"UpdateServerEngineAttributesRequest"},
      "output":{"shape":"UpdateServerEngineAttributesResponse"},
      "errors":[
        {"shape":"InvalidStateException"},
        {"shape":"ResourceNotFoundException"},
        {"shape":"ValidationException"}
      ],
      "documentation":"<p> Updates engine specific attributes on a specified server. Server will enter the <code>MODIFYING</code> state when this operation is in progress. Only one update can take place at a time. </p> <p> This operation can be use to reset Chef Server main API key (<code>CHEF_PIVOTAL_KEY</code>). </p> <p> This operation is asynchronous. </p> <p> </p> <p> This operation can only be called for <code>HEALTHY</code> and <code>UNHEALTHY</code> servers. Otherwise a <code>InvalidStateException</code> is raised. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are invalid. </p>"
    }
  },
  "shapes":{
    "AccountAttribute":{
      "type":"structure",
      "members":{
        "Name":{
          "shape":"String",
          "documentation":"<p> The attribute name. The following are supported attribute names. </p> <ul> <li> <p> <i>ServerLimit:</i> The number of servers that currently existing / maximal allowed. By default 10 servers can be created. </p> </li> <li> <p> <i>ManualBackupLimit:</i> The number of manual backups that currently exist / are maximal allowed. By default 50 manual backups can be created. </p> </li> </ul>"
        },
        "Maximum":{
          "shape":"Integer",
          "documentation":"<p> The maximum allowed value. </p>"
        },
        "Used":{
          "shape":"Integer",
          "documentation":"<p> The current usage, such as the current number of servers associated with the account. </p>"
        }
      },
      "documentation":"<p>Stores account attributes. </p>"
    },
    "AccountAttributes":{
      "type":"list",
      "member":{"shape":"AccountAttribute"},
      "documentation":"<p> A list of the individual attributes. </p>"
    },
    "AssociateNodeRequest":{
      "type":"structure",
      "required":[
        "ServerName",
        "NodeName"
      ],
      "members":{
        "ServerName":{"shape":"ServerName"},
        "NodeName":{"shape":"NodeName"},
        "EngineAttributes":{"shape":"EngineAttributes"}
      }
    },
    "AssociateNodeResponse":{
      "type":"structure",
      "members":{
        "NodeAssociationStatusToken":{"shape":"NodeAssociationStatusToken"}
      }
    },
    "AttributeName":{
      "type":"string",
      "max":64,
      "min":1,
      "pattern":"[A-Z][A-Z0-9_]*"
    },
    "AttributeValue":{"type":"string"},
    "Backup":{
      "type":"structure",
      "members":{
        "BackupArn":{
          "shape":"String",
          "documentation":"<p>The ARN of the backup. </p>"
        },
        "BackupId":{
          "shape":"BackupId",
          "documentation":"<p> The generated ID of the backup. Example: <code>myServerName-yyyyMMddHHmmssSSS</code> </p>"
        },
        "BackupType":{
          "shape":"BackupType",
          "documentation":"<p> The backup type. Valid values are <code>automated</code> or <code>manual</code>. </p>"
        },
        "CreatedAt":{
          "shape":"Timestamp",
          "documentation":"<p> The time stamp when the backup was created in the database. Example: <code>2016-07-29T13:38:47.520Z</code> </p>"
        },
        "Description":{
          "shape":"String",
          "documentation":"<p> A user-provided description for a manual backup. This field is empty for automated backups. </p>"
        },
        "Engine":{
          "shape":"String",
          "documentation":"<p> The engine type that is obtained from the server when the backup is created. </p>"
        },
        "EngineModel":{
          "shape":"String",
          "documentation":"<p> The engine model that is obtained from the server when the backup is created. </p>"
        },
        "EngineVersion":{
          "shape":"String",
          "documentation":"<p> The engine version that is obtained from the server when the backup is created. </p>"
        },
        "InstanceProfileArn":{
          "shape":"String",
          "documentation":"<p> The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup. </p>"
        },
        "InstanceType":{
          "shape":"String",
          "documentation":"<p> The instance type that is obtained from the server when the backup is created. </p>"
        },
        "KeyPair":{
          "shape":"String",
          "documentation":"<p> The key pair that is obtained from the server when the backup is created. </p>"
        },
        "PreferredBackupWindow":{
          "shape":"TimeWindowDefinition",
          "documentation":"<p> The preferred backup period that is obtained from the server when the backup is created. </p>"
        },
        "PreferredMaintenanceWindow":{
          "shape":"TimeWindowDefinition",
          "documentation":"<p> The preferred maintenance period that is obtained from the server when the backup is created. </p>"
        },
        "S3DataSize":{
          "shape":"Integer",
          "documentation":"<p> The size of the backup, in bytes. The size is returned by the instance in the command results. </p>"
        },
        "S3DataUrl":{
          "shape":"String",
          "documentation":"<p> The Amazon S3 URL of the backup's tar.gz file. </p>"
Loading ...