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 / codebuild / 2016-10-06 / service-2.json

{
  "version":"2.0",
  "metadata":{
    "apiVersion":"2016-10-06",
    "endpointPrefix":"codebuild",
    "jsonVersion":"1.1",
    "protocol":"json",
    "serviceFullName":"AWS CodeBuild",
    "signatureVersion":"v4",
    "targetPrefix":"CodeBuild_20161006",
    "uid":"codebuild-2016-10-06"
  },
  "operations":{
    "BatchGetBuilds":{
      "name":"BatchGetBuilds",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"BatchGetBuildsInput"},
      "output":{"shape":"BatchGetBuildsOutput"},
      "errors":[
        {"shape":"InvalidInputException"}
      ],
      "documentation":"<p>Gets information about one or more builds.</p>"
    },
    "BatchGetProjects":{
      "name":"BatchGetProjects",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"BatchGetProjectsInput"},
      "output":{"shape":"BatchGetProjectsOutput"},
      "errors":[
        {"shape":"InvalidInputException"}
      ],
      "documentation":"<p>Gets information about one or more build projects.</p>"
    },
    "CreateProject":{
      "name":"CreateProject",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"CreateProjectInput"},
      "output":{"shape":"CreateProjectOutput"},
      "errors":[
        {"shape":"InvalidInputException"},
        {"shape":"ResourceAlreadyExistsException"},
        {"shape":"AccountLimitExceededException"}
      ],
      "documentation":"<p>Creates a build project.</p>"
    },
    "DeleteProject":{
      "name":"DeleteProject",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"DeleteProjectInput"},
      "output":{"shape":"DeleteProjectOutput"},
      "errors":[
        {"shape":"InvalidInputException"}
      ],
      "documentation":"<p>Deletes a build project.</p>"
    },
    "ListBuilds":{
      "name":"ListBuilds",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"ListBuildsInput"},
      "output":{"shape":"ListBuildsOutput"},
      "errors":[
        {"shape":"InvalidInputException"}
      ],
      "documentation":"<p>Gets a list of build IDs, with each build ID representing a single build.</p>"
    },
    "ListBuildsForProject":{
      "name":"ListBuildsForProject",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"ListBuildsForProjectInput"},
      "output":{"shape":"ListBuildsForProjectOutput"},
      "errors":[
        {"shape":"InvalidInputException"},
        {"shape":"ResourceNotFoundException"}
      ],
      "documentation":"<p>Gets a list of build IDs for the specified build project, with each build ID representing a single build.</p>"
    },
    "ListCuratedEnvironmentImages":{
      "name":"ListCuratedEnvironmentImages",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"ListCuratedEnvironmentImagesInput"},
      "output":{"shape":"ListCuratedEnvironmentImagesOutput"},
      "documentation":"<p>Gets information about Docker images that are managed by AWS CodeBuild.</p>"
    },
    "ListProjects":{
      "name":"ListProjects",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"ListProjectsInput"},
      "output":{"shape":"ListProjectsOutput"},
      "errors":[
        {"shape":"InvalidInputException"}
      ],
      "documentation":"<p>Gets a list of build project names, with each build project name representing a single build project.</p>"
    },
    "StartBuild":{
      "name":"StartBuild",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"StartBuildInput"},
      "output":{"shape":"StartBuildOutput"},
      "errors":[
        {"shape":"InvalidInputException"},
        {"shape":"ResourceNotFoundException"},
        {"shape":"AccountLimitExceededException"}
      ],
      "documentation":"<p>Starts running a build.</p>"
    },
    "StopBuild":{
      "name":"StopBuild",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"StopBuildInput"},
      "output":{"shape":"StopBuildOutput"},
      "errors":[
        {"shape":"InvalidInputException"},
        {"shape":"ResourceNotFoundException"}
      ],
      "documentation":"<p>Attempts to stop running a build.</p> <note> <p>Completed builds cannot be stopped.</p> </note>"
    },
    "UpdateProject":{
      "name":"UpdateProject",
      "http":{
        "method":"POST",
        "requestUri":"/"
      },
      "input":{"shape":"UpdateProjectInput"},
      "output":{"shape":"UpdateProjectOutput"},
      "errors":[
        {"shape":"InvalidInputException"},
        {"shape":"ResourceNotFoundException"}
      ],
      "documentation":"<p>Changes the settings of an existing build project.</p>"
    }
  },
  "shapes":{
    "AccountLimitExceededException":{
      "type":"structure",
      "members":{
      },
      "documentation":"<p>An AWS service limit was exceeded for the calling AWS account.</p>",
      "exception":true
    },
    "ArtifactNamespace":{
      "type":"string",
      "enum":[
        "NONE",
        "BUILD_ID"
      ]
    },
    "ArtifactPackaging":{
      "type":"string",
      "enum":[
        "NONE",
        "ZIP"
      ]
    },
    "ArtifactsType":{
      "type":"string",
      "enum":[
        "CODEPIPELINE",
        "S3",
        "NO_ARTIFACTS"
      ]
    },
    "BatchGetBuildsInput":{
      "type":"structure",
      "required":["ids"],
      "members":{
        "ids":{
          "shape":"BuildIds",
          "documentation":"<p>The IDs of the builds to get information about.</p>"
        }
      }
    },
    "BatchGetBuildsOutput":{
      "type":"structure",
      "members":{
        "builds":{
          "shape":"Builds",
          "documentation":"<p>Information about the requested builds.</p>"
        },
        "buildsNotFound":{
          "shape":"BuildIds",
          "documentation":"<p>The IDs of builds for which information could not be found.</p>"
        }
      }
    },
    "BatchGetProjectsInput":{
      "type":"structure",
      "required":["names"],
      "members":{
        "names":{
          "shape":"ProjectNames",
          "documentation":"<p>The names of the build projects to get information about.</p>"
        }
      }
    },
    "BatchGetProjectsOutput":{
      "type":"structure",
      "members":{
        "projects":{
          "shape":"Projects",
          "documentation":"<p>Information about the requested build projects.</p>"
        },
        "projectsNotFound":{
          "shape":"ProjectNames",
          "documentation":"<p>The names of build projects for which information could not be found.</p>"
        }
      }
    },
    "Boolean":{"type":"boolean"},
    "Build":{
      "type":"structure",
      "members":{
        "id":{
          "shape":"NonEmptyString",
          "documentation":"<p>The build's unique ID.</p>"
        },
        "arn":{
          "shape":"NonEmptyString",
          "documentation":"<p>The build's Amazon Resource Name (ARN).</p>"
        },
        "startTime":{
          "shape":"Timestamp",
          "documentation":"<p>When the build process started, expressed in Unix time format.</p>"
        },
        "endTime":{
          "shape":"Timestamp",
          "documentation":"<p>When the build process ended, expressed in Unix time format.</p>"
        },
        "currentPhase":{
          "shape":"String",
          "documentation":"<p>The build's current build phase.</p>"
        },
        "buildStatus":{
          "shape":"StatusType",
          "documentation":"<p>The build's current status. Valid values include:</p> <ul> <li> <p> <code>FAILED</code>: The build failed.</p> </li> <li> <p> <code>FAULT</code>: The build faulted.</p> </li> <li> <p> <code>IN_PROGRESS</code>: The build is still in progress.</p> </li> <li> <p> <code>STOPPED</code>: The build stopped.</p> </li> <li> <p> <code>SUCCEEDED</code>: The build succeeded.</p> </li> <li> <p> <code>TIMED_OUT</code>: The build timed out.</p> </li> </ul>"
        },
        "sourceVersion":{
          "shape":"NonEmptyString",
          "documentation":"<p>Any version identifier for the version of the source code to be built.</p>"
        },
        "projectName":{
          "shape":"NonEmptyString",
          "documentation":"<p>The build project's name.</p>"
        },
        "phases":{
          "shape":"BuildPhases",
          "documentation":"<p>Information about all previous build phases that have completed, and information about any current build phase that has not yet completed.</p>"
        },
        "source":{
          "shape":"ProjectSource",
          "documentation":"<p>Information about the source code to be built.</p>"
        },
        "artifacts":{
          "shape":"BuildArtifacts",
          "documentation":"<p>Information about the build's output artifacts.</p>"
        },
        "environment":{
          "shape":"ProjectEnvironment",
          "documentation":"<p>Information about the build environment for this build.</p>"
        },
        "logs":{
          "shape":"LogsLocation",
          "documentation":"<p>Information about the build's logs in Amazon CloudWatch Logs.</p>"
        },
        "timeoutInMinutes":{
          "shape":"WrapperInt",
          "documentation":"<p>How long in minutes for AWS CodeBuild to wait to timeout this build if it does not get marked as completed.</p>"
        },
        "buildComplete":{
          "shape":"Boolean",
          "documentation":"<p>Whether the build has finished. Valid values include true if completed; otherwise, false.</p>"
        },
        "initiator":{
          "shape":"String",
          "documentation":"<p>The entity that started the build. Valid values include:</p> <ul> <li> <p>If AWS CodePipeline started the build, the pipeline's name, for example <code>codepipeline/my-demo-pipeline</code>.</p> </li> <li> <p>If an AWS Identity and Access Management (IAM) user started the build, the user's name, for example <code>MyUserName</code>.</p> </li> <li> <p>If the Jenkins plugin for AWS CodeBuild started the build, the string <code>CodeBuild-Jenkins-Plugin</code>.</p> </li> </ul>"
        }
      },
      "documentation":"<p>Information about a build.</p>"
    },
    "BuildArtifacts":{
      "type":"structure",
      "members":{
        "location":{
          "shape":"String",
          "documentation":"<p>Information about the build artifacts' location.</p>"
        },
        "sha256sum":{
          "shape":"String",
          "documentation":"<p>The SHA-256 hash of the build artifact.</p> <p>You can use this hash along with a checksum tool to confirm both file integrity and authenticity.</p> <note> <p>This value is available only if the related build project's <code>packaging</code> value is set to <code>ZIP</code>.</p> </note>"
        },
        "md5sum":{
          "shape":"String",
          "documentation":"<p>The MD5 hash of the build artifact.</p> <p>You can use this hash along with a checksum tool to confirm both file integrity and authenticity.</p> <note> <p>This value is available only if the related build project's <code>packaging</code> value is set to <code>ZIP</code>.</p> </note>"
        }
      },
      "documentation":"<p>Information about build output artifacts.</p>"
    },
    "BuildIds":{
      "type":"list",
      "member":{"shape":"NonEmptyString"},
      "max":100,
      "min":1
    },
    "BuildPhase":{
      "type":"structure",
      "members":{
        "phaseType":{
          "shape":"BuildPhaseType",
          "documentation":"<p>The build phase's name. Valid values include:</p> <ul> <li> <p> <code>BUILD</code>: Core build activities typically occur in this build phase.</p> </li> <li> <p> <code>COMPLETED</code>: The build has completed.</p> </li> <li> <p> <code>DOWNLOAD_SOURCE</code>: Source code is being downloaded in this build phase.</p> </li> <li> <p> <code>FINALIZING</code>: The build process is completing in this build phase.</p> </li> <li> <p> <code>INSTALL</code>: Installation activities typically occur in this build phase.</p> </li> <li> <p> <code>POST_BUILD</code>: Post-build activities typically occur in this build phase.</p> </li> <li> <p> <code>PRE_BUILD</code>: Pre-build activities typically occur in this build phase.</p> </li> <li> <p> <code>PROVISIONING</code>: The build environment is being set up.</p> </li> <li> <p> <code>SUBMITTED</code>: The build has been submitted.</p> </li> <li> <p> <code>UPLOAD_ARTIFACTS</code>: Build output artifacts are being uploaded to output location.</p> </li> </ul>"
        },
        "phaseStatus":{
          "shape":"StatusType",
          "documentation":"<p>The build phase's current status. Valid values include:</p> <ul> <li> <p> <code>FAILED</code>: The build phase failed.</p> </li> <li> <p> <code>FAULT</code>: The build phase faulted.</p> </li> <li> <p> <code>IN_PROGRESS</code>: The build phase is still in progress.</p> </li> <li> <p> <code>STOPPED</code>: The build phase stopped.</p> </li> <li> <p> <code>SUCCEEDED</code>: The build phase succeeded.</p> </li> <li> <p> <code>TIMED_OUT</code>: The build phase timed out.</p> </li> </ul>"
        },
        "startTime":{
          "shape":"Timestamp",
Loading ...