mobile

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 26, 2018 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package mobile provides the client and types for making API requests to AWS Mobile.

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.

See https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01 for more information on this service.

See mobile package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/mobile/

Using the Client

To AWS Mobile with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Mobile client Mobile for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/mobile/#New

Index

Constants

View Source 
const (

	// ErrCodeAccountActionRequiredException for service response error code
	// "AccountActionRequiredException".
	//
	// Account Action is required in order to continue the request.
	ErrCodeAccountActionRequiredException = "AccountActionRequiredException"

	// ErrCodeBadRequestException for service response error code
	// "BadRequestException".
	//
	// The request cannot be processed because some parameter is not valid or the
	// project state prevents the operation from being performed.
	ErrCodeBadRequestException = "BadRequestException"

	// ErrCodeInternalFailureException for service response error code
	// "InternalFailureException".
	//
	// The service has encountered an unexpected error condition which prevents
	// it from servicing the request.
	ErrCodeInternalFailureException = "InternalFailureException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// 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.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeNotFoundException for service response error code
	// "NotFoundException".
	//
	// No entity can be found with the specified identifier.
	ErrCodeNotFoundException = "NotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The service is temporarily unavailable. The request should be retried after
	// some time delay.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"

	// ErrCodeTooManyRequestsException for service response error code
	// "TooManyRequestsException".
	//
	// Too many requests have been received for this AWS account in too short a
	// time. The request should be retried after some time delay.
	ErrCodeTooManyRequestsException = "TooManyRequestsException"

	// ErrCodeUnauthorizedException for service response error code
	// "UnauthorizedException".
	//
	// Credentials of the caller are insufficient to authorize the request.
	ErrCodeUnauthorizedException = "UnauthorizedException"
)
View Source 
const (
	ServiceName = "mobile"    // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type BundleDetails 

type BundleDetails struct {

	// Developer desktop or mobile app or website platforms.
	AvailablePlatforms []Platform `locationName:"availablePlatforms" type:"list"`

	// Unique bundle identifier.
	BundleId *string `locationName:"bundleId" type:"string"`

	// Description of the download bundle.
	Description *string `locationName:"description" type:"string"`

	// Icon for the download bundle.
	IconUrl *string `locationName:"iconUrl" type:"string"`

	// Title of the download bundle.
	Title *string `locationName:"title" type:"string"`

	// Version of the download bundle.
	Version *string `locationName:"version" type:"string"`
	// contains filtered or unexported fields
}

The details of the bundle. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/BundleDetails

func (BundleDetails) GoString 

func (s BundleDetails) GoString() string

GoString returns the string representation

func (BundleDetails) MarshalFields added in v0.3.0 

func (s BundleDetails) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (BundleDetails) String 

func (s BundleDetails) String() string

String returns the string representation

type CreateProjectInput 

type CreateProjectInput struct {

	// 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.
	Contents []byte `locationName:"contents" type:"blob"`

	// Name of the project.
	Name *string `location:"querystring" locationName:"name" type:"string"`

	// Default region where project resources should be created.
	Region *string `location:"querystring" locationName:"region" type:"string"`

	// Unique identifier for an exported snapshot of project configuration. This
	// snapshot identifier is included in the share URL when a project is exported.
	SnapshotId *string `location:"querystring" locationName:"snapshotId" type:"string"`
	// contains filtered or unexported fields
}

Request structure used to request a project be created. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/CreateProjectRequest

func (CreateProjectInput) GoString 

func (s CreateProjectInput) GoString() string

GoString returns the string representation

func (CreateProjectInput) MarshalFields added in v0.3.0 

func (s CreateProjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateProjectInput) String 

func (s CreateProjectInput) String() string

String returns the string representation

type CreateProjectOutput 

type CreateProjectOutput struct {

	// Detailed information about the created AWS Mobile Hub project.
	Details *ProjectDetails `locationName:"details" type:"structure"`
	// contains filtered or unexported fields
}

Result structure used in response to a request to create a project. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/CreateProjectResult

func (CreateProjectOutput) GoString 

func (s CreateProjectOutput) GoString() string

GoString returns the string representation

func (CreateProjectOutput) MarshalFields added in v0.3.0 

func (s CreateProjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (CreateProjectOutput) SDKResponseMetadata 

func (s CreateProjectOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateProjectOutput) String 

func (s CreateProjectOutput) String() string

String returns the string representation

type CreateProjectRequest 

type CreateProjectRequest struct {
	*aws.Request
	Input *CreateProjectInput
	Copy  func(*CreateProjectInput) CreateProjectRequest
}

CreateProjectRequest is a API request type for the CreateProject API operation.

func (CreateProjectRequest) Send 

func (r CreateProjectRequest) Send() (*CreateProjectOutput, error)

Send marshals and sends the CreateProject API request.

type DeleteProjectInput 

type DeleteProjectInput struct {

	// Unique project identifier.
	//
	// ProjectId is a required field
	ProjectId *string `location:"uri" locationName:"projectId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request structure used to request a project be deleted. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/DeleteProjectRequest

func (DeleteProjectInput) GoString 

func (s DeleteProjectInput) GoString() string

GoString returns the string representation

func (DeleteProjectInput) MarshalFields added in v0.3.0 

func (s DeleteProjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteProjectInput) String 

func (s DeleteProjectInput) String() string

String returns the string representation

func (*DeleteProjectInput) Validate 

func (s *DeleteProjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteProjectOutput 

type DeleteProjectOutput struct {

	// Resources which were deleted.
	DeletedResources []Resource `locationName:"deletedResources" type:"list"`

	// Resources which were not deleted, due to a risk of losing potentially important
	// data or files.
	OrphanedResources []Resource `locationName:"orphanedResources" type:"list"`
	// contains filtered or unexported fields
}

Result structure used in response to request to delete a project. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/DeleteProjectResult

func (DeleteProjectOutput) GoString 

func (s DeleteProjectOutput) GoString() string

GoString returns the string representation

func (DeleteProjectOutput) MarshalFields added in v0.3.0 

func (s DeleteProjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DeleteProjectOutput) SDKResponseMetadata 

func (s DeleteProjectOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteProjectOutput) String 

func (s DeleteProjectOutput) String() string

String returns the string representation

type DeleteProjectRequest 

type DeleteProjectRequest struct {
	*aws.Request
	Input *DeleteProjectInput
	Copy  func(*DeleteProjectInput) DeleteProjectRequest
}

DeleteProjectRequest is a API request type for the DeleteProject API operation.

func (DeleteProjectRequest) Send 

func (r DeleteProjectRequest) Send() (*DeleteProjectOutput, error)

Send marshals and sends the DeleteProject API request.

type DescribeBundleInput 

type DescribeBundleInput struct {

	// Unique bundle identifier.
	//
	// BundleId is a required field
	BundleId *string `location:"uri" locationName:"bundleId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request structure to request the details of a specific bundle. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/DescribeBundleRequest

func (DescribeBundleInput) GoString 

func (s DescribeBundleInput) GoString() string

GoString returns the string representation

func (DescribeBundleInput) MarshalFields added in v0.3.0 

func (s DescribeBundleInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeBundleInput) String 

func (s DescribeBundleInput) String() string

String returns the string representation

func (*DescribeBundleInput) Validate 

func (s *DescribeBundleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeBundleOutput 

type DescribeBundleOutput struct {

	// The details of the bundle.
	Details *BundleDetails `locationName:"details" type:"structure"`
	// contains filtered or unexported fields
}

Result structure contains the details of the bundle. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/DescribeBundleResult

func (DescribeBundleOutput) GoString 

func (s DescribeBundleOutput) GoString() string

GoString returns the string representation

func (DescribeBundleOutput) MarshalFields added in v0.3.0 

func (s DescribeBundleOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeBundleOutput) SDKResponseMetadata 

func (s DescribeBundleOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeBundleOutput) String 

func (s DescribeBundleOutput) String() string

String returns the string representation

type DescribeBundleRequest 

type DescribeBundleRequest struct {
	*aws.Request
	Input *DescribeBundleInput
	Copy  func(*DescribeBundleInput) DescribeBundleRequest
}

DescribeBundleRequest is a API request type for the DescribeBundle API operation.

func (DescribeBundleRequest) Send 

func (r DescribeBundleRequest) Send() (*DescribeBundleOutput, error)

Send marshals and sends the DescribeBundle API request.

type DescribeProjectInput 

type DescribeProjectInput struct {

	// Unique project identifier.
	//
	// ProjectId is a required field
	ProjectId *string `location:"querystring" locationName:"projectId" type:"string" required:"true"`

	// 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.
	SyncFromResources *bool `location:"querystring" locationName:"syncFromResources" type:"boolean"`
	// contains filtered or unexported fields
}

Request structure used to request details about a project. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/DescribeProjectRequest

func (DescribeProjectInput) GoString 

func (s DescribeProjectInput) GoString() string

GoString returns the string representation

func (DescribeProjectInput) MarshalFields added in v0.3.0 

func (s DescribeProjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeProjectInput) String 

func (s DescribeProjectInput) String() string

String returns the string representation

func (*DescribeProjectInput) Validate 

func (s *DescribeProjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeProjectOutput 

type DescribeProjectOutput struct {

	// Detailed information about an AWS Mobile Hub project.
	Details *ProjectDetails `locationName:"details" type:"structure"`
	// contains filtered or unexported fields
}

Result structure used for requests of project details. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/DescribeProjectResult

func (DescribeProjectOutput) GoString 

func (s DescribeProjectOutput) GoString() string

GoString returns the string representation

func (DescribeProjectOutput) MarshalFields added in v0.3.0 

func (s DescribeProjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (DescribeProjectOutput) SDKResponseMetadata 

func (s DescribeProjectOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeProjectOutput) String 

func (s DescribeProjectOutput) String() string

String returns the string representation

type DescribeProjectRequest 

type DescribeProjectRequest struct {
	*aws.Request
	Input *DescribeProjectInput
	Copy  func(*DescribeProjectInput) DescribeProjectRequest
}

DescribeProjectRequest is a API request type for the DescribeProject API operation.

func (DescribeProjectRequest) Send 

func (r DescribeProjectRequest) Send() (*DescribeProjectOutput, error)

Send marshals and sends the DescribeProject API request.

type ExportBundleInput 

type ExportBundleInput struct {

	// Unique bundle identifier.
	//
	// BundleId is a required field
	BundleId *string `location:"uri" locationName:"bundleId" type:"string" required:"true"`

	// Developer desktop or target application platform.
	Platform Platform `location:"querystring" locationName:"platform" type:"string" enum:"true"`

	// Unique project identifier.
	ProjectId *string `location:"querystring" locationName:"projectId" type:"string"`
	// contains filtered or unexported fields
}

Request structure used to request generation of custom SDK and tool packages required to integrate mobile web or app clients with backed AWS resources. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/ExportBundleRequest

func (ExportBundleInput) GoString 

func (s ExportBundleInput) GoString() string

GoString returns the string representation

func (ExportBundleInput) MarshalFields added in v0.3.0 

func (s ExportBundleInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ExportBundleInput) String 

func (s ExportBundleInput) String() string

String returns the string representation

func (*ExportBundleInput) Validate 

func (s *ExportBundleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExportBundleOutput 

type ExportBundleOutput struct {

	// 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.
	DownloadUrl *string `locationName:"downloadUrl" type:"string"`
	// contains filtered or unexported fields
}

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/ExportBundleResult

func (ExportBundleOutput) GoString 

func (s ExportBundleOutput) GoString() string

GoString returns the string representation

func (ExportBundleOutput) MarshalFields added in v0.3.0 

func (s ExportBundleOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ExportBundleOutput) SDKResponseMetadata 

func (s ExportBundleOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ExportBundleOutput) String 

func (s ExportBundleOutput) String() string

String returns the string representation

type ExportBundleRequest 

type ExportBundleRequest struct {
	*aws.Request
	Input *ExportBundleInput
	Copy  func(*ExportBundleInput) ExportBundleRequest
}

ExportBundleRequest is a API request type for the ExportBundle API operation.

func (ExportBundleRequest) Send 

func (r ExportBundleRequest) Send() (*ExportBundleOutput, error)

Send marshals and sends the ExportBundle API request.

type ExportProjectInput 

type ExportProjectInput struct {

	// Unique project identifier.
	//
	// ProjectId is a required field
	ProjectId *string `location:"uri" locationName:"projectId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request structure used in requests to export project configuration details. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/ExportProjectRequest

func (ExportProjectInput) GoString 

func (s ExportProjectInput) GoString() string

GoString returns the string representation

func (ExportProjectInput) MarshalFields added in v0.3.0 

func (s ExportProjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ExportProjectInput) String 

func (s ExportProjectInput) String() string

String returns the string representation

func (*ExportProjectInput) Validate 

func (s *ExportProjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExportProjectOutput 

type ExportProjectOutput struct {

	// URL which can be used to download the exported project configuation file(s).
	DownloadUrl *string `locationName:"downloadUrl" type:"string"`

	// 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.
	ShareUrl *string `locationName:"shareUrl" type:"string"`

	// Unique identifier for the exported snapshot of the project configuration.
	// This snapshot identifier is included in the share URL.
	SnapshotId *string `locationName:"snapshotId" type:"string"`
	// contains filtered or unexported fields
}

Result structure used for requests to export project configuration details. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/ExportProjectResult

func (ExportProjectOutput) GoString 

func (s ExportProjectOutput) GoString() string

GoString returns the string representation

func (ExportProjectOutput) MarshalFields added in v0.3.0 

func (s ExportProjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ExportProjectOutput) SDKResponseMetadata 

func (s ExportProjectOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ExportProjectOutput) String 

func (s ExportProjectOutput) String() string

String returns the string representation

type ExportProjectRequest 

type ExportProjectRequest struct {
	*aws.Request
	Input *ExportProjectInput
	Copy  func(*ExportProjectInput) ExportProjectRequest
}

ExportProjectRequest is a API request type for the ExportProject API operation.

func (ExportProjectRequest) Send 

func (r ExportProjectRequest) Send() (*ExportProjectOutput, error)

Send marshals and sends the ExportProject API request.

type ListBundlesInput 

type ListBundlesInput struct {

	// Maximum number of records to list in a single response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// 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.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Request structure to request all available bundles. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/ListBundlesRequest

func (ListBundlesInput) GoString 

func (s ListBundlesInput) GoString() string

GoString returns the string representation

func (ListBundlesInput) MarshalFields added in v0.3.0 

func (s ListBundlesInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListBundlesInput) String 

func (s ListBundlesInput) String() string

String returns the string representation

type ListBundlesOutput 

type ListBundlesOutput struct {

	// A list of bundles.
	BundleList []BundleDetails `locationName:"bundleList" type:"list"`

	// Pagination token. If non-null pagination token is returned in a result, then
	// pass its value in another request to fetch more entries.
	NextToken *string `locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Result structure contains a list of all available bundles with details. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/ListBundlesResult

func (ListBundlesOutput) GoString 

func (s ListBundlesOutput) GoString() string

GoString returns the string representation

func (ListBundlesOutput) MarshalFields added in v0.3.0 

func (s ListBundlesOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListBundlesOutput) SDKResponseMetadata 

func (s ListBundlesOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListBundlesOutput) String 

func (s ListBundlesOutput) String() string

String returns the string representation

type ListBundlesPager added in v0.3.0 

type ListBundlesPager struct {
	aws.Pager
}

ListBundlesPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*ListBundlesPager) CurrentPage added in v0.3.0 

func (p *ListBundlesPager) CurrentPage() *ListBundlesOutput

type ListBundlesRequest 

type ListBundlesRequest struct {
	*aws.Request
	Input *ListBundlesInput
	Copy  func(*ListBundlesInput) ListBundlesRequest
}

ListBundlesRequest is a API request type for the ListBundles API operation.

func (*ListBundlesRequest) Paginate added in v0.3.0 

func (p *ListBundlesRequest) Paginate(opts ...aws.Option) ListBundlesPager

Paginate pages iterates over the pages of a ListBundlesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service. 

   // Example iterating over at most 3 pages of a ListBundles operation.
		req := client.ListBundlesRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (ListBundlesRequest) Send 

func (r ListBundlesRequest) Send() (*ListBundlesOutput, error)

Send marshals and sends the ListBundles API request.

type ListProjectsInput 

type ListProjectsInput struct {

	// Maximum number of records to list in a single response.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`

	// 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.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

Request structure used to request projects list in AWS Mobile Hub. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/ListProjectsRequest

func (ListProjectsInput) GoString 

func (s ListProjectsInput) GoString() string

GoString returns the string representation

func (ListProjectsInput) MarshalFields added in v0.3.0 

func (s ListProjectsInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListProjectsInput) String 

func (s ListProjectsInput) String() string

String returns the string representation

type ListProjectsOutput 

type ListProjectsOutput struct {

	// 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.
	NextToken *string `locationName:"nextToken" type:"string"`

	// List of projects.
	Projects []ProjectSummary `locationName:"projects" type:"list"`
	// contains filtered or unexported fields
}

Result structure used for requests to list projects in AWS Mobile Hub. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/ListProjectsResult

func (ListProjectsOutput) GoString 

func (s ListProjectsOutput) GoString() string

GoString returns the string representation

func (ListProjectsOutput) MarshalFields added in v0.3.0 

func (s ListProjectsOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ListProjectsOutput) SDKResponseMetadata 

func (s ListProjectsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListProjectsOutput) String 

func (s ListProjectsOutput) String() string

String returns the string representation

type ListProjectsPager added in v0.3.0 

type ListProjectsPager struct {
	aws.Pager
}

ListProjectsPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*ListProjectsPager) CurrentPage added in v0.3.0 

func (p *ListProjectsPager) CurrentPage() *ListProjectsOutput

type ListProjectsRequest 

type ListProjectsRequest struct {
	*aws.Request
	Input *ListProjectsInput
	Copy  func(*ListProjectsInput) ListProjectsRequest
}

ListProjectsRequest is a API request type for the ListProjects API operation.

func (*ListProjectsRequest) Paginate added in v0.3.0 

func (p *ListProjectsRequest) Paginate(opts ...aws.Option) ListProjectsPager

Paginate pages iterates over the pages of a ListProjectsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service. 

   // Example iterating over at most 3 pages of a ListProjects operation.
		req := client.ListProjectsRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (ListProjectsRequest) Send 

func (r ListProjectsRequest) Send() (*ListProjectsOutput, error)

Send marshals and sends the ListProjects API request.

type Mobile 

type Mobile struct {
	*aws.Client
}

Mobile provides the API operation methods for making requests to AWS Mobile. See this package's package overview docs for details on the service.

Mobile methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Mobile

New creates a new instance of the Mobile client with a config.

Example: 

// Create a Mobile client from just a config.
svc := mobile.New(myConfig)

func (*Mobile) CreateProjectRequest 

func (c *Mobile) CreateProjectRequest(input *CreateProjectInput) CreateProjectRequest

CreateProjectRequest returns a request value for making API operation for AWS Mobile.

Creates an AWS Mobile Hub project. 

// Example sending a request using the CreateProjectRequest method.
req := client.CreateProjectRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/CreateProject

func (*Mobile) DeleteProjectRequest 

func (c *Mobile) DeleteProjectRequest(input *DeleteProjectInput) DeleteProjectRequest

DeleteProjectRequest returns a request value for making API operation for AWS Mobile.

Delets a project in AWS Mobile Hub. 

// Example sending a request using the DeleteProjectRequest method.
req := client.DeleteProjectRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/DeleteProject

func (*Mobile) DescribeBundleRequest 

func (c *Mobile) DescribeBundleRequest(input *DescribeBundleInput) DescribeBundleRequest

DescribeBundleRequest returns a request value for making API operation for AWS Mobile.

Get the bundle details for the requested bundle id. 

// Example sending a request using the DescribeBundleRequest method.
req := client.DescribeBundleRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/DescribeBundle

func (*Mobile) DescribeProjectRequest 

func (c *Mobile) DescribeProjectRequest(input *DescribeProjectInput) DescribeProjectRequest

DescribeProjectRequest returns a request value for making API operation for AWS Mobile.

Gets details about a project in AWS Mobile Hub. 

// Example sending a request using the DescribeProjectRequest method.
req := client.DescribeProjectRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/DescribeProject

func (*Mobile) ExportBundleRequest 

func (c *Mobile) ExportBundleRequest(input *ExportBundleInput) ExportBundleRequest

ExportBundleRequest returns a request value for making API operation for AWS Mobile.

Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources. 

// Example sending a request using the ExportBundleRequest method.
req := client.ExportBundleRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/ExportBundle

func (*Mobile) ExportProjectRequest 

func (c *Mobile) ExportProjectRequest(input *ExportProjectInput) ExportProjectRequest

ExportProjectRequest returns a request value for making API operation for AWS Mobile.

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. 

// Example sending a request using the ExportProjectRequest method.
req := client.ExportProjectRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/ExportProject

func (*Mobile) ListBundlesRequest 

func (c *Mobile) ListBundlesRequest(input *ListBundlesInput) ListBundlesRequest

ListBundlesRequest returns a request value for making API operation for AWS Mobile.

List all available bundles. 

// Example sending a request using the ListBundlesRequest method.
req := client.ListBundlesRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/ListBundles

func (*Mobile) ListProjectsRequest 

func (c *Mobile) ListProjectsRequest(input *ListProjectsInput) ListProjectsRequest

ListProjectsRequest returns a request value for making API operation for AWS Mobile.

Lists projects in AWS Mobile Hub. 

// Example sending a request using the ListProjectsRequest method.
req := client.ListProjectsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/ListProjects

func (*Mobile) UpdateProjectRequest 

func (c *Mobile) UpdateProjectRequest(input *UpdateProjectInput) UpdateProjectRequest

UpdateProjectRequest returns a request value for making API operation for AWS Mobile.

Update an existing project. 

// Example sending a request using the UpdateProjectRequest method.
req := client.UpdateProjectRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/UpdateProject

type Platform 

type Platform string

Developer desktop or target mobile app or website platform. 

const (
	PlatformOsx        Platform = "OSX"
	PlatformWindows    Platform = "WINDOWS"
	PlatformLinux      Platform = "LINUX"
	PlatformObjc       Platform = "OBJC"
	PlatformSwift      Platform = "SWIFT"
	PlatformAndroid    Platform = "ANDROID"
	PlatformJavascript Platform = "JAVASCRIPT"
)

Enum values for Platform

func (Platform) MarshalValue added in v0.3.0 

func (enum Platform) MarshalValue() (string, error)

func (Platform) MarshalValueBuf added in v0.3.0 

func (enum Platform) MarshalValueBuf(b []byte) ([]byte, error)

type ProjectDetails 

type ProjectDetails struct {

	// Website URL for this project in the AWS Mobile Hub console.
	ConsoleUrl *string `locationName:"consoleUrl" type:"string"`

	// Date the project was created.
	CreatedDate *time.Time `locationName:"createdDate" type:"timestamp" timestampFormat:"unix"`

	// Date of the last modification of the project.
	LastUpdatedDate *time.Time `locationName:"lastUpdatedDate" type:"timestamp" timestampFormat:"unix"`

	// Name of the project.
	Name *string `locationName:"name" type:"string"`

	// Unique project identifier.
	ProjectId *string `locationName:"projectId" type:"string"`

	// Default region to use for AWS resource creation in the AWS Mobile Hub project.
	Region *string `locationName:"region" type:"string"`

	// List of AWS resources associated with a project.
	Resources []Resource `locationName:"resources" type:"list"`

	// Synchronization state for a project.
	State ProjectState `locationName:"state" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Detailed information about an AWS Mobile Hub project. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/ProjectDetails

func (ProjectDetails) GoString 

func (s ProjectDetails) GoString() string

GoString returns the string representation

func (ProjectDetails) MarshalFields added in v0.3.0 

func (s ProjectDetails) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ProjectDetails) String 

func (s ProjectDetails) String() string

String returns the string representation

type ProjectState 

type ProjectState string

Synchronization state for a project. 

const (
	ProjectStateNormal    ProjectState = "NORMAL"
	ProjectStateSyncing   ProjectState = "SYNCING"
	ProjectStateImporting ProjectState = "IMPORTING"
)

Enum values for ProjectState

func (ProjectState) MarshalValue added in v0.3.0 

func (enum ProjectState) MarshalValue() (string, error)

func (ProjectState) MarshalValueBuf added in v0.3.0 

func (enum ProjectState) MarshalValueBuf(b []byte) ([]byte, error)

type ProjectSummary 

type ProjectSummary struct {

	// Name of the project.
	Name *string `locationName:"name" type:"string"`

	// Unique project identifier.
	ProjectId *string `locationName:"projectId" type:"string"`
	// contains filtered or unexported fields
}

Summary information about an AWS Mobile Hub project. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/ProjectSummary

func (ProjectSummary) GoString 

func (s ProjectSummary) GoString() string

GoString returns the string representation

func (ProjectSummary) MarshalFields added in v0.3.0 

func (s ProjectSummary) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (ProjectSummary) String 

func (s ProjectSummary) String() string

String returns the string representation

type Resource 

type Resource struct {

	// AWS resource name which uniquely identifies the resource in AWS systems.
	Arn *string `locationName:"arn" type:"string"`

	// Key-value attribute pairs.
	Attributes map[string]string `locationName:"attributes" type:"map"`

	// Identifies which feature in AWS Mobile Hub is associated with this AWS resource.
	Feature *string `locationName:"feature" type:"string"`

	// Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name
	// of the bucket).
	Name *string `locationName:"name" type:"string"`

	// Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket).
	Type *string `locationName:"type" type:"string"`
	// contains filtered or unexported fields
}

Information about an instance of an AWS resource associated with a project. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/Resource

func (Resource) GoString 

func (s Resource) GoString() string

GoString returns the string representation

func (Resource) MarshalFields added in v0.3.0 

func (s Resource) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (Resource) String 

func (s Resource) String() string

String returns the string representation

type UpdateProjectInput 

type UpdateProjectInput struct {

	// 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.
	Contents []byte `locationName:"contents" type:"blob"`

	// Unique project identifier.
	//
	// ProjectId is a required field
	ProjectId *string `location:"querystring" locationName:"projectId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Request structure used for requests to update project configuration. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/UpdateProjectRequest

func (UpdateProjectInput) GoString 

func (s UpdateProjectInput) GoString() string

GoString returns the string representation

func (UpdateProjectInput) MarshalFields added in v0.3.0 

func (s UpdateProjectInput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateProjectInput) String 

func (s UpdateProjectInput) String() string

String returns the string representation

func (*UpdateProjectInput) Validate 

func (s *UpdateProjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateProjectOutput 

type UpdateProjectOutput struct {

	// Detailed information about the updated AWS Mobile Hub project.
	Details *ProjectDetails `locationName:"details" type:"structure"`
	// contains filtered or unexported fields
}

Result structure used for requests to updated project configuration. Please also see https://docs.aws.amazon.com/goto/WebAPI/mobile-2017-07-01/UpdateProjectResult

func (UpdateProjectOutput) GoString 

func (s UpdateProjectOutput) GoString() string

GoString returns the string representation

func (UpdateProjectOutput) MarshalFields added in v0.3.0 

func (s UpdateProjectOutput) MarshalFields(e protocol.FieldEncoder) error

MarshalFields encodes the AWS API shape using the passed in protocol encoder.

func (UpdateProjectOutput) SDKResponseMetadata 

func (s UpdateProjectOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UpdateProjectOutput) String 

func (s UpdateProjectOutput) String() string

String returns the string representation

type UpdateProjectRequest 

type UpdateProjectRequest struct {
	*aws.Request
	Input *UpdateProjectInput
	Copy  func(*UpdateProjectInput) UpdateProjectRequest
}

UpdateProjectRequest is a API request type for the UpdateProject API operation.

func (UpdateProjectRequest) Send 

func (r UpdateProjectRequest) Send() (*UpdateProjectOutput, error)

Send marshals and sends the UpdateProject API request.

Source Files

View all Source files

Directories

Path Synopsis
Package mobileiface provides an interface to enable mocking the AWS Mobile service client for testing your code.
 Package mobileiface provides an interface to enable mocking the AWS Mobile service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.