codegen-resources.service-2.json Maven / Gradle / Ivy
Show all versions of mobile Show documentation
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-07-01",
"endpointPrefix":"mobile",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"AWS Mobile",
"serviceId":"Mobile",
"signatureVersion":"v4",
"signingName":"AWSMobileHubService",
"uid":"mobile-2017-07-01"
},
"operations":{
"CreateProject":{
"name":"CreateProject",
"http":{
"method":"POST",
"requestUri":"/projects"
},
"input":{"shape":"CreateProjectRequest"},
"output":{"shape":"CreateProjectResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"}
],
"documentation":" Creates an AWS Mobile Hub project.
"
},
"DeleteProject":{
"name":"DeleteProject",
"http":{
"method":"DELETE",
"requestUri":"/projects/{projectId}"
},
"input":{"shape":"DeleteProjectRequest"},
"output":{"shape":"DeleteProjectResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"NotFoundException"}
],
"documentation":" Delets a project in AWS Mobile Hub.
"
},
"DescribeBundle":{
"name":"DescribeBundle",
"http":{
"method":"GET",
"requestUri":"/bundles/{bundleId}"
},
"input":{"shape":"DescribeBundleRequest"},
"output":{"shape":"DescribeBundleResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"},
{"shape":"NotFoundException"}
],
"documentation":" Get the bundle details for the requested bundle id.
"
},
"DescribeProject":{
"name":"DescribeProject",
"http":{
"method":"GET",
"requestUri":"/project"
},
"input":{"shape":"DescribeProjectRequest"},
"output":{"shape":"DescribeProjectResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"},
{"shape":"NotFoundException"}
],
"documentation":" Gets details about a project in AWS Mobile Hub.
"
},
"ExportBundle":{
"name":"ExportBundle",
"http":{
"method":"POST",
"requestUri":"/bundles/{bundleId}"
},
"input":{"shape":"ExportBundleRequest"},
"output":{"shape":"ExportBundleResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"},
{"shape":"NotFoundException"}
],
"documentation":" Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources.
"
},
"ExportProject":{
"name":"ExportProject",
"http":{
"method":"POST",
"requestUri":"/exports/{projectId}"
},
"input":{"shape":"ExportProjectRequest"},
"output":{"shape":"ExportProjectResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"},
{"shape":"NotFoundException"}
],
"documentation":" Exports project configuration to a snapshot which can be downloaded and shared. Note that mobile app push credentials are encrypted in exported projects, so they can only be shared successfully within the same AWS account.
"
},
"ListBundles":{
"name":"ListBundles",
"http":{
"method":"GET",
"requestUri":"/bundles"
},
"input":{"shape":"ListBundlesRequest"},
"output":{"shape":"ListBundlesResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"}
],
"documentation":" List all available bundles.
"
},
"ListProjects":{
"name":"ListProjects",
"http":{
"method":"GET",
"requestUri":"/projects"
},
"input":{"shape":"ListProjectsRequest"},
"output":{"shape":"ListProjectsResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"}
],
"documentation":" Lists projects in AWS Mobile Hub.
"
},
"UpdateProject":{
"name":"UpdateProject",
"http":{
"method":"POST",
"requestUri":"/update"
},
"input":{"shape":"UpdateProjectRequest"},
"output":{"shape":"UpdateProjectResult"},
"errors":[
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"},
{"shape":"NotFoundException"},
{"shape":"AccountActionRequiredException"},
{"shape":"LimitExceededException"}
],
"documentation":" Update an existing project.
"
}
},
"shapes":{
"AccountActionRequiredException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":" Account Action is required in order to continue the request.
",
"error":{"httpStatusCode":403},
"exception":true
},
"AttributeKey":{
"type":"string",
"documentation":" Key part of key-value attribute pairs.
"
},
"AttributeValue":{
"type":"string",
"documentation":" Value part of key-value attribute pairs.
"
},
"Attributes":{
"type":"map",
"key":{"shape":"AttributeKey"},
"value":{"shape":"AttributeValue"},
"documentation":" Key-value attribute pairs.
"
},
"BadRequestException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":" The request cannot be processed because some parameter is not valid or the project state prevents the operation from being performed.
",
"error":{"httpStatusCode":400},
"exception":true
},
"Boolean":{"type":"boolean"},
"BundleDescription":{
"type":"string",
"documentation":" Description of the download bundle.
"
},
"BundleDetails":{
"type":"structure",
"members":{
"bundleId":{"shape":"BundleId"},
"title":{"shape":"BundleTitle"},
"version":{"shape":"BundleVersion"},
"description":{"shape":"BundleDescription"},
"iconUrl":{"shape":"IconUrl"},
"availablePlatforms":{"shape":"Platforms"}
},
"documentation":" The details of the bundle.
"
},
"BundleId":{
"type":"string",
"documentation":" Unique bundle identifier.
"
},
"BundleList":{
"type":"list",
"member":{"shape":"BundleDetails"},
"documentation":" A list of bundles.
"
},
"BundleTitle":{
"type":"string",
"documentation":" Title of the download bundle.
"
},
"BundleVersion":{
"type":"string",
"documentation":" Version of the download bundle.
"
},
"ConsoleUrl":{"type":"string"},
"Contents":{
"type":"blob",
"documentation":" Binary file data.
"
},
"CreateProjectRequest":{
"type":"structure",
"members":{
"name":{
"shape":"ProjectName",
"documentation":" Name of the project.
",
"location":"querystring",
"locationName":"name"
},
"region":{
"shape":"ProjectRegion",
"documentation":" Default region where project resources should be created.
",
"location":"querystring",
"locationName":"region"
},
"contents":{
"shape":"Contents",
"documentation":" ZIP or YAML file which contains configuration settings to be used when creating the project. This may be the contents of the file downloaded from the URL provided in an export project operation.
"
},
"snapshotId":{
"shape":"SnapshotId",
"documentation":" Unique identifier for an exported snapshot of project configuration. This snapshot identifier is included in the share URL when a project is exported.
",
"location":"querystring",
"locationName":"snapshotId"
}
},
"documentation":" Request structure used to request a project be created.
",
"payload":"contents"
},
"CreateProjectResult":{
"type":"structure",
"members":{
"details":{
"shape":"ProjectDetails",
"documentation":" Detailed information about the created AWS Mobile Hub project.
"
}
},
"documentation":" Result structure used in response to a request to create a project.
"
},
"Date":{"type":"timestamp"},
"DeleteProjectRequest":{
"type":"structure",
"required":["projectId"],
"members":{
"projectId":{
"shape":"ProjectId",
"documentation":" Unique project identifier.
",
"location":"uri",
"locationName":"projectId"
}
},
"documentation":" Request structure used to request a project be deleted.
"
},
"DeleteProjectResult":{
"type":"structure",
"members":{
"deletedResources":{
"shape":"Resources",
"documentation":" Resources which were deleted.
"
},
"orphanedResources":{
"shape":"Resources",
"documentation":" Resources which were not deleted, due to a risk of losing potentially important data or files.
"
}
},
"documentation":" Result structure used in response to request to delete a project.
"
},
"DescribeBundleRequest":{
"type":"structure",
"required":["bundleId"],
"members":{
"bundleId":{
"shape":"BundleId",
"documentation":" Unique bundle identifier.
",
"location":"uri",
"locationName":"bundleId"
}
},
"documentation":" Request structure to request the details of a specific bundle.
"
},
"DescribeBundleResult":{
"type":"structure",
"members":{
"details":{
"shape":"BundleDetails",
"documentation":" The details of the bundle.
"
}
},
"documentation":" Result structure contains the details of the bundle.
"
},
"DescribeProjectRequest":{
"type":"structure",
"required":["projectId"],
"members":{
"projectId":{
"shape":"ProjectId",
"documentation":" Unique project identifier.
",
"location":"querystring",
"locationName":"projectId"
},
"syncFromResources":{
"shape":"Boolean",
"documentation":" If set to true, causes AWS Mobile Hub to synchronize information from other services, e.g., update state of AWS CloudFormation stacks in the AWS Mobile Hub project.
",
"location":"querystring",
"locationName":"syncFromResources"
}
},
"documentation":" Request structure used to request details about a project.
"
},
"DescribeProjectResult":{
"type":"structure",
"members":{
"details":{"shape":"ProjectDetails"}
},
"documentation":" Result structure used for requests of project details.
"
},
"DownloadUrl":{
"type":"string",
"documentation":" The download Url.
"
},
"ErrorMessage":{
"type":"string",
"documentation":" The Exception Error Message.
"
},
"ExportBundleRequest":{
"type":"structure",
"required":["bundleId"],
"members":{
"bundleId":{
"shape":"BundleId",
"documentation":" Unique bundle identifier.
",
"location":"uri",
"locationName":"bundleId"
},
"projectId":{
"shape":"ProjectId",
"documentation":" Unique project identifier.
",
"location":"querystring",
"locationName":"projectId"
},
"platform":{
"shape":"Platform",
"documentation":" Developer desktop or target application platform.
",
"location":"querystring",
"locationName":"platform"
}
},
"documentation":" Request structure used to request generation of custom SDK and tool packages required to integrate mobile web or app clients with backed AWS resources.
"
},
"ExportBundleResult":{
"type":"structure",
"members":{
"downloadUrl":{
"shape":"DownloadUrl",
"documentation":" URL which contains the custom-generated SDK and tool packages used to integrate the client mobile app or web app with the AWS resources created by the AWS Mobile Hub project.
"
}
},
"documentation":" Result structure which contains link to download custom-generated SDK and tool packages used to integrate mobile web or app clients with backed AWS resources.
"
},
"ExportProjectRequest":{
"type":"structure",
"required":["projectId"],
"members":{
"projectId":{
"shape":"ProjectId",
"documentation":" Unique project identifier.
",
"location":"uri",
"locationName":"projectId"
}
},
"documentation":" Request structure used in requests to export project configuration details.
"
},
"ExportProjectResult":{
"type":"structure",
"members":{
"downloadUrl":{
"shape":"DownloadUrl",
"documentation":" URL which can be used to download the exported project configuation file(s).
"
},
"shareUrl":{
"shape":"ShareUrl",
"documentation":" URL which can be shared to allow other AWS users to create their own project in AWS Mobile Hub with the same configuration as the specified project. This URL pertains to a snapshot in time of the project configuration that is created when this API is called. If you want to share additional changes to your project configuration, then you will need to create and share a new snapshot by calling this method again.
"
},
"snapshotId":{
"shape":"SnapshotId",
"documentation":" Unique identifier for the exported snapshot of the project configuration. This snapshot identifier is included in the share URL.
"
}
},
"documentation":" Result structure used for requests to export project configuration details.
"
},
"Feature":{
"type":"string",
"documentation":" Identifies which feature in AWS Mobile Hub is associated with this AWS resource.
"
},
"IconUrl":{
"type":"string",
"documentation":" Icon for the download bundle.
"
},
"InternalFailureException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":" The service has encountered an unexpected error condition which prevents it from servicing the request.
",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true
},
"LimitExceededException":{
"type":"structure",
"members":{
"retryAfterSeconds":{
"shape":"ErrorMessage",
"location":"header",
"locationName":"Retry-After"
},
"message":{"shape":"ErrorMessage"}
},
"documentation":" There are too many AWS Mobile Hub projects in the account or the account has exceeded the maximum number of resources in some AWS service. You should create another sub-account using AWS Organizations or remove some resources and retry your request.
",
"error":{"httpStatusCode":429},
"exception":true
},
"ListBundlesRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"MaxResults",
"documentation":" Maximum number of records to list in a single response.
",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"NextToken",
"documentation":" Pagination token. Set to null to start listing bundles from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more bundles.
",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":" Request structure to request all available bundles.
"
},
"ListBundlesResult":{
"type":"structure",
"members":{
"bundleList":{
"shape":"BundleList",
"documentation":" A list of bundles.
"
},
"nextToken":{
"shape":"NextToken",
"documentation":" Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.
"
}
},
"documentation":" Result structure contains a list of all available bundles with details.
"
},
"ListProjectsRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"MaxResults",
"documentation":" Maximum number of records to list in a single response.
",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"NextToken",
"documentation":" Pagination token. Set to null to start listing projects from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more projects.
",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":" Request structure used to request projects list in AWS Mobile Hub.
"
},
"ListProjectsResult":{
"type":"structure",
"members":{
"projects":{"shape":"ProjectSummaries"},
"nextToken":{"shape":"NextToken"}
},
"documentation":" Result structure used for requests to list projects in AWS Mobile Hub.
"
},
"MaxResults":{
"type":"integer",
"documentation":" Maximum number of records to list in a single response.
"
},
"NextToken":{
"type":"string",
"documentation":" Pagination token. Set to null to start listing records from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more entries.
"
},
"NotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":" No entity can be found with the specified identifier.
",
"error":{"httpStatusCode":404},
"exception":true
},
"Platform":{
"type":"string",
"documentation":" Developer desktop or target mobile app or website platform.
",
"enum":[
"OSX",
"WINDOWS",
"LINUX",
"OBJC",
"SWIFT",
"ANDROID",
"JAVASCRIPT"
]
},
"Platforms":{
"type":"list",
"member":{"shape":"Platform"},
"documentation":" Developer desktop or mobile app or website platforms.
"
},
"ProjectDetails":{
"type":"structure",
"members":{
"name":{"shape":"ProjectName"},
"projectId":{"shape":"ProjectId"},
"region":{"shape":"ProjectRegion"},
"state":{"shape":"ProjectState"},
"createdDate":{
"shape":"Date",
"documentation":" Date the project was created.
"
},
"lastUpdatedDate":{
"shape":"Date",
"documentation":" Date of the last modification of the project.
"
},
"consoleUrl":{
"shape":"ConsoleUrl",
"documentation":" Website URL for this project in the AWS Mobile Hub console.
"
},
"resources":{"shape":"Resources"}
},
"documentation":" Detailed information about an AWS Mobile Hub project.
"
},
"ProjectId":{
"type":"string",
"documentation":" Unique project identifier.
"
},
"ProjectName":{
"type":"string",
"documentation":" Name of the project.
"
},
"ProjectRegion":{
"type":"string",
"documentation":" Default region to use for AWS resource creation in the AWS Mobile Hub project.
"
},
"ProjectState":{
"type":"string",
"documentation":" Synchronization state for a project.
",
"enum":[
"NORMAL",
"SYNCING",
"IMPORTING"
]
},
"ProjectSummaries":{
"type":"list",
"member":{"shape":"ProjectSummary"},
"documentation":" List of projects.
"
},
"ProjectSummary":{
"type":"structure",
"members":{
"name":{
"shape":"ProjectName",
"documentation":" Name of the project.
"
},
"projectId":{
"shape":"ProjectId",
"documentation":" Unique project identifier.
"
}
},
"documentation":" Summary information about an AWS Mobile Hub project.
"
},
"Resource":{
"type":"structure",
"members":{
"type":{"shape":"ResourceType"},
"name":{"shape":"ResourceName"},
"arn":{"shape":"ResourceArn"},
"feature":{"shape":"Feature"},
"attributes":{"shape":"Attributes"}
},
"documentation":" Information about an instance of an AWS resource associated with a project.
"
},
"ResourceArn":{
"type":"string",
"documentation":" AWS resource name which uniquely identifies the resource in AWS systems.
"
},
"ResourceName":{
"type":"string",
"documentation":" Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the bucket).
"
},
"ResourceType":{
"type":"string",
"documentation":" Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket).
"
},
"Resources":{
"type":"list",
"member":{"shape":"Resource"},
"documentation":" List of AWS resources associated with a project.
"
},
"ServiceUnavailableException":{
"type":"structure",
"members":{
"retryAfterSeconds":{
"shape":"ErrorMessage",
"location":"header",
"locationName":"Retry-After"
},
"message":{"shape":"ErrorMessage"}
},
"documentation":" The service is temporarily unavailable. The request should be retried after some time delay.
",
"error":{"httpStatusCode":503},
"exception":true,
"fault":true
},
"ShareUrl":{
"type":"string",
"documentation":" URL which can be shared to allow other AWS users to create their own project in AWS Mobile Hub with the same configuration as the specified project. This URL pertains to a snapshot in time of the project configuration that is created when this API is called. If you want to share additional changes to your project configuration, then you will need to create and share a new snapshot by calling this method again.
"
},
"SnapshotId":{
"type":"string",
"documentation":" Unique identifier for the exported snapshot of the project configuration. This snapshot identifier is included in the share URL.
"
},
"TooManyRequestsException":{
"type":"structure",
"members":{
"retryAfterSeconds":{
"shape":"ErrorMessage",
"location":"header",
"locationName":"Retry-After"
},
"message":{"shape":"ErrorMessage"}
},
"documentation":" Too many requests have been received for this AWS account in too short a time. The request should be retried after some time delay.
",
"error":{"httpStatusCode":429},
"exception":true
},
"UnauthorizedException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":" Credentials of the caller are insufficient to authorize the request.
",
"error":{"httpStatusCode":401},
"exception":true
},
"UpdateProjectRequest":{
"type":"structure",
"required":["projectId"],
"members":{
"contents":{
"shape":"Contents",
"documentation":" ZIP or YAML file which contains project configuration to be updated. This should be the contents of the file downloaded from the URL provided in an export project operation.
"
},
"projectId":{
"shape":"ProjectId",
"documentation":" Unique project identifier.
",
"location":"querystring",
"locationName":"projectId"
}
},
"documentation":" Request structure used for requests to update project configuration.
",
"payload":"contents"
},
"UpdateProjectResult":{
"type":"structure",
"members":{
"details":{
"shape":"ProjectDetails",
"documentation":" Detailed information about the updated AWS Mobile Hub project.
"
}
},
"documentation":" Result structure used for requests to updated project configuration.
"
}
},
"documentation":" AWS Mobile Service provides mobile app and website developers with capabilities required to configure AWS resources and bootstrap their developer desktop projects with the necessary SDKs, constants, tools and samples to make use of those resources.
"
}