Skip to content

ServerlessApplicationRepositoryClient#

Index > ServerlessApplicationRepository > ServerlessApplicationRepositoryClient

Auto-generated documentation for ServerlessApplicationRepository type annotations stubs module mypy-boto3-serverlessrepo.

ServerlessApplicationRepositoryClient#

Type annotations and code completion for boto3.client("serverlessrepo"). boto3 documentation

# ServerlessApplicationRepositoryClient usage example

from boto3.session import Session
from mypy_boto3_serverlessrepo.client import ServerlessApplicationRepositoryClient

def get_serverlessrepo_client() -> ServerlessApplicationRepositoryClient:
    return Session().client("serverlessrepo")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("serverlessrepo").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("serverlessrepo")

try:
    do_something(client)
except (
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.ForbiddenException,
    client.exceptions.InternalServerErrorException,
    client.exceptions.NotFoundException,
    client.exceptions.TooManyRequestsException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_serverlessrepo.client import Exceptions

def handle_error(exc: Exceptions.BadRequestException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("serverlessrepo").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("serverlessrepo").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_application#

Creates an application, optionally including an AWS SAM file to create the first application version in the same call.

Type annotations and code completion for boto3.client("serverlessrepo").create_application method. boto3 documentation

# create_application method definition

def create_application(
    self,
    *,
    Author: str,
    Description: str,
    Name: str,
    HomePageUrl: str = ...,
    Labels: Sequence[str] = ...,
    LicenseBody: str = ...,
    LicenseUrl: str = ...,
    ReadmeBody: str = ...,
    ReadmeUrl: str = ...,
    SemanticVersion: str = ...,
    SourceCodeArchiveUrl: str = ...,
    SourceCodeUrl: str = ...,
    SpdxLicenseId: str = ...,
    TemplateBody: str = ...,
    TemplateUrl: str = ...,
) -> CreateApplicationResponseTypeDef:  # (1)
    ...
  1. See CreateApplicationResponseTypeDef 
# create_application method usage example with argument unpacking

kwargs: CreateApplicationRequestRequestTypeDef = {  # (1)
    "Author": ...,
    "Description": ...,
    "Name": ...,
}

parent.create_application(**kwargs)
  1. See CreateApplicationRequestRequestTypeDef

create_application_version#

Creates an application version.

Type annotations and code completion for boto3.client("serverlessrepo").create_application_version method. boto3 documentation

# create_application_version method definition

def create_application_version(
    self,
    *,
    ApplicationId: str,
    SemanticVersion: str,
    SourceCodeArchiveUrl: str = ...,
    SourceCodeUrl: str = ...,
    TemplateBody: str = ...,
    TemplateUrl: str = ...,
) -> CreateApplicationVersionResponseTypeDef:  # (1)
    ...
  1. See CreateApplicationVersionResponseTypeDef 
# create_application_version method usage example with argument unpacking

kwargs: CreateApplicationVersionRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "SemanticVersion": ...,
}

parent.create_application_version(**kwargs)
  1. See CreateApplicationVersionRequestRequestTypeDef

create_cloud_formation_change_set#

Creates an AWS CloudFormation change set for the given application.

Type annotations and code completion for boto3.client("serverlessrepo").create_cloud_formation_change_set method. boto3 documentation

# create_cloud_formation_change_set method definition

def create_cloud_formation_change_set(
    self,
    *,
    ApplicationId: str,
    StackName: str,
    Capabilities: Sequence[str] = ...,
    ChangeSetName: str = ...,
    ClientToken: str = ...,
    Description: str = ...,
    NotificationArns: Sequence[str] = ...,
    ParameterOverrides: Sequence[ParameterValueTypeDef] = ...,  # (1)
    ResourceTypes: Sequence[str] = ...,
    RollbackConfiguration: RollbackConfigurationTypeDef = ...,  # (2)
    SemanticVersion: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    TemplateId: str = ...,
) -> CreateCloudFormationChangeSetResponseTypeDef:  # (4)
    ...
  1. See ParameterValueTypeDef
  2. See RollbackConfigurationTypeDef
  3. See TagTypeDef
  4. See CreateCloudFormationChangeSetResponseTypeDef 
# create_cloud_formation_change_set method usage example with argument unpacking

kwargs: CreateCloudFormationChangeSetRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "StackName": ...,
}

parent.create_cloud_formation_change_set(**kwargs)
  1. See CreateCloudFormationChangeSetRequestRequestTypeDef

create_cloud_formation_template#

Creates an AWS CloudFormation template.

Type annotations and code completion for boto3.client("serverlessrepo").create_cloud_formation_template method. boto3 documentation

# create_cloud_formation_template method definition

def create_cloud_formation_template(
    self,
    *,
    ApplicationId: str,
    SemanticVersion: str = ...,
) -> CreateCloudFormationTemplateResponseTypeDef:  # (1)
    ...
  1. See CreateCloudFormationTemplateResponseTypeDef 
# create_cloud_formation_template method usage example with argument unpacking

kwargs: CreateCloudFormationTemplateRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.create_cloud_formation_template(**kwargs)
  1. See CreateCloudFormationTemplateRequestRequestTypeDef

delete_application#

Deletes the specified application.

Type annotations and code completion for boto3.client("serverlessrepo").delete_application method. boto3 documentation

# delete_application method definition

def delete_application(
    self,
    *,
    ApplicationId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_application method usage example with argument unpacking

kwargs: DeleteApplicationRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.delete_application(**kwargs)
  1. See DeleteApplicationRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("serverlessrepo").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_application#

Gets the specified application.

Type annotations and code completion for boto3.client("serverlessrepo").get_application method. boto3 documentation

# get_application method definition

def get_application(
    self,
    *,
    ApplicationId: str,
    SemanticVersion: str = ...,
) -> GetApplicationResponseTypeDef:  # (1)
    ...
  1. See GetApplicationResponseTypeDef 
# get_application method usage example with argument unpacking

kwargs: GetApplicationRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_application(**kwargs)
  1. See GetApplicationRequestRequestTypeDef

get_application_policy#

Retrieves the policy for the application.

Type annotations and code completion for boto3.client("serverlessrepo").get_application_policy method. boto3 documentation

# get_application_policy method definition

def get_application_policy(
    self,
    *,
    ApplicationId: str,
) -> GetApplicationPolicyResponseTypeDef:  # (1)
    ...
  1. See GetApplicationPolicyResponseTypeDef 
# get_application_policy method usage example with argument unpacking

kwargs: GetApplicationPolicyRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.get_application_policy(**kwargs)
  1. See GetApplicationPolicyRequestRequestTypeDef

get_cloud_formation_template#

Gets the specified AWS CloudFormation template.

Type annotations and code completion for boto3.client("serverlessrepo").get_cloud_formation_template method. boto3 documentation

# get_cloud_formation_template method definition

def get_cloud_formation_template(
    self,
    *,
    ApplicationId: str,
    TemplateId: str,
) -> GetCloudFormationTemplateResponseTypeDef:  # (1)
    ...
  1. See GetCloudFormationTemplateResponseTypeDef 
# get_cloud_formation_template method usage example with argument unpacking

kwargs: GetCloudFormationTemplateRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "TemplateId": ...,
}

parent.get_cloud_formation_template(**kwargs)
  1. See GetCloudFormationTemplateRequestRequestTypeDef

list_application_dependencies#

Retrieves the list of applications nested in the containing application.

Type annotations and code completion for boto3.client("serverlessrepo").list_application_dependencies method. boto3 documentation

# list_application_dependencies method definition

def list_application_dependencies(
    self,
    *,
    ApplicationId: str,
    MaxItems: int = ...,
    NextToken: str = ...,
    SemanticVersion: str = ...,
) -> ListApplicationDependenciesResponseTypeDef:  # (1)
    ...
  1. See ListApplicationDependenciesResponseTypeDef 
# list_application_dependencies method usage example with argument unpacking

kwargs: ListApplicationDependenciesRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.list_application_dependencies(**kwargs)
  1. See ListApplicationDependenciesRequestRequestTypeDef

list_application_versions#

Lists versions for the specified application.

Type annotations and code completion for boto3.client("serverlessrepo").list_application_versions method. boto3 documentation

# list_application_versions method definition

def list_application_versions(
    self,
    *,
    ApplicationId: str,
    MaxItems: int = ...,
    NextToken: str = ...,
) -> ListApplicationVersionsResponseTypeDef:  # (1)
    ...
  1. See ListApplicationVersionsResponseTypeDef 
# list_application_versions method usage example with argument unpacking

kwargs: ListApplicationVersionsRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.list_application_versions(**kwargs)
  1. See ListApplicationVersionsRequestRequestTypeDef

list_applications#

Lists applications owned by the requester.

Type annotations and code completion for boto3.client("serverlessrepo").list_applications method. boto3 documentation

# list_applications method definition

def list_applications(
    self,
    *,
    MaxItems: int = ...,
    NextToken: str = ...,
) -> ListApplicationsResponseTypeDef:  # (1)
    ...
  1. See ListApplicationsResponseTypeDef 
# list_applications method usage example with argument unpacking

kwargs: ListApplicationsRequestRequestTypeDef = {  # (1)
    "MaxItems": ...,
}

parent.list_applications(**kwargs)
  1. See ListApplicationsRequestRequestTypeDef

put_application_policy#

Sets the permission policy for an application.

Type annotations and code completion for boto3.client("serverlessrepo").put_application_policy method. boto3 documentation

# put_application_policy method definition

def put_application_policy(
    self,
    *,
    ApplicationId: str,
    Statements: Sequence[ApplicationPolicyStatementUnionTypeDef],  # (1)
) -> PutApplicationPolicyResponseTypeDef:  # (2)
    ...
  1. See ApplicationPolicyStatementTypeDef ApplicationPolicyStatementOutputTypeDef
  2. See PutApplicationPolicyResponseTypeDef 
# put_application_policy method usage example with argument unpacking

kwargs: PutApplicationPolicyRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "Statements": ...,
}

parent.put_application_policy(**kwargs)
  1. See PutApplicationPolicyRequestRequestTypeDef

unshare_application#

Unshares an application from an AWS Organization.

Type annotations and code completion for boto3.client("serverlessrepo").unshare_application method. boto3 documentation

# unshare_application method definition

def unshare_application(
    self,
    *,
    ApplicationId: str,
    OrganizationId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# unshare_application method usage example with argument unpacking

kwargs: UnshareApplicationRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
    "OrganizationId": ...,
}

parent.unshare_application(**kwargs)
  1. See UnshareApplicationRequestRequestTypeDef

update_application#

Updates the specified application.

Type annotations and code completion for boto3.client("serverlessrepo").update_application method. boto3 documentation

# update_application method definition

def update_application(
    self,
    *,
    ApplicationId: str,
    Author: str = ...,
    Description: str = ...,
    HomePageUrl: str = ...,
    Labels: Sequence[str] = ...,
    ReadmeBody: str = ...,
    ReadmeUrl: str = ...,
) -> UpdateApplicationResponseTypeDef:  # (1)
    ...
  1. See UpdateApplicationResponseTypeDef 
# update_application method usage example with argument unpacking

kwargs: UpdateApplicationRequestRequestTypeDef = {  # (1)
    "ApplicationId": ...,
}

parent.update_application(**kwargs)
  1. See UpdateApplicationRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("serverlessrepo").get_paginator method with overloads.